通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
文档中心
云信令（原实时消息）
Console 官网 社区 技术支持
简体中文
search-icon

Agora RTM Java API Reference for Android

概览 RtmClient RtmMessage RtmImageMessage RtmFileMessage SendMessageOptions PeerSubscriptionOption PeerOnlineState RtmAttribute RtmChannelAttribute ChannelAttributeOptions RtmChannelMemberCount RtmChannel RtmChannelMember RtmCallManager LocalInvitation RemoteInvitation ResultCallback RtmClientListener RtmChannelListener RtmCallEventListener RtmRequestId RtmMediaOperationProgress 状态码和错误码

Public 成员函数

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 用户方法回调。

成员函数说明

◆ onConnectionStateChanged()

void io.agora.rtm.RtmClientListener.onConnectionStateChanged ( int  state,
int  reason 
)

SDK 与 Agora RTM 系统的连接状态发生改变回调。

参数
state新连接状态。详见 ConnectionState。
reason连接状态改变原因。详见 ConnectionChangeReason。

◆ onMessageReceived()

void io.agora.rtm.RtmClientListener.onMessageReceived ( RtmMessage  message,
String  peerId 
)

收到点对点消息回调。

参数
message被接收的消息。详见 RtmMessage。
peerId消息发送者的用户 ID。

◆ onImageMessageReceivedFromPeer()

void io.agora.rtm.RtmClientListener.onImageMessageReceivedFromPeer ( RtmImageMessage  message,
String  peerId 
)
弃用:
该方法自 1.5.0 版本开始正式下线，Agora 建议你不要使用。

收到点对点图片消息回调。

参数
message被接收的消息。详见 RtmImageMessage。
peerId消息发送者的用户 ID。

◆ onFileMessageReceivedFromPeer()

void io.agora.rtm.RtmClientListener.onFileMessageReceivedFromPeer ( RtmFileMessage  message,
String  peerId 
)
弃用:
该方法自 1.5.0 版本开始正式下线，Agora 建议你不要使用。

收到点对点文件消息回调。

参数
message被接收的消息。详见 RtmFileMessage。
peerId消息发送者的用户 ID。

◆ onMediaUploadingProgress()

void io.agora.rtm.RtmClientListener.onMediaUploadingProgress ( RtmMediaOperationProgress  progress,
long  requestId 
)
弃用:
该方法自 1.5.0 版本开始正式下线，Agora 建议你不要使用。

主动回调：上传进度回调。

参数
progress文件或图片的上传进度。详见 RtmMediaOperationProgress。
requestId标识本次上传请求的的唯一 ID。

◆ onMediaDownloadingProgress()

void io.agora.rtm.RtmClientListener.onMediaDownloadingProgress ( RtmMediaOperationProgress  progress,
long  requestId 
)
弃用:
该方法自 1.5.0 版本开始正式下线，Agora 建议你不要使用。

主动回调：下载进度回调。

参数
progress文件或图片的下载进度。详见 RtmMediaOperationProgress。
requestId标识本次下载请求的的唯一 ID。

◆ onTokenExpired()

void io.agora.rtm.RtmClientListener.onTokenExpired ( )

当前使用的 RTM Token 已超过签发有效期。

  • 如果 Token 过期时，用户处于 CONNECTION_STATE_CONNECTED 状态，会收到该回调并切换至 CONNECTION_STATE_ABORTED 状态。此时，用户需要调用 login 方法重新登录。
  • 如果 Token 过期时，用户由于网络问题处于 CONNECTION_STATE_RECONNECTING 状态，会在网络恢复时收到该回调。此时，用户需要调用 renewToken 方法恢复连接。

◆ 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 会在重连成功时通过该回调通知订阅方。
参数
peersStatus用户在线状态列表。详见 PeerOnlineState。