Package 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:

  • Constructor Details

    • EOS_CustomInvites_Interface

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

    • EOS_CustomInvites_Interface

      public EOS_CustomInvites_Interface()

  • Method Details

    • 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
      Must call removeNotifyCustomInviteReceived(EOS_NotificationId) to remove the notification
      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)
      Must call removeNotifyCustomInviteAccepted(EOS_NotificationId) to remove the notification
      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.
      Must call removeNotifyCustomInviteRejected(EOS_NotificationId) to remove the notification
      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.
      Must call removeNotifyRequestToJoinResponseReceived(EOS_NotificationId) to remove the notification
      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
      Must call removeNotifyRequestToJoinReceived(EOS_NotificationId) to remove the notification
      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.
      Must call removeNotifySendCustomNativeInviteRequested(EOS_NotificationId) to remove the notification.
      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:

    • 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
      Must call removeNotifyRequestToJoinAccepted(EOS_NotificationId) to remove the notification
      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
      Must call removeNotifyRequestToJoinRejected(EOS_NotificationId) to remove the notification
      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