Agora RTM 微信小程序 SDK 是通过微信小程序加载的 JavaScript 库。
请分别调用 RtmClient.on 和 RtmChannel.on 方法添加 RtmClient 和 RtmChannel 对象的监听器。
Agora RTM 微信小程序 SDK 提供以下功能:
方法 | 描述 |
---|---|
createInstance | 创建一个 RtmClient 实例。 |
login | 登录 Agora RTM 系统。 |
logout | 退出登录,退出后自动断开连接和销毁回调监听。 |
事件 | 描述 |
---|---|
ConnectionStateChanged | 通知 SDK 与 Agora RTM 系统的连接状态发生了改变。 |
方法 | 描述 |
---|---|
sendMessageToPeer | 向指定用户(接收者)发送点对点消息或点对点的离线消息。 |
事件 | 描述 |
---|---|
MessageFromPeer | 收到来自对端的点对点消息。 |
方法 | 描述 |
---|---|
createChannel | 创建一个 RtmChannel 实例。 |
join | 加入频道。加入频道成功后可收到该频道消息和频道用户进出通知。 |
leave | 离开频道。不再接收频道消息和频道用户进出通知。 |
事件 | 描述 |
---|---|
MemberJoined | 远端用户加入频道回调。 |
MemberLeft | 远端用户离开频道回调。 |
方法 | 描述 |
---|---|
sendMessage | 供频道成员向所在频道发送频道消息。 |
事件 | 描述 |
---|---|
ChannelMessage | 收到频道消息回调。 |
方法 | 描述 |
---|---|
getMembers | 获取频道成员列表。 |
供主叫调用的方法 | 描述 |
---|---|
createLocalInvitation | 供主叫创建一个 LocalInvitation 实例。 |
send | 供主叫发送呼叫邀请给对端。 |
cancel | 供主叫取消已发送的呼叫邀请。 |
供被叫调用的方法 | 描述 |
---|---|
accept | 供被叫接受呼叫邀请。 |
refuse | 供被叫拒绝呼叫邀请。 |
返回给主叫的事件 | 描述 |
---|---|
LocalInvitationReceivedByPeer | 返回给主叫的回调:被叫已收到呼叫邀请。 |
LocalInvitationCanceled | 返回给主叫的回调:呼叫邀请已被取消。 |
LocalInvitationAccepted | 返回给主叫的回调:被叫已接受呼叫邀请。 |
LocalInvitationRefused | 返回给主叫的回调:被叫已拒绝呼叫邀请。 |
LocalInvitationFailure | 返回给主叫的回调:呼叫邀请过程失败。 |
返回给被叫的事件 | 描述 |
---|---|
RemoteInvitationReceived | 返回给被叫的回调:收到一条呼叫邀请。 |
RemoteInvitationCanceled | 返回给被叫的回调:主叫已取消呼叫邀请。 |
RemoteInvitationAccepted | 返回给被叫的回调:接受呼叫邀请成功。 |
RemoteInvitationRefused | 返回给被叫的回调:拒绝呼叫邀请成功。 |
RemoteInvitationFailure | 返回给被叫的回调:呼叫邀请过程失败。 |
方法 | 描述 |
---|---|
renewToken | 更新当前 Token。 |
事件 | 描述 |
---|---|
TokenExpired | Token 过期回调。 |
变量 | 描述 |
---|---|
enableLogUpload | 是否启用日志上传。 |
logFilter | 设置 SDK 的日志输出等级。 |
VERSION | Agora RTM SDK 的当前版本信息。 |
方法 | 描述 |
---|---|
setParameters | 配置 SDK 提供技术预览或特别定制功能。 |