Public 成员函数 | |
---|---|
abstract void | join (ResultCallback< Void > resultCallback) |
abstract void | leave (ResultCallback< Void > resultCallback) |
abstract void | sendMessage (RtmMessage message, ResultCallback< Void > resultCallback) |
abstract void | sendMessage (RtmMessage message, SendMessageOptions options, ResultCallback< Void > resultCallback) |
abstract void | getMembers (ResultCallback< List< RtmChannelMember >> resultCallback) |
abstract String | getId () |
abstract void | release () |
详细描述
AR RTM 频道方法。
成员函数说明
getId()
abstract String org.ar.rtm.RtmChannel.getId( )
获取当前频道 ID。
返回
当前频道 ID。
getMembers()
abstract void org.ar.rtm.RtmChannel.getMembers( ResultCallback< List< RtmChannelMember >> resultCallback)
获取频道成员列表。
注解
该方法的调用频率上限为每 2 秒 5 次。
参数 | 描述 |
---|---|
resultCallback | 一个 ResultCallback 对象 方法调用成功:本地用户收到回调 onSuccess 和频道成员列表。频道成员的数据结构详见 RtmChannelMember。 方法调用失败:本地用户收到回调 onFailure。错误代码信息详见 GetMembersError。 |
join()
abstract void org.ar.rtm.RtmChannel.join(ResultCallback< Void > resultCallback)
加入频道。
注解
同一用户只能同时加入最多 20 个频道。加入频道超限时用户会收到错误码 JOIN_CHANNEL_ERR_FAILURE。
参数 | 描述 |
---|---|
resultCallback | 一个 ResultCallback 对象 方法调用成功: 本地用户收到回调 onSuccess 所有远端用户收到回调 onMemberJoined 方法调用失败:本地用户收到回调 onFailure。错误代码信息详见 JoinChannelError。 |
leave()
abstract void org.ar.rtm.RtmChannel.leave(ResultCallback< Void > resultCallback)
离开频道。
参数 | 描述 |
---|---|
resultCallback | 一个 ResultCallback 对象 方法调用成功: 本地用户收到回调 onSuccess 所有远端用户收到回调 onMemberLeft。 方法调用失败:本地用户收到回调 onFailure。错误代码信息详见 LeaveChannelError。 |
release()
abstract void org.ar.rtm.RtmChannel.release ()
释放该频道的所有资源。
注解
请不要在任何回调方法中调用该方法。
sendMessage()
abstract void org.ar.rtm.RtmChannel.sendMessage(RtmMessage message,SendMessageOptions options,ResultCallback<Void> resultCallback)
发送频道消息。
注解
对于 RTM SDK for Android Java,发送消息(包括频道消息和点对点消息)的调用频率上限为每 3 秒 180 次。对于 RTM SDK for Linux Java,发送消息(包括频道消息和点对点消息)的调用频率上限为每 3 秒 300 次。
参数 | 描述 |
---|---|
message | 待发送的消息。详见 RtmMessage。 |
options | 消息发送选项。详见 SendMessageOptions。 |
resultCallback | 一个 ResultCallback 对象 方法调用成功: 本地用户收到回调 onSuccess 所有远端用户收到回调 onMessageReceived。 方法调用失败:本地用户收到回调 onFailure。错误代码信息详见 ChannelMessageError。 |