EOS API reference page for EOS_CustomInvites_AddNotifyCustomInviteReceived

3 mins to read

This function is part of the CustomInvites Interface.


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



Parameter Type And NameUsage Information
EOS_HCustomInvites Handle
const EOS_CustomInvites_AddNotifyCustomInviteReceivedOptions* OptionsStructure containing information about the request.
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate.
const EOS_CustomInvites_OnCustomInviteReceivedCallback NotificationFnA 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


Parameter Type And NameUsage Information
const EOS_CustomInvites_OnCustomInviteReceivedCallbackInfo* DataA EOS_CustomInvites_OnCustomInviteReceivedCallbackInfo containing the output information and result

Callback Data

The EOS SDK passes the following data structure to the callback function:


void* ClientDataContext that was passed into EOS_CustomInvites_AddNotifyCustomInviteReceived
EOS_ProductUserId TargetUserIdUser that sent this custom invite
EOS_ProductUserId LocalUserIdRecipient Local user id
const char* CustomInviteIdId of the received Custom Invite
const char* PayloadPayload of the received Custom Invite

For more information, see the EOS_CustomInvites_OnCustomInviteReceivedCallbackInfo page.