本文介绍 ArRTM WebSDK 提供的相关 API 接口及其各 API 接口的用法。
RTM SDK 同时支持小程序和Web
登录登出流程
API | 描述 |
---|---|
createInstance | 创建并返回一个 RtmClient 实例。 |
login | 用户登录 anyrtc RTM 系统。 |
logout | 退出登录,退出后自动断开连接和销毁回调监听。 |
事件回调 | 描述 |
---|---|
ConnectionStateChanged | SDK 与 anyrtc RTM 系统的连接状态发生了改变时触发该回调。 |
点对点消息
API | 描述 |
---|---|
sendMessageToPeer | 向指定用户(接收者)发送消息或离线消息。 |
事件回调 | 描述 |
---|---|
MessageFromPeer | 收到对端发送的消息时触发该回调。 |
查询用户在线状态
API | 描述 |
---|---|
queryPeersOnlineStatus | 查询指定用户的在线状态。 |
订阅或取消订阅单个或多个指定用户的在线状态
API | 描述 |
---|---|
subscribePeersOnlineStatus | 订阅指定单个或多个用户的在线状态。 |
unsubscribePeersOnlineStatus | 取消订阅指定单个或多个用户的在线状态。 |
queryPeersBySubscriptionOption | 获取某特定内容被订阅的用户列表。 |
事件回调 | 描述 |
---|---|
PeersOnlineStatusChanged | 被订阅用户在线状态发生改变时触发该回调。 |
用户属性增删改查
API | 描述 |
---|---|
setLocalUserAttributes | 全量设置本地用户的属性。 |
addOrUpdateLocalUserAttributes | 添加或更新本地用户的属性。 |
deleteLocalUserAttributesByKeys | 删除本地用户的指定属性。 |
clearLocalUserAttributes | 清空本地用户的属性。 |
getUserAttributes | 获取指定用户的全部属性。 |
getUserAttributesByKeys | 获取指定用户指定属性名的属性。 |
频道属性增删改查
API | 描述 |
---|---|
setChannelAttributes | 全量设置某指定频道的属性。 |
addOrUpdateChannelAttributes | 添加或更新某指定频道的属性。 |
deleteChannelAttributesByKeys | 删除某指定频道的指定属性。 |
clearChannelAttributes | 清空某指定频道的属性。 |
getChannelAttributes | 查询某指定频道的全部属性。 |
getChannelAttributesByKeys | 查询某指定频道指定属性名的属性。 |
事件回调 | 描述 |
---|---|
AttributesUpdated | 频道属性更新回调。当频道属性更新时返回当前频道的所有属性。 |
获取查询单个或多个频道的成员人数
API | 描述 |
---|---|
getChannelMemberCount | 查询单个或多个频道的成员人数。用户无需加入指定频道即可调用该方法。 |
加入离开频道相关
API | 描述 |
---|---|
createChannel | 创建并返回一个 RtmChannel 实例。 |
join | 加入频道。加入频道成功后可收到该频道消息和频道用户进出通知。 |
leave | 离开频道。不再接收频道消息和频道用户进出通知。 |
事件回调 | 描述 |
---|---|
MemberJoined | 远端用户加入频道回调。 |
MemberLeft | 远端用户离开频道回调。 |
MemberCountUpdated | 频道成员人数更新时触发该回调,返回最新频道成员人数。 |
频道消息
API | 描述 |
---|---|
sendMessage | 供频道成员向所在频道发送频道消息。 |
事件回调 | 描述 |
---|---|
ChannelMessage | 收到频道消息时触发该回调。 |
获取频道成员列表
API | 描述 |
---|---|
getMembers | 获取频道成员列表。 |
呼叫邀请管理
主叫API | 描述 |
---|---|
createLocalInvitation | 创建并返回一个 LocalInvitation 实例。 |
send | 主叫向对端发送呼叫邀请。 |
cancel | 主叫取消已发送的呼叫邀请。 |
被叫API | 描述 |
---|---|
accept | 被叫接受呼叫邀请。 |
refuse | 被叫拒绝呼叫邀请。 |
主叫事件回调 | 描述 |
---|---|
LocalInvitationReceivedByPeer | 被叫已收到呼叫邀请时触发。 |
LocalInvitationCanceled | 呼叫邀请已被主叫取消时触发。 |
LocalInvitationAccepted | 被叫已接受呼叫邀请时触发。 |
LocalInvitationRefused | 被叫已拒绝呼叫邀请时触发。 |
LocalInvitationFailure | 呼叫邀请过程失败时触发。 |
被叫事件回调 | 描述 |
---|---|
RemoteInvitationReceived | 收到呼叫邀请时触发。 |
RemoteInvitationCanceled | 主叫已取消呼叫邀请时触发。 |
RemoteInvitationAccepted | 接受呼叫邀请成功时触发。 |
RemoteInvitationRefused | 拒绝呼叫邀请成功时触发。 |
RemoteInvitationFailure | 呼叫邀请过程失败时触发。 |
更新 Token
API | 描述 |
---|---|
renewToken | 更新当前 Token。 |
事件回调 | 描述 |
---|---|
TokenWillExpired | Token 即将过期触发该回调。 |
TokenDidExpired | Token 过期时触发该回调。 |
日志设置与版本查询
属性 | 描述 |
---|---|
logFilter | 设置 SDK 的日志输出等级。 |
VERSION | anyrtc RTM SDK 的当前版本信息。 |
定制方法
API | 描述 |
---|---|
setParameters | 配置 SDK 提供技术预览或特别定制功能。 |