Documentation
Real-time Messaging
Agora RTM Web API Reference
Index
AgoraRTM
RtmClient
RtmMessage
RtmChannel
LocalInvitation
RemoteInvitation
RtmEvents
RtmErrorCode
RtmStatusCode
Hierarchy
- RtmClientEvents
Index
Events
ConnectionStateChanged
Occurs when the connection state changes between the SDK and the Agora RTM system.
Type declaration
-
-
Parameters
-
newState: ConnectionState
-
reason: ConnectionChangeReason
Returns void
-
-
MessageFromPeer
Occurs when the local user receives a peer-to-peer message from a remote user.
Type declaration
-
-
Parameters
-
message: RtmMessage
-
peerId: string
-
messageProps: ReceivedMessageProperties
Returns void
-
-
RemoteInvitationReceived
Occurs when the callee receives a call invitation from a remote user (caller).
Type declaration
-
-
Parameters
-
remoteInvitation: RemoteInvitation
Returns void
-
-
Properties
FallbackProxyConnected
Occurs when the SDK automatically switches to proxy WebSocket of 443 port.
Type declaration
-
-
Returns void
-
PeersOnlineStatusChanged
Occurs when the online status of the peers, to whom you subscribe, changes.
- When the subscription to the online status of specified peer(s) succeeds, the SDK returns this callback to report the online status of peers, to whom you subscribe.
- When the online status of the peers, to whom you subscribe, changes, the SDK returns this callback to report whose online status has changed.
- If the online status of the peers, to whom you subscribe, changes when the SDK is reconnecting to the server, the SDK returns this callback to report whose online status has changed when successfully reconnecting to the server.
Type declaration
-
-
Parameters
-
status: PeersOnlineStatusMap
Returns void
-
-
TokenExpired
Occurs when the RTM server detects that the RTM token has exceeded the 24-hour validity period and when the SDK is in the RECONNECTING state.
- This callback occurs only when the SDK is reconnecting to the server. You will not receive this callback when the SDK is in the
CONNECTEDstate. - When receiving this callback, generate a new RTM Token on the server and call the renewToken method to pass the new Token on to the server.
Type declaration
-
-
Returns void
-
TokenPrivilegeWillExpire
The currently used RTM Token login permission will expire after 30 seconds.
- When receiving this callback, generate a new RTM Token on the server and call the renewToken method to pass the new Token on to the server.
Type declaration
-
-
Returns void
-
Event listener type of the RtmClient instance. In this interface, the function property’s name is the event name; the function property’s parameters is the parameters of the event listener function.
Listening to peer-to-peer messages.
client.on('MessageFromPeer', function (message, peerId) { // Your code. });