EOS_RTC_AddNotifyDisconnected

EOS API reference page for EOS_RTC_AddNotifyDisconnected

Choose your implementation method:

C

C#

This function is part of the RTC Interface.

Remarks

Register to receive notifications when disconnected from the room. If the returned NotificationId is valid, you must call EOS_RTC_RemoveNotifyDisconnected when you no longer wish to have your CompletionDelegate called. This function will always return EOS_INVALID_NOTIFICATIONID when used with lobby RTC room. To be notified of the connection status of a Lobby-managed RTC room, use the EOS_Lobby_AddNotifyRTCRoomConnectionChanged function instead.

Return Value

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

See Also

EOS_INVALID_NOTIFICATIONID, EOS_RTC_RemoveNotifyDisconnected

Parameters

EOS_RTC_AddNotifyDisconnected

Parameter Type And Name

Usage Information

EOS_HRTC Handle

EOS_RTC_AddNotifyDisconnectedOptions* Options

void* ClientData

Arbitrary data that is passed back in the CompletionDelegate

const EOS_RTC_OnDisconnectedCallback CompletionDelegate

The callback to be fired when a presence change occurs

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

Callback Parameters

EOS_RTC_OnDisconnectedCallback

Parameter Type And Name

Usage Information

const EOS_RTC_DisconnectedCallbackInfo* Data

This struct is passed in with a call to EOS_RTC_AddNotifyDisconnected registered event.

Related API Members

This function is part of the RTC Interface.

Remarks

Register to receive notifications when disconnected from the room. If the returned NotificationId is valid, you must call {RemoveNotifyDisconnected} when you no longer wish to have your CompletionDelegate called. This function will always return {Common.InvalidNotificationid} when used with lobby RTC room. To be notified of the connection status of a Lobby-managed RTC room, use the {Lobby.LobbyInterface.AddNotifyRTCRoomConnectionChanged} function instead.

Return Value

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

See Also

{Common.InvalidNotificationid}, {RemoveNotifyDisconnected}

Parameters

RTC.RTCInterface.AddNotifyDisconnected

Parameter Type And Name

Usage Information

AddNotifyDisconnectedOptions options

object clientData

Arbitrary data that is passed back in the CompletionDelegate

OnDisconnectedCallback completionDelegate

The callback to be fired when a presence change occurs

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

Callback Parameters

RTC.OnDisconnectedCallback

Parameter Type And Name

Usage Information

DisconnectedCallbackInfo data

This struct is passed in with a call to {RTCInterface.AddNotifyDisconnected} registered event.

Related API Members