Android

编辑文档更新于 2024-11-11 06:14:32

本页包含 IBRTMRoom 以及 IBRTMRoomListener 接口定义两大部分。涵盖了控制 BRTM 房间的各种操作以及相关事件回调监听。

IBRTMRoom

函数列表	描述
joinRoomWithConfig	加入房间
leaveRoom	离开房间
setRoomListener	设置房间状态监听
setDocumentListener	设置文档状态监听
setUserListener	设置用户权限变更监听
getDocumentManager	获取文档管理器
setShapeListener	设置激光笔画笔更新监听
getOnlineUserManager	获取用户管理器（包含权限设置，权限变更监听等)
getChatManager	获取聊天管理器
obtainDocument	获取一个文档实例
isDocumentServiceEnabled	文档服务是否启用
enableDocumentService	启用文档服务
disableDocumentService	禁用文档服务
getCurrentUser	获取当前用户信息
sendMessage	给指定用户发送消息
sendBroadcastMessage	发送广播消息
requestBroadcastMessageCache	获请求广播缓存
clearBroadcastMessageCache	清除广播消息缓存
getSdkVersion	获取 SDK 版本号

joinRoomWithConfig

加入房间

void joinRoomWithConfig(BRTMConfig brtmConfig)

参数

Name	Type	Description
brtmConfig	BRTMConfig	进房间配置项（签名、user信息）

返回
无

leaveRoom

离开房间

void leaveRoom()

参数
无

返回
无

setRoomListener

设置房间状态监听

void setRoomListener(IBRTMRoomListener roomListener)

参数

Name	Type	Description
roomListener	IBRTMRoomListener	设置房间状态监听

返回
无

setDocumentListener

设置文档状态监听

void setDocumentListener(IBRTMDocumentListener documentListener)

参数

Name	Type	Description
documentListener	IBRTMDocumentListener	设置文档监听

返回
无

setUserListener

设置用户信息监听

void setUserListener(IBRTMUserListener userListener)

参数

Name	Type	Description
userListener	IBRTMUserListener	用户信息监听器

返回
无

getDocumentManager

获取文档管理器
共享一个文档、获取共享文档列表、请求文档信息……等功能都需要通过文档管理器来执行。

IBRTMDocumentManager getDocumentManager()

参数
无

返回
IBRTMDocumentManager

setShapeListener

设置激光笔画笔更新监听

void setShapeListener(IBRTMShapeListener shapeListener)

参数

Name	Type	Description
shapeListener	IBRTMShapeListener	激光笔监听

返回
无

getOnlineUserManager

获取用户管理器（包含权限设置，权限变更监听等）

IBRTMOnlineUserManager getOnlineUserManager()

参数
无

返回
IBRTMOnlineUserManager

getChatManager

获取聊天管理器

IBRTMChatManager getChatManager()

参数无

返回
IBRTMChatManager

obtainDocument

获取一个文档实例

IBRTMDocument obtainDocument()

参数
无

返回
IBRTMDocument

isDocumentServiceEnabled

查询当前房间文档服务是否启用了

版本要求：>= 0.3.1

boolean isDocumentServiceEnabled();

参数
无

返回
true：文档服务已启用，false：文档服务未启用

enableDocumentService

启用文档服务

void enableDocumentService()

参数
无

返回
无

说明

此方法为异步请求。您可以通过IBRTMDocumentListener.onDocumentServiceEnable()监听文档服务的启停状态改变

disableDocumentService

禁用文档服务

void disableDocumentService()

参数
无

返回
无

说明

此方法为异步请求。您可以通过IBRTMDocumentListener.onDocumentServiceEnable()监听文档服务的启停状态改变

getCurrentUser

获取当前用户信息

BRTMUserModel getCurrentUser()

参数
无

返回
BRTMUserModel

sendMessage

给指定用户发送消息

BRTMError sendMessage(String key, JsonPrimitive command, String toUserId)

参数

Name	Type	Description
key	string	消息类型
command	JsonPrimitive	消息体
toUserId	string	接收者userId

返回
BRTMError

说明

过快的发送频率（1 分钟超过 60 条）会被屏蔽，并返回错误码

返回值并不代表发送成功与否，因为发送消息是异步的，此方法返回值是同步返回

sendBroadcastMessage

发送广播消息

BRTMError sendBroadcastMessage(String key, JsonElement value, boolean withCache)

参数

Name	Type	Description
key	string	广播类型
value	JsonElement	广播内容
withCache	boolean	服务端是否缓存

BRTMError

说明

过快的发送频率（1 分钟超过 60 条）会被屏蔽，并返回错误码

返回值并不代表发送成功与否，因为发送消息是异步的，此方法返回值是同步返回

requestBroadcastMessageCache

请求广播缓存

void requestBroadcastMessageCache(String key)

参数

Name	Type	Description
key	string	广播类型

BRTMError

clearBroadcastMessageCache

清除广播消息缓存

版本要求：>= 0.3.0

void clearBroadcastMessageCache(String key)

参数

Name	Type	Description
key	string	广播类型

返回
无

getSdkVersion

获取 SDK 版本号

版本要求：>= 0.2.1

String getSdkVersion()

参数
无

返回
SDK版本号字符串

IBRTMRoomListener

函数列表	描述
onError	房间错误回调
onRoomJoined	进入房间成功回调
onLeaveRoom	离开房间回调
onMessageReceived	一对一消息回调
onBroadcastMessageReceived	广播消息回调

onError

进入房间出错回调

void onError(BRTMError error)

参数

Name	Type	Description
error	BRTMError	错误信息对象

返回
无

onRoomJoined

进入房间成功回调

void onRoomJoined()

参数
无

返回
无

onLeaveRoom

离开房间回调

void onLeaveRoom()

参数
无

返回
无

onMessageReceived

一对一消息回调

void onMessageReceived(String key, Object value, String userId)

参数

Name	Type	Description
key	string	消息类型
value	Object	消息体
userId	string	消息发送者Id

返回
无

onBroadcastMessageReceived

广播消息回调

void onBroadcastMessageReceived(String key, Object value)

参数

Name	Type	Description
key	String	消息类型
value	Object	消息体

返回
无