EOS API reference page for EOS_Sessions_AddNotifySessionInviteReceived

2 mins to read

This function is part of the Sessions Interface.


Register to receive session invites.

must call RemoveNotifySessionInviteReceived to remove the notification

Return Value

handle representing the registered callback



Parameter Type And NameUsage Information
EOS_HSessions Handle
const EOS_Sessions_AddNotifySessionInviteReceivedOptions* OptionsStructure containing information about the session invite notification
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_Sessions_OnSessionInviteReceivedCallback NotificationFnA callback that is fired when a session invite for a user has been received

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Sessions_OnSessionInviteReceivedCallback to report the results of its operation.

Callback Remarks

Function prototype definition for notifications that come from EOS_Sessions_AddNotifySessionInviteReceived

Callback Parameters


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