EOS API reference page for EOS_Presence_AddNotifyOnPresenceChanged

2 mins to read

This function is part of the Presence Interface.


Register to receive notifications when presence changes. If the returned NotificationId is valid, you must call RemoveNotifyOnPresenceChanged when you no longer wish to have your NotificationHandler called

Return Value

Notification ID representing the registered callback if successful, an invalid NotificationId if not

See Also

EOS_INVALID_NOTIFICATIONID, EOS_Presence_RemoveNotifyOnPresenceChanged



Parameter Type And NameUsage Information
EOS_HPresence Handle
const EOS_Presence_AddNotifyOnPresenceChangedOptions* Options
void* ClientDataData the is returned to when NotificationHandler is invoked
const EOS_Presence_OnPresenceChangedCallback NotificationHandlerThe callback to be fired when a presence change occurs

Callback Function Information

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

Callback Remarks

Callback for information related to notifications from EOS_Presence_AddNotifyOnPresenceChanged triggering.

Callback Parameters


Parameter Type And NameUsage Information
const EOS_Presence_PresenceChangedCallbackInfo* Data