文档中心
实时信令
Console 官网 社区 技术支持
简体中文
search-icon

概览

更新时间 2022/12/02 03:29:04

RTM 2 客户端 SDK 包含以下方法和回调接口：

初始配置

方法 描述
createAgoraRtmClient 创建 RtmClient 单实例。
initialize 初始化 RtmClient 单实例。
release 销毁 RtmClient 单实例以释放资源。

频道

Stream Channel

方法 描述
createStreamChannel 创建一个 StreamChannel 类型实例。
release 销毁一个 StreamChannel 类型实例。
join 加入频道。
getChannelName 获取频道名称。
leave 离开频道。
joinTopic 加入一个 Topic。
leaveTopic 离开一个 Topic。
publishTopicMessage 在指定 Topic 中发送文本消息。
subscribeTopic 订阅 Topic 及 Topic 中的消息发送者。
unsubscribeTopic 取消订阅某 Topic 或取消对该 Topic 中指定的消息发布者的订阅。
getSubscribedUserList 查询指定 Topic 中已订阅的消息发布者列表。
回调 描述
onJoinResult join 调用的异步回调，在加入频道时触发。
onLeaveResult leave 调用的异步回调，在离开频道时触发。
onJoinTopicResult joinTopic 调用的异步回调，在加入 Topic 时触发。
onLeaveTopicResult leaveTopic 调用的异步回调，在离开 Topic 时触发。
onTopicSubscribed subscribeTopic 调用的异步回调，订阅 Topic 或订阅 Topic 中消息发布者时会触发该回调。
onTopicUnsubscribed unsubscribeTopic 调用的异步回调，取消订阅 Topic 或取消订阅 Topic 中消息发布者时会触发该回调。

事件通知

频道

事件 描述
onConnectionStateChange SDK 连接状态发生改变时会发送该事件通知。
onPresenceEvent 当频道中有用户的 Presence 状态发生变更时，SDK 会发送该事件通知。

消息

事件 描述
onMessageEvent 当你在 Message Channel 的频道或 Stream Channel 的 Topic 中订阅的用户发布消息时，SDK 会发送该事件通知。