agora::rtm::PeerOnlineStatus Struct Reference

#include <IAgoraRtmService.h>

Public Attributes
const char *	peerId
bool	isOnline
PEER_ONLINE_STATE	onlineState

Member Data Documentation

peerId

const char* agora::rtm::PeerOnlineStatus::peerId

The user ID of the peer.

isOnline

bool agora::rtm::PeerOnlineStatus::isOnline

Deprecated:

Deprecated as of v1.2.0. 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: onQueryPeersOnlineStatusResult.
• The server may return the unreachable state, if you subscribe to the online status of specified peers (subscribePeersOnlineStatus). See also: onPeersOnlineStatusChanged.