This function is part of the CustomInvites Interface.
Remarks
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 EOS_CustomInvites_RemoveNotifyCustomInviteAccepted to remove the notification
Return Value
handle representing the registered callback
Parameters
EOS_CustomInvites_AddNotifyCustomInviteAccepted
| Parameter Type And Name | Usage Information |
|---|---|
| EOS_HCustomInvites Handle | |
| const EOS_CustomInvites_AddNotifyCustomInviteAcceptedOptions* Options | Structure containing information about the request. |
| void* ClientData | Arbitrary data that is passed back to you in the CompletionDelegate. |
| const EOS_CustomInvites_OnCustomInviteAcceptedCallback NotificationFn | A callback that is fired when a Custom Invite is accepted via the Social Overlay. |
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_CustomInvites_OnCustomInviteAcceptedCallback to report the results of its operation. See the EOS_CustomInvites_OnCustomInviteAcceptedCallbackInfo page for more details, or check the [Callback Data] section below.
Callback Remarks
Function prototype definition for notifications that comes from EOS_CustomInvites_AddNotifyCustomInviteAccepted
Callback Parameters
EOS_CustomInvites_OnCustomInviteAcceptedCallback
| Parameter Type And Name | Usage Information |
|---|---|
| const EOS_CustomInvites_OnCustomInviteAcceptedCallbackInfo* Data | A EOS_CustomInvites_OnCustomInviteAcceptedCallbackInfo containing the output information and result |
Callback Data
The EOS SDK passes the following data structure to the callback function:
EOS_CustomInvites_OnCustomInviteAcceptedCallbackInfo
| Property | Value |
|---|---|
| void* ClientData | Context that was passed into EOS_CustomInvites_AddNotifyCustomInviteAccepted |
| EOS_ProductUserId TargetUserId | User that sent the custom invite |
| EOS_ProductUserId LocalUserId | Recipient Local user id |
| const char* CustomInviteId | Id of the accepted Custom Invite |
| const char* Payload | Payload of the accepted Custom Invite |
For more information, see the EOS_CustomInvites_OnCustomInviteAcceptedCallbackInfo page.