添加或更新某指定频道的属性。
Note
该指定频道的 ID。
待增加或更新的属性列表。
频道属性操作选项。详见 ChannelAttributeOptions。
清空某指定频道的属性。
Note
该指定频道的频道 ID。
频道属性操作选项。详见 ChannelAttributeOptions。
该方法创建一个 RtmChannel 实例。
频道名称。该字符串不可超过 64 字节。以下为支持的字符集范围:
Note:
一个 RtmChannel 实例。
该方法创建一个 LocalInvitation 实例。
被叫的 uid。
一个 LocalInvitation 实例。
删除某指定频道的指定属性。
Note
该指定频道的 ID。
属性名列表。
频道属性操作选项。详见 ChannelAttributeOptions。
查询某指定频道的全部属性。
Note
该指定频道的 ID。
查询某指定频道指定属性名的属性。
Note
该指定频道的频道 ID。
频道属性名列表。
用户登录 Agora RTM 系统。
可选的动态密钥,一般由客户的服务端获取。
登录 Agora RTM 系统的用户 ID。该字符串不可超过 64 字节。以下为支持的字符集范围:
Note
number
类型。建议调用 toString()
方法转化非 string 型 uid。该 Promise 会在登录成功后 resolve。
退出登录,退出后自动断开连接和销毁回调监听。
该 Promise 会在登出成功并断开 WebSocket 连接后 resolve。
在该频道实例上添加 listener
函数到名为 eventName
的事件。其他 RtmClient
实例上的事件方法请参考 EventEmitter
API 文档。
RTM 客户端事件的名称。事件列表请参考 RtmClientEvents 中的属性名。
事件的回调函数。
订阅指定单个或多个用户的在线状态。
Note
本地用户(发送者)向指定用户(接收者)发送点对点消息或点对点的离线消息。
发送消息(包括点对点消息和频道消息)的频率上限为 60 次每秒。
要发送的文字消息。
远端用户的 uid。
该 Promise 会在发送成功后 resolve。Promise 的值代表对方是否在线并接收成功。
全量设置某指定频道的属性。
Note
该指定频道的频道 ID。
频道属性列表实例。
频道属性操作选项。详见 ChannelAttributeOptions。
配置 SDK 提供技术预览或特别定制功能。
详见 RtmParameters。
RTM 客户端类。你可以通过 AgoraRTM 上的 createInstance 方法创建 RTM 客户端实例。Agora RTM SDK 的入口。