Signaling (previously RTM) SDK v1.5.0 API Reference for Linux (Java)
|
Public Member Functions |
|
void | onConnectionStateChanged (int state, int reason) |
void | onMessageReceived (RtmMessage message, String peerId) |
void | onImageMessageReceivedFromPeer (RtmImageMessage message, String peerId) |
void | onFileMessageReceivedFromPeer (RtmFileMessage message, String peerId) |
void | onMediaUploadingProgress (RtmMediaOperationProgress progress, long requestId) |
void | onMediaDownloadingProgress (RtmMediaOperationProgress progress, long requestId) |
void | onTokenExpired () |
void | onTokenPrivilegeWillExpire () |
void | onPeersOnlineStatusChanged (Map< String, PEER_ONLINE_STATE > peersStatus) |
Agora RTM 用户方法回调。
void io.agora.rtm.RtmClientListener.onConnectionStateChanged | ( | int | state, |
int | reason | ||
) |
SDK 与 Agora RTM 系统的连接状态发生改变回调。
state |
新连接状态。详见
ConnectionState 。
|
reason |
连接状态改变原因。详见
ConnectionChangeReason 。
|
void io.agora.rtm.RtmClientListener.onMessageReceived | ( | RtmMessage | message, |
String | peerId | ||
) |
收到点对点消息回调。
message |
被接收的消息。详见
RtmMessage 。
|
peerId | 消息发送者的用户 ID。 |
void io.agora.rtm.RtmClientListener.onImageMessageReceivedFromPeer | ( | RtmImageMessage | message, |
String | peerId | ||
) |
收到点对点图片消息回调。
message |
被接收的消息。详见
RtmImageMessage 。
|
peerId | 消息发送者的用户 ID。 |
void io.agora.rtm.RtmClientListener.onFileMessageReceivedFromPeer | ( | RtmFileMessage | message, |
String | peerId | ||
) |
收到点对点文件消息回调。
message |
被接收的消息。详见
RtmFileMessage 。
|
peerId | 消息发送者的用户 ID。 |
void io.agora.rtm.RtmClientListener.onMediaUploadingProgress | ( | RtmMediaOperationProgress | progress, |
long | requestId | ||
) |
主动回调:上传进度回调。
progress |
文件或图片的上传进度。详见
RtmMediaOperationProgress 。
|
requestId | 标识本次上传请求的的唯一 ID。 |
void io.agora.rtm.RtmClientListener.onMediaDownloadingProgress | ( | RtmMediaOperationProgress | progress, |
long | requestId | ||
) |
主动回调:下载进度回调。
progress |
文件或图片的下载进度。详见
RtmMediaOperationProgress 。
|
requestId | 标识本次下载请求的的唯一 ID。 |
void io.agora.rtm.RtmClientListener.onTokenExpired | ( | ) |
当前使用的 RTM Token 已超过签发有效期。
CONNECTION_STATE_CONNECTED
状态,会收到该回调并切换至
CONNECTION_STATE_ABORTED
状态。此时,用户需要调用
login
方法重新登录。
CONNECTION_STATE_RECONNECTING
状态,会在网络恢复时收到该回调。此时,用户需要调用
renewToken
方法恢复连接。
void io.agora.rtm.RtmClientListener.onTokenPrivilegeWillExpire | ( | ) |
当前使用的 RTM Token 还有 30 秒过期。
renewToken
方法将该 Token 传给 SDK。
login
方法登录时传入的 Token 直至过期仍未更新,SDK 会断线重连,用户将下线。
void io.agora.rtm.RtmClientListener.onPeersOnlineStatusChanged | ( | Map< String, PEER_ONLINE_STATE > | peersStatus | ) |
被订阅用户在线状态改变回调。
peersStatus |
用户在线状态列表。详见
PeerOnlineState 。
|