ARRtmClient

最近更新时间:2022-09-20 05:17:40

提供了供 App 调用的主要接口方法。

Methods

release(String uid) Future < void >

释放当前 ARRtmClient 实例使用的所有资源。

login(String token, String userId ) Future < ResultCallback >

登录 AR RTM 系统。

logout(String uid) Future < ResultCallback >

登录 AR RTM 系统。

createMessage (String uid) Future < void >

创建并返回一个空文本消息实例。

createMessage (String text) Future < void >

创建并返回一个文本消息实例。

createMessage (byte[String] data) Future < void >

创建并返回一个自定义二进制消息实例。

sendMessageToPeer(String peerId, ARRtmMessage message) Future < ResultCallback >

发送消息(包括点对点消息和频道消息)的调用频率上限为每 3 秒 180 次。我们不推荐使用该方法发送点对点消息。

sendMessageToPeer(String peerId, ARRtmMessage message,SendMessageOptions options) Future < ResultCallback >

向指定用户发送点对点消息或点对点的离线消息。

createChannel(String channelId)RtmChannelListener

创建一个 AR RTM 频道。

getRtmCallManager (String uid) RtmCallManager

获取 RtmCallManager 实例。

queryPeersOnlineStatus ((String peerIds) Future < ResultCallback >

查询指定用户的在线状态。

renewToken (String token) Future < ResultCallback >

更新当前的 RTM Token。

setLocalUserAttributes(List< RtmAttribute >) Future < ResultCallback >

全量设置本地用户的属性。

addOrUpdateLocalUserAttributes (List< RtmAttribute >) Future < ResultCallback >

添加或更新本地用户的属性。

deleteLocalUserAttributesByKeys (StringattributeKeys) Future < ResultCallback >

删除本地用户的指定属性。

clearLocalUserAttributes (String uid) Future < ResultCallback >

清空本地用户的所有属性。

getUserAttributes (String userId) ↔ List< RtmAttribute > Future < ResultCallback >

获取指定用户的全部属性。

getUserAttributesByKeys(String uid) ↔ List< RtmAttribute > Future < ResultCallback >

获取指定用户指定属性名的属性。

setChannelAttributes (String channelId)↔List< RtmChannelAttribute > ↔List<ChannelAttributeOptions> Future < ResultCallback >

全量设置某指定频道的属性。

addOrUpdateChannelAttributes (bool channelId) Future < ResultCallback >

添加或更新某指定频道的属性。

deleteChannelAttributesByKeys(bool channelId) Future < ResultCallback >

删除某指定频道的指定属性。

clearChannelAttributes(bool channelId) Future < ResultCallback >

清空某指定频道的属性。

getChannelAttributes (bool channelId) Future < ResultCallback >

查询某指定频道的全部属性。

getChannelAttributesByKeys(bool channelId) Future < ResultCallback >

查询某指定频道指定属性名的属性。

setLogFile (String filePath) Future < void >

设定日志文件的默认地址。

setLogFilter (int filter) Future < void >

设置日志输出等级。

setLogFileSize (int fileSizeInKBytes) Future < void >

设置 SDK 输出的单个日志文件的大小。

createInstance (String appId) ↔ List<ARRtmClient> Future < RtmClientListener >

创建一个或多个 ARRtmClient 实例。

getSdkVersion (String uid) Future < void >

获取 AR RTM SDK 的版本信息。

Static Methods

LOG_FILTER_OFF (String uid) Future < ARRtmClient >

不输出日志信息。

LOG_FILTER_INFO (String uid) Future < ARRtmClient >

输出 CRITICAL、ERROR、WARNING 和 INFO 级别的日志信息。

LOG_FILTER_WARNING (String uid) Future < ARRtmClient >

输出 CRITICAL、ERROR 和 WARNING 级别的日志信息。

LOG_FILTER_ERROR (String uid) Future < ARRtmClient >

输出 CRITICAL 和 ERROR 级别的日志信息。

LOG_FILTER_CRITICAL (String uid) Future < ARRtmClient >

输出 CRITICAL 级别的日志信息。

AR_RTM_END_CALL_PREFIX(String uid) Future < ARRtmClient >

用于结束通话的前缀信息。