通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
文档中心
云信令（原实时消息）
Console 官网 社区 技术支持
简体中文
search-icon

Agora RTM Web API Reference

概览 Globals AgoraRTM RtmClient RtmMessage RtmChannel LocalInvitation RemoteInvitation RtmErrorCode RtmStatusCode

RtmClient 实例上的事件类型。 该接口中，函数属性的名称为事件名称，函数的参数为事件监听回调的传入参数。

example

监听点对点消息

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

Hierarchy

  • RtmClientEvents

Index

Events

Properties

Events

ConnectionStateChanged

ConnectionStateChanged: function

通知 SDK 与 Agora RTM 系统的连接状态发生了改变。

param

新的连接状态

param

状态改变的原因

Type declaration

MessageFromPeer

MessageFromPeer: function

收到来自对端的点对点消息。

param

远端用户发送的消息对象。

param

发送该消息的远端用户 uid。

param

接收到的消息的属性。

Type declaration

RemoteInvitationReceived

RemoteInvitationReceived: function

收到来自主叫的呼叫邀请。

param

一个 RemoteInvitation 对象。

Type declaration

Properties

FallbackProxyConnected

FallbackProxyConnected: function

Type declaration

    • (): void

    • Returns void

PeersOnlineStatusChanged

PeersOnlineStatusChanged: function

被订阅用户在线状态改变回调。

  • 首次订阅在线状态成功时，SDK 也会返回本回调，显示所有被订阅用户的在线状态。
  • 每当被订阅用户的在线状态发生改变，SDK 都会通过该回调通知订阅方。
  • 如果 SDK 在断线重连过程中有被订阅用户的在线状态发生改变，SDK 会在重连成功时通过该回调通知订阅方。

Type declaration

TokenExpired

TokenExpired: function

（SDK 断线重连时触发）当前使用的 RTM Token 已超过 24 小时的签发有效期。

  • 该回调仅会在 SDK 处于 RECONNECTING 状态时因 RTM 后台监测到 Token 签发有效期过期而触发。SDK 处于 CONNECTED 状态时该回调不会被触发。
  • 收到该回调时，请尽快在你的业务服务端生成新的 Token 并调用 renewToken 方法把新的 Token 传给 Token 验证服务器。

Type declaration

    • (): void

    • Returns void

TokenPrivilegeWillExpire

TokenPrivilegeWillExpire: function

当前使用的 RTM Token 登录权限还有 30 秒就会超过签发有效期。

  • 收到该回调时，请尽快在你的业务服务端生成新的 Token 并调用 renewToken 方法把新的 Token 传给 Token 验证服务器。

Type declaration

    • (): void

    • Returns void