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