EOS_Presence_AddNotifyOnPresenceChanged

EOS API reference page for EOS_Presence_AddNotifyOnPresenceChanged

Choose your implementation method:

C

C#

This function is part of the Presence Interface.

Remarks

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

Parameters

EOS_Presence_AddNotifyOnPresenceChanged

Parameter Type And Name

Usage Information

EOS_HPresence Handle

const EOS_Presence_AddNotifyOnPresenceChangedOptions* Options

void* ClientData

Data the is returned to when NotificationHandler is invoked

const EOS_Presence_OnPresenceChangedCallback NotificationHandler

The callback to be fired when a presence change occurs

This function enables your callback (the NotificationHandler 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_Presence_OnPresenceChangedCallback to report the results of its operation.

Callback Remarks

Callback for information related to notifications from EOS_Presence_AddNotifyOnPresenceChanged triggering.

Callback Parameters

EOS_Presence_OnPresenceChangedCallback

Parameter Type And Name

Usage Information

const EOS_Presence_PresenceChangedCallbackInfo* Data

Related API Members

This function is part of the Presence Interface.

Remarks

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

{Common.InvalidNotificationid}, {RemoveNotifyOnPresenceChanged}

Parameters

Presence.PresenceInterface.AddNotifyOnPresenceChanged

Parameter Type And Name

Usage Information

AddNotifyOnPresenceChangedOptions options

object clientData

Data the is returned to when NotificationHandler is invoked

OnPresenceChangedCallback notificationHandler

The callback to be fired when a presence change occurs

This function enables your callback (the NotificationHandler 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 Presence.OnPresenceChangedCallback to report the results of its operation.

Callback Remarks

Callback for information related to notifications from {PresenceInterface.AddNotifyOnPresenceChanged} triggering.

Callback Parameters

Presence.OnPresenceChangedCallback

Parameter Type And Name

Usage Information

PresenceChangedCallbackInfo data

Related API Members

Tags