文档中心
云信令(原实时消息)
API 参考
Agora RTM Java API Reference for Android
Agora RTM Java API Reference for Linux
◆ onConnectionStateChanged()
void io.agora.rtm.RtmClientListener.onConnectionStateChanged |
( |
int |
state, |
|
|
int |
reason |
|
) |
| |
SDK 与 Agora RTM 系统的连接状态发生改变回调。
- 参数
-
◆ onMessageReceived()
void io.agora.rtm.RtmClientListener.onMessageReceived |
( |
RtmMessage |
message, |
|
|
String |
peerId |
|
) |
| |
◆ onImageMessageReceivedFromPeer()
void io.agora.rtm.RtmClientListener.onImageMessageReceivedFromPeer |
( |
RtmImageMessage |
message, |
|
|
String |
peerId |
|
) |
| |
- 弃用:
- 该方法自 1.5.0 版本开始正式下线,Agora 建议你不要使用。
收到点对点图片消息回调。
- 参数
-
◆ onFileMessageReceivedFromPeer()
void io.agora.rtm.RtmClientListener.onFileMessageReceivedFromPeer |
( |
RtmFileMessage |
message, |
|
|
String |
peerId |
|
) |
| |
- 弃用:
- 该方法自 1.5.0 版本开始正式下线,Agora 建议你不要使用。
收到点对点文件消息回调。
- 参数
-
◆ onMediaUploadingProgress()
- 弃用:
- 该方法自 1.5.0 版本开始正式下线,Agora 建议你不要使用。
主动回调:上传进度回调。
- 参数
-
◆ onMediaDownloadingProgress()
- 弃用:
- 该方法自 1.5.0 版本开始正式下线,Agora 建议你不要使用。
主动回调:下载进度回调。
- 参数
-
◆ onTokenExpired()
void io.agora.rtm.RtmClientListener.onTokenExpired |
( |
| ) |
|
(SDK 断线重连时触发)当前使用的 RTM Token 已超过 24 小时的签发有效期。
- 该回调仅会在 SDK 处于 CONNECTION_STATE_RECONNECTING 状态时因 RTM 后台监测到 Token 签发有效期过期而触发。SDK 处于 CONNECTION_STATE_CONNECTED 状态时该回调不会被触发。
- 收到该回调时,请尽快在你的业务服务端生成新的 Token 并调用
renewToken
方法把新的 Token 传给 Token 验证服务器。
◆ onTokenPrivilegeWillExpire()
void io.agora.rtm.RtmClientListener.onTokenPrivilegeWillExpire |
( |
| ) |
|
当前使用的 RTM Token 还有 30 秒过期。
- SDK 触发该回调提醒 App 当前 Token 即将过期,应即时获取新 Token。收到该回调后,你需要在服务端生成新 Token 并调用
renewToken
方法将该 Token 传给 SDK。
- 如果调用
login
方法登录时传入的 Token 直至过期仍未更新,SDK 会断线重连,用户将下线。
◆ onPeersOnlineStatusChanged()
void io.agora.rtm.RtmClientListener.onPeersOnlineStatusChanged |
( |
Map< String, PEER_ONLINE_STATE > |
peersStatus | ) |
|
被订阅用户在线状态改变回调。
-
首次订阅在线状态成功时,SDK 也会返回本回调,显示所有被订阅用户的在线状态。
-
每当被订阅用户的在线状态发生改变,SDK 都会通过该回调通知订阅方。
-
如果 SDK 在断线重连过程中有被订阅用户的在线状态发生改变,SDK 会在重连成功时通过该回调通知订阅方。
- 参数
-