agora_rtm.PeerOnlineStatus Struct Reference

Public Attributes
string	peerId
bool	isOnline
PEER_ONLINE_STATE	onlineState

Member Data Documentation

isOnline

bool agora_rtm.PeerOnlineStatus.isOnline

Deprecated:

Use onlineState instead.

The online status of the peer.

• true: The user is online (the user has logged in the Agora RTM system).
• false: The user is offline (the user has logged out of the Agora RTM system, has not logged in, or has failed to logged in).

onlineState

PEER_ONLINE_STATE agora_rtm.PeerOnlineStatus.onlineState

The online state of the peer. See PEER_ONLINE_STATE.

Note

• The server will never return the unreachable state, if you query the online status of specified peers (QueryPeersOnlineStatus). See also: OnQueryPeersOnlineStatusResultHandler.
• The server may return the unreachable state, if you subscribe to the online status of specified peers (SubscribePeersOnlineStatus). See also: OnPeersOnlineStatusChangedHandler.

peerId

string agora_rtm.PeerOnlineStatus.peerId

The user ID of the peer.

---

The documentation for this struct was generated from the following file:

• RtmBase.cs