EOS API reference page for EOS_Sessions_AddNotifySessionInviteReceived

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 Name

Usage Information

EOS_HSessions Handle

const EOS_Sessions_AddNotifySessionInviteReceivedOptions* Options

Structure containing information about the session invite notification

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Sessions_OnSessionInviteReceivedCallback NotificationFn

A callback that is fired when a session invite for a user has been received

This function enables your callback (the NotificationFn parameter) to respond to events that happen on the back-end service. Remember to remove your callback function when it is no longer needed.

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 Name

Usage Information

const EOS_Sessions_SessionInviteReceivedCallbackInfo* Data

A EOS_Sessions_SessionInviteReceivedCallbackInfo containing the output information and result

Related API Members