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

Agora RTM Web API Reference

概览 Globals AgoraRTM RtmClient RtmMessage RtmChannel LocalInvitation RemoteInvitation RtmErrorCode RtmStatusCode

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

example

监听频道消息

channel.on('ChannelMessage', function (message, memberId) {
  // 你的代码：收到频道消息。
});
example

监听用户加入频道事件

channel.on('MemberJoined', memberId => {
// 你的代码：用户已加入频道。
})
example

监听用户离开频道事件

channel.on('MemberLeft', memberId => {
  // 你的代码：用户已离开频道。
});

Hierarchy

  • RtmChannelEvents

Index

Events

Events

AttributesUpdated

AttributesUpdated: function

频道属性更新回调。返回所在频道的所有属性。

Note

只有当频道属性更新者将 enableNotificationToChannelMembers 设为 `true` 后，该回调才会被触发。请注意：该标志位仅对当前频道属性操作有效。

Type declaration

ChannelMessage

ChannelMessage: function

收到频道消息的事件通知。

param

接收到的频道消息对象。

param

该频道消息的发送者 uid。

Type declaration

MemberCountUpdated

MemberCountUpdated: function

频道成员人数更新回调。返回最新频道成员人数。

Note

  • 频道成员人数 ≤ 512 时，触发频率为每秒 1 次。
  • 频道成员人数超过 512 时，触发频率为每 3 秒 1 次。
  • 用户在成功加入频道时会收到该回调。你可以通过监听该回调获取加入频道时的频道成员人数和后继人数更新。
    • param

    最新频道成员人数。

    Type declaration

      • (memberCount: number): void

      • Parameters

        • memberCount: number

        Returns void

    MemberJoined

    MemberJoined: function

    收到用户加入频道的通知。

    Note

    当频道成员超过 512 时，该回调失效。
    param

    加入频道的用户的 uid。

    Type declaration

      • (memberId: string): void

      • Parameters

        • memberId: string

        Returns void

    MemberLeft

    MemberLeft: function

    收到用户离开频道的通知。

    用户调用 leave 方法离开频道或者由于网络原因与 Agora RTM 系统断开连接达到 30 秒都会触发此回调。

    当频道成员超过 512 时，该回调失效。

    param

    离开频道的远端用户的 uid。

    Type declaration

      • (memberId: string): void

      • Parameters

        • memberId: string

        Returns void