通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
Documentation
Real-time Messaging
Console 官网 Community Technical support
English
search-icon

Agora RTM Web API Reference

Index AgoraRTM RtmClient RtmMessage RtmChannel LocalInvitation RemoteInvitation RtmEvents RtmErrorCode RtmStatusCode

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.

example

Listening to peer-to-peer messages.

client.on('MessageFromPeer', function (message, peerId) {
  // Your code.
});

Hierarchy

  • RtmClientEvents

Index

Events

Properties

Events

ConnectionStateChanged

ConnectionStateChanged: function

Occurs when the connection state changes between the SDK and the Agora RTM system.

param

The new connection state.

param

Reasons for the connection state change.

Type declaration

MessageFromPeer

MessageFromPeer: function

Occurs when the local user receives a peer-to-peer message from a remote user.

param

The received peer-to-peer message object.

param

The uid of the sender.

param

The properties of the received message.

Type declaration

RemoteInvitationReceived

RemoteInvitationReceived: function

Occurs when the callee receives a call invitation from a remote user (caller).

param

A RemoteInvitation object.

Type declaration

Properties

TokenExpired

TokenExpired: function

Occurs when the current RTM Token exceeds the 24-hour validity period.

This callback occurs when the current RTM Token exceeds the 24-hour validity period and reminds the user to renew it. 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

    • (): void

    • Returns void