互动白板>客户端 API>uni-app

uni-app

编辑文档 更新于
BRTMBRTMDocumentManagerBRTMChatManagerBRTMUserManagerBRTMDocument对象和枚举

BRTM uni-app SDK 是基于 uni-app 框架的 BRTM 客户端 SDK，开发者可以通过 BRTM uni-app SDK 轻松实现 BRTM 的功能。

接口

函数列表 描述
createInstance 创建 Brtm Sdk 实例
destroyInstance 删除 Brtm Sdk 实例对象
on 监听事件
off 取消监听事件
enterRoom 进入房间
exitRoom 离开房间
enableDocumentService 启用或关闭文档服务
sendMessage 给某个用户发送消息
sendBroadcastMessage 给房间内所有用户发送广播消息
requestBroadcastMessageCache 请求广播缓存
clearBroadcastMessageCache 清除广播缓存
getDocumentManager 获取文档管理器 BrtmDocumentManager
getChatManager 获取聊天管理器 BrtmChatManager
getUserManager 获取用户管理器 BrtmUserManager

回调事件

事件名 描述
onError 错误通知
onRoomJoined 进入房间成功通知
onLeaveRoom 离开房间成功通知
onMessageReceived 收到某个用户发来的房间消息通知
onBroadcastMessageReceived 收到广播房间消息通知
onDocumentServiceEnable 房间内的 document 服务是否可用通知
onWhiteboardPageAdded 增加一页白板的通知
onWhiteboardPageDeleted 删除一页白板的通知
onAllDocumentsReceived 收到所有文档的通知
onDocumentAdded 增加 ppt 文档的通知
onDocumentDeleted 删除 ppt 文档的通知
onDocumentUpdated 更新 ppt 文档的通知
onPageSelected 文档翻页的通知
onDocumentListChanged 文档列表改变的通知
onDocumentTypeChanged 动态和静态 ppt 之间的切换的通知
onUserListUpdate 用户列表更新通知
onUserIn 用户进入房间通知
onUserOut 用户退出房间通知
onKickOut 用户被踢出通知
onReceiveChatMessage 收到新的聊天消息通知
onGetAllChatMessage 收到历史聊天消息通知

详细信息

createInstance

创建 Brtm Sdk 实例

createInstance(appId: string)

参数

Name Type Description
appId string appId

详情

  • 所有功能必须先获取实例才可以进行

exitRoom

删除 Brtm Sdk 实例对象

destroyInstance()

监听 Sdk 事件 

on(event, callback)

参数

Name Type Description
event string 事件名称
callback function 回调函数

取消监听 Sdk 事件 

off(event)

参数

Name Type Description
event string 事件名称，传入通配符 '*' 会解除所有事件绑定。

enterRoom

加入房间

enterRoom(params)

参数

Name Type Description
params JSON字符串 进房参数 
{ 
    "roomId": "房间ID", 
    "userSig": "用户进房鉴权码",
    "userInfo": {
        "userName": "", // 用户识别码
        "userId": 2924,
        "userAvatar": "", // 用户头像地址
        "role": "" // 用户角色类型
    }
}

exitRoom

离开房间

exitRoom(params)

enableDocumentService

启用或关闭文档服务

enableDocumentService(paenablerams: boolean)

参数

Name Type Description
enable boolean 启用或关闭文档服务参数, true表示启用，false表示禁用

详情

  • Brtm 的文档共享功能需要先通知服务器启用才可以使用，建议具有权限的人调用此方法

sendMessage

给某个用户发送消息

sendMessage(key: string, msgContent: string, toUserId: string)

参数

Name Type Description
key string 消息类型
msgContent string 消息内容
toUserId string 消息接收者用户ID

sendBroadcastMessage

给房间内所有用户发送广播消息

sendBroadcastMessage(key: string, msgContent: string, withCache: boolean)

参数

Name Type Description
key string 消息类型
msgContent string 消息内容
withCache boolean 服务端是否缓存（用于广播给后进房的用户）

requestBroadcastMessageCache

请求广播消息缓存

requestBroadcastMessageCache(cacheName: string)

参数

Name Type Description
cacheName string 广播缓存标识

clearBroadcastMessageCache

清理广播缓存

clearBroadcastMessageCache(cacheName: string)

参数

Name Type Description
cacheName string 广播缓存标识

getDocumentManager

获取文档管理器 BrtmDocumentManager

getDocumentManager()

详情

  • 所有与文档共享、白板相关的功能通过 BrtmDocumentManager 来完成

getChatManager

获取聊天管理器 BrtmChatManager

getChatManager()

详情

  • 与聊天相关的功能通过 BrtmChatManager 来完成

getUserManager

获取用户管理器 BrtmUserManager

getUserManager()

详情

  • 与用户相关的功能通过 BrtmUserManager 来完成

onError

错误通知

onError: (errorCode: number, errorMessage: string)

参数

Name Type Description
errorCode number 错误码
errorMessage string 错误具体内容

onRoomJoined

进入房间成功通知

onRoomJoined: ()

onLeaveRoom

离开房间成功通知

onLeaveRoom: ()

onMessageReceived

收到某个用户发来的房间消息通知

onMessageReceived: (key: string, content: string, userId: string)

参数

Name Type Description
key string 消息字段名
content string 消息具体内容
userId string 发送消息的用户ID

onBroadcastMessageReceived

收到广播房间消息通知

onBroadcastMessageReceived: (key: string, content: string)

参数

Name Type Description
key string 消息字段名
content string 消息具体内容

onDocumentServiceEnable

房间内的 document 服务是否可用通知

onDocumentServiceEnable: (enable: boolean, userId: string)

参数

Name Type Description
enable boolean 文档服务是否可用
userId string 对应操作的 userid

onWhiteboardPageAdded

增加一页白板的通知

onWhiteboardPageAdded: ()

onWhiteboardPageDeleted

删除一页白板的通知

onWhiteboardPageDeleted: ()

onAllDocumentsReceived

收到所有文档的通知

onAllDocumentsReceived: (docAllRes: brtm.BrtmDocAllRes)

参数

Name Type Description
docAllRes BrtmDocAllRes 所有文档对象

onDocumentAdded

增加 ppt 文档的通知

onDocumentAdded: (doc: brtm.BrtmDocumentItem)

参数

Name Type Description
doc BrtmDocumentItem 文档对象

onDocumentDeleted

删除 ppt 文档的通知

onDocumentDeleted: (docId: string)

参数

Name Type Description
docId string 文档 id

onDocumentUpdated

更新 ppt 文档的通知

onDocumentUpdated: (docId: string, extra?: brtm.DocExtraInfo | null)

参数

Name Type Description
docId string 文档 id
extra BrtmDocExtraInfo 文档额外信息

onPageSelected

文档翻页的通知

onPageSelected: (pageChangeInfo: brtm.PageChangeInfo)

参数

Name Type Description
pageChangeInfo PageChangeInfo

onDocumentListChanged

文档列表改变的通知

onDocumentListChanged: (docId: string)

参数

Name Type Description
docId string 文档 id

onDocumentTypeChanged

动态和静态 ppt 之间的切换的通知

onDocumentTypeChanged: (docId: string)

参数

Name Type Description
docId string 文档 id

onUserListUpdate

用户列表更新通知

onUserListUpdate: (userList: brtm.BrtmUser[])

参数

Name Type Description
userList array BrtmUser 数组

onUserIn

用户进入房间通知

onUserIn: (user: brtm.BrtmUser)

参数

Name Type Description
user BrtmUser BrtmUser 对象

onUserOut

用户退出房间通知

onUserOut: (user: brtm.BrtmUser)

参数

Name Type Description
user BrtmUser BrtmUser 对象

onKickOut

用户被踢出通知

onKickOut: (code: number, message: string)

参数

Name Type Description
code number 错误码
message string 错误信息

onReceiveChatMessage

收到新的聊天消息通知

onReceiveChatMessage: (chatMessage: brtm.BrtmChatMessage)

参数

Name Type Description
chatMessage string 聊天消息

onGetAllChatMessage

收到新的聊天消息通知

onGetAllChatMessage: (chatMessageList: brtm.BrtmChatMessage[])

参数

Name Type Description
chatMessageList array 聊天消息数组
{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论