host.anzo.eossdk.eos.sdk

Class EOS_CustomInvites_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_CustomInvites_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_CustomInvites_Interface
extends com.sun.jna.PointerType

The Custom Invites Interface is designed to allow developers to have custom game Invite and Join operations driven by the Notification Service and supported by the Overlay (if desired). All Custom Invites Interface calls take a handle of type EOS_HCustomInvites as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetCustomInvitesInterface function.

Since:

8/19/2023

See Also:

EOS_Platform_Interface.getCustomInvitesInterface()

Constructor Summary

Constructors

Constructor and Description
EOS_CustomInvites_Interface()
EOS_CustomInvites_Interface(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
void	acceptRequestToJoin(EOS_CustomInvites_AcceptRequestToJoinOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnAcceptRequestToJoinCallback completionDelegate) Accept a request to join from another user
EOS_NotificationId	addNotifyCustomInviteAccepted(EOS_CustomInvites_AddNotifyCustomInviteAcceptedOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnCustomInviteAcceptedCallback notificationFn) Register to receive notifications when a Custom Invite for any logged in local user is accepted via the Social Overlay Invites accepted in this way still need to have FinalizeInvite called on them after you have finished processing the invite accept (e.g. after joining the game) If the returned NotificationId is valid, you must call removeNotifyCustomInviteAccepted(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.
EOS_NotificationId	addNotifyCustomInviteReceived(EOS_CustomInvites_AddNotifyCustomInviteReceivedOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnCustomInviteReceivedCallback notificationFn) Register to receive notifications when a Custom Invite for any logged in local user is received If the returned NotificationId is valid, you must call removeNotifyCustomInviteReceived(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.
EOS_NotificationId	addNotifyCustomInviteRejected(EOS_CustomInvites_AddNotifyCustomInviteRejectedOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnCustomInviteRejectedCallback notificationFn) Register to receive notifications when a Custom Invite for any logged in local user is rejected via the Social Overlay Invites rejected in this way do not need to have FinalizeInvite called on them, it is called automatically internally by the SDK.
EOS_NotificationId	addNotifyRequestToJoinAccepted(EOS_CustomInvites_AddNotifyRequestToJoinAcceptedOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnRequestToJoinAcceptedCallback notificationFn) Register to receive notifications when a Request to Join for any logged in local user is accepted via the Social Overlay If the returned NotificationId is valid, you must call removeNotifyRequestToJoinAccepted(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.
EOS_NotificationId	addNotifyRequestToJoinReceived(EOS_CustomInvites_AddNotifyRequestToJoinReceivedOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnRequestToJoinReceivedCallback notificationFn) Register to receive notifications when a request to join is received for a local user If the returned NotificationId is valid, you must call removeNotifyRequestToJoinReceived(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.
EOS_NotificationId	addNotifyRequestToJoinRejected(EOS_CustomInvites_AddNotifyRequestToJoinRejectedOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnRequestToJoinRejectedCallback notificationFn) Register to receive notifications when a Request to Join for any logged in local user is rejected via the Social Overlay If the returned NotificationId is valid, you must call removeNotifyRequestToJoinRejected(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.
EOS_NotificationId	addNotifyRequestToJoinResponseReceived(EOS_CustomInvites_AddNotifyRequestToJoinResponseReceivedOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnRequestToJoinResponseReceivedCallback notificationFn) Register to receive notifications when a request to join is responded to by a target user.
EOS_NotificationId	addNotifySendCustomNativeInviteRequested(EOS_CustomInvites_AddNotifySendCustomNativeInviteRequestedOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnSendCustomNativeInviteRequestedCallback notificationFn) Register to receive notifications about a custom invite "INVITE" performed by a local user via the overlay.
EOS_EResult	finalizeInvite(EOS_CustomInvites_FinalizeInviteOptions options) Signal that the title has completed processing a received Custom Invite, and that it should be cleaned up internally and in the Overlay
void	rejectRequestToJoin(EOS_CustomInvites_RejectRequestToJoinOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnRejectRequestToJoinCallback completionDelegate) Reject a request to join from another user
void	removeNotifyCustomInviteAccepted(EOS_NotificationId inId) Unregister from receiving notifications when a Custom Invite for any logged in local user is accepted via the Social Overlay
void	removeNotifyCustomInviteReceived(EOS_NotificationId inId) Unregister from receiving notifications when a Custom Invite for any logged in local user is received
void	removeNotifyCustomInviteRejected(EOS_NotificationId inId) Unregister from receiving notifications when a Custom Invite for any logged in local user is rejected via the Social Overlay
void	removeNotifyRequestToJoinAccepted(EOS_NotificationId inId) Unregister from receiving notifications when a Request to Join for any logged in local user is accepted via the Social Overlay
void	removeNotifyRequestToJoinReceived(EOS_NotificationId inId) Unregister from receiving notifications when a request to join for any logged in local user is received
void	removeNotifyRequestToJoinRejected(EOS_NotificationId inId) Unregister from receiving notifications when a Request to Join for any logged in local user is rejected via the Social Overlay
void	removeNotifyRequestToJoinResponseReceived(EOS_NotificationId inId) Unregister from receiving notifications when a request to join for any logged in local user is received
void	removeNotifySendCustomNativeInviteRequested(EOS_NotificationId inId) Unregister from receiving notifications when a user requests a send invite via the overlay.
void	sendCustomInvite(EOS_CustomInvites_SendCustomInviteOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnSendCustomInviteCallback completionDelegate) Sends a Custom Invite that has previously been initialized via SetCustomInvite to a group of users.
void	sendRequestToJoin(EOS_CustomInvites_SendRequestToJoinOptions options, com.sun.jna.Pointer clientData, EOS_CustomInvites_OnSendRequestToJoinCallback completionDelegate) Request that another user send an invitation.
EOS_EResult	setCustomInvite(EOS_CustomInvites_SetCustomInviteOptions options) Initializes a Custom Invite with a specified payload in preparation for it to be sent to another user or users.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_CustomInvites_Interface

public EOS_CustomInvites_Interface(com.sun.jna.Pointer address)

EOS_CustomInvites_Interface

public EOS_CustomInvites_Interface()

Method Detail

setCustomInvite

public EOS_EResult setCustomInvite(EOS_CustomInvites_SetCustomInviteOptions options)

Initializes a Custom Invite with a specified payload in preparation for it to be sent to another user or users.

Parameters:

options - Structure containing information about the request.

Returns:

EOS_EResult.EOS_Success if the operation completes successfully
EOS_EResult.EOS_InvalidParameters if any of the options values are incorrect

sendCustomInvite

public void sendCustomInvite(EOS_CustomInvites_SendCustomInviteOptions options,
                             com.sun.jna.Pointer clientData,
                             EOS_CustomInvites_OnSendCustomInviteCallback completionDelegate)

Sends a Custom Invite that has previously been initialized via SetCustomInvite to a group of users.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error

addNotifyCustomInviteReceived

public EOS_NotificationId addNotifyCustomInviteReceived(EOS_CustomInvites_AddNotifyCustomInviteReceivedOptions options,
                                                        com.sun.jna.Pointer clientData,
                                                        EOS_CustomInvites_OnCustomInviteReceivedCallback notificationFn)

Register to receive notifications when a Custom Invite for any logged in local user is received
If the returned NotificationId is valid, you must call removeNotifyCustomInviteReceived(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a Custom Invite is received.

Returns:

handle representing the registered callback

removeNotifyCustomInviteReceived

public void removeNotifyCustomInviteReceived(EOS_NotificationId inId)

Unregister from receiving notifications when a Custom Invite for any logged in local user is received

Parameters:

inId - Handle representing the registered callback

addNotifyCustomInviteAccepted

public EOS_NotificationId addNotifyCustomInviteAccepted(EOS_CustomInvites_AddNotifyCustomInviteAcceptedOptions options,
                                                        com.sun.jna.Pointer clientData,
                                                        EOS_CustomInvites_OnCustomInviteAcceptedCallback notificationFn)

Register to receive notifications when a Custom Invite for any logged in local user is accepted via the Social Overlay Invites accepted in this way still need to have FinalizeInvite called on them after you have finished processing the invite accept (e.g. after joining the game)
If the returned NotificationId is valid, you must call removeNotifyCustomInviteAccepted(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a Custom Invite is accepted via the Social Overlay.

Returns:

handle representing the registered callback

removeNotifyCustomInviteAccepted

public void removeNotifyCustomInviteAccepted(EOS_NotificationId inId)

Unregister from receiving notifications when a Custom Invite for any logged in local user is accepted via the Social Overlay

Parameters:

inId - Handle representing the registered callback

addNotifyCustomInviteRejected

public EOS_NotificationId addNotifyCustomInviteRejected(EOS_CustomInvites_AddNotifyCustomInviteRejectedOptions options,
                                                        com.sun.jna.Pointer clientData,
                                                        EOS_CustomInvites_OnCustomInviteRejectedCallback notificationFn)

Register to receive notifications when a Custom Invite for any logged in local user is rejected via the Social Overlay Invites rejected in this way do not need to have FinalizeInvite called on them, it is called automatically internally by the SDK.
If the returned NotificationId is valid, you must call removeNotifyCustomInviteRejected(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a Custom Invite is rejected via the Social Overlay.

Returns:

handle representing the registered callback

removeNotifyCustomInviteRejected

public void removeNotifyCustomInviteRejected(EOS_NotificationId inId)

Unregister from receiving notifications when a Custom Invite for any logged in local user is rejected via the Social Overlay

Parameters:

inId - Handle representing the registered callback

finalizeInvite

public EOS_EResult finalizeInvite(EOS_CustomInvites_FinalizeInviteOptions options)

Signal that the title has completed processing a received Custom Invite, and that it should be cleaned up internally and in the Overlay

Parameters:

options - Structure containing information about the request.

Returns:

EOS_EResult.EOS_Success if the operation completes successfully
EOS_EResult.EOS_InvalidParameters if any of the option values are incorrect

sendRequestToJoin

public void sendRequestToJoin(EOS_CustomInvites_SendRequestToJoinOptions options,
                              com.sun.jna.Pointer clientData,
                              EOS_CustomInvites_OnSendRequestToJoinCallback completionDelegate)

Request that another user send an invitation.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error

addNotifyRequestToJoinResponseReceived

public EOS_NotificationId addNotifyRequestToJoinResponseReceived(EOS_CustomInvites_AddNotifyRequestToJoinResponseReceivedOptions options,
                                                                 com.sun.jna.Pointer clientData,
                                                                 EOS_CustomInvites_OnRequestToJoinResponseReceivedCallback notificationFn)

Register to receive notifications when a request to join is responded to by a target user. Note that there is no guarantee a response will be received for every request to join. A player is free to ignore a Request to Join until it expires at which point it will be deleted without sending a response.
If the returned NotificationId is valid, you must call removeNotifyRequestToJoinResponseReceived(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a response is received for an invite request.

Returns:

handle representing the registered callback

removeNotifyRequestToJoinResponseReceived

public void removeNotifyRequestToJoinResponseReceived(EOS_NotificationId inId)

Unregister from receiving notifications when a request to join for any logged in local user is received

Parameters:

inId - Handle representing the registered callback

addNotifyRequestToJoinReceived

public EOS_NotificationId addNotifyRequestToJoinReceived(EOS_CustomInvites_AddNotifyRequestToJoinReceivedOptions options,
                                                         com.sun.jna.Pointer clientData,
                                                         EOS_CustomInvites_OnRequestToJoinReceivedCallback notificationFn)

Register to receive notifications when a request to join is received for a local user
If the returned NotificationId is valid, you must call removeNotifyRequestToJoinReceived(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a response is received for an invite request.

Returns:

handle representing the registered callback

removeNotifyRequestToJoinReceived

public void removeNotifyRequestToJoinReceived(EOS_NotificationId inId)

Unregister from receiving notifications when a request to join for any logged in local user is received

Parameters:

inId - Handle representing the registered callback

addNotifySendCustomNativeInviteRequested

public EOS_NotificationId addNotifySendCustomNativeInviteRequested(EOS_CustomInvites_AddNotifySendCustomNativeInviteRequestedOptions options,
                                                                   com.sun.jna.Pointer clientData,
                                                                   EOS_CustomInvites_OnSendCustomNativeInviteRequestedCallback notificationFn)

Register to receive notifications about a custom invite "INVITE" performed by a local user via the overlay. This is only needed when a configured integrated platform has EOS_IPMF_DisableSDKManagedSessions set. The EOS SDK will then use the state of EOS_IPMF_PreferEOSIdentity and EOS_IPMF_PreferIntegratedIdentity to determine when the notificationFn is called.
If the returned NotificationId is valid, you must call removeNotifySendCustomNativeInviteRequested(EOS_NotificationId) when you no longer wish to have your NotificationHandler called

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a notification is received.

Returns:

handle representing the registered callback

See Also:

EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_DisableSDKManagedSessions, EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_PreferEOSIdentity, EOS_EIntegratedPlatformManagementFlags.EOS_IPMF_PreferIntegratedIdentity

removeNotifySendCustomNativeInviteRequested

public void removeNotifySendCustomNativeInviteRequested(EOS_NotificationId inId)

Unregister from receiving notifications when a user requests a send invite via the overlay.

Parameters:

inId - Handle representing the registered callback

addNotifyRequestToJoinAccepted

public EOS_NotificationId addNotifyRequestToJoinAccepted(EOS_CustomInvites_AddNotifyRequestToJoinAcceptedOptions options,
                                                         com.sun.jna.Pointer clientData,
                                                         EOS_CustomInvites_OnRequestToJoinAcceptedCallback notificationFn)

Register to receive notifications when a Request to Join for any logged in local user is accepted via the Social Overlay
If the returned NotificationId is valid, you must call removeNotifyRequestToJoinAccepted(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a Request to Join is accepted via the Social Overlay.

Returns:

handle representing the registered callback

removeNotifyRequestToJoinAccepted

public void removeNotifyRequestToJoinAccepted(EOS_NotificationId inId)

Unregister from receiving notifications when a Request to Join for any logged in local user is accepted via the Social Overlay

Parameters:

inId - Handle representing the registered callback

addNotifyRequestToJoinRejected

public EOS_NotificationId addNotifyRequestToJoinRejected(EOS_CustomInvites_AddNotifyRequestToJoinRejectedOptions options,
                                                         com.sun.jna.Pointer clientData,
                                                         EOS_CustomInvites_OnRequestToJoinRejectedCallback notificationFn)

Register to receive notifications when a Request to Join for any logged in local user is rejected via the Social Overlay
If the returned NotificationId is valid, you must call removeNotifyRequestToJoinRejected(EOS_NotificationId) when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate.

notificationFn - A callback that is fired when a Request to Join is accepted via the Social Overlay.

Returns:

handle representing the registered callback

removeNotifyRequestToJoinRejected

public void removeNotifyRequestToJoinRejected(EOS_NotificationId inId)

Unregister from receiving notifications when a Request to Join for any logged in local user is rejected via the Social Overlay

Parameters:

inId - Handle representing the registered callback

acceptRequestToJoin

public void acceptRequestToJoin(EOS_CustomInvites_AcceptRequestToJoinOptions options,
                                com.sun.jna.Pointer clientData,
                                EOS_CustomInvites_OnAcceptRequestToJoinCallback completionDelegate)

Accept a request to join from another user

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error

rejectRequestToJoin

public void rejectRequestToJoin(EOS_CustomInvites_RejectRequestToJoinOptions options,
                                com.sun.jna.Pointer clientData,
                                EOS_CustomInvites_OnRejectRequestToJoinCallback completionDelegate)

Reject a request to join from another user

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - A callback that is fired when the operation completes, either successfully or in error