Harmony

Implements

---

• client

Properties

---

• 聊天模块: chat
• 文档模块: document
• user 模块: user

Methods

---

创建与销毁
(async) destroy	销毁 Client 实例

房间相关
(async) join	加入房间
(async) leave	离开房间

消息相关
(async) sendMessage	发送一对一消息
onMessage	设置单播消息监听, 支持链式调用, 支持命名空间
offMessage	取消单播消息监听, 支持链式调用, 支持命名空间
(async) sendBroadcastMessage	发送广播消息
onBroadcastMessage	设置广播消息监听, 支持链式调用, 支持命名空间
offBroadcastMessage	取消广播消息监听, 支持链式调用, 支持命名空间
(async) getCachedBroadcastMessage	获取缓存的广播消息

文档相关
(async) enableDocumentAbility	开启文档
(async) disableDocumentAbility	关闭文档
createDocUploader	创建文档上传实例
getAbilities	获取文档开启状态

其他
fire	触发一个事件
on	设置事件监听
one	设置一次事件监听
off	取消事件监听

Methods

---

destroy
销毁 Client 实例

destroy(): Promise‹void›

返回

• Promise‹void›

---

join
加入房间

join(roomId: string, userId: number, sig: string, joinConfig: JoinConfig): Promise‹any›

参数

Name	Type	Description
roomId	string	房间 id
userId	number	用户 id
sig	string	签名 参考SDK 动态授权
joinConfig	JoinConfig	进房间配置项

返回

• Promise‹any›

---

leave
退出房间

leave(): Promise‹any›

返回

• Promise‹any›

---

sendMessage
发送消息（一对一消息）

sendMessage(userId: number, message_type: string, message: any): Promise‹void›

参数

Name	Type	Description
userId	number	指定接收 user 的 id
message_type	string	消息类型
message	any	消息内容

返回

• Promise‹void›

---

onMessage
设置单播消息监听,支持链式调用,支持命名空间

onMessage(message_type: string, listener: Function): Client

参数

Name	Type	Description
message_type	string	消息类型或者命名空间
listener?	Function	监听函数

返回

• Client

---

offMessage
取消单播消息监听,支持链式调用,支持命名空间

offMessage(message_type: string, listener?: Function): Client

参数

Name	Type	Description
message_type	string	消息类型或者命名空间
listener?	function	监听函数

返回

• Client

---

sendBroadcastMessage
发送广播消息（一对多消息）

sendBroadcastMessage(message_type: string, message: any, options?: BroadcastMessageOptions): Promise‹void›

参数

Name	Type	Description
message_type	string	消息类型
message	any	消息内容
options?	BroadcastMessageOptions	广播消息配置项

返回

• Promise‹void›

---

onBroadcastMessage
设置广播消息监听,支持链式调用,支持命名空间

onBroadcastMessage(message_type: string, listener: Function): Client

参数

Name	Type	Description
message_type	string	消息类型或者命名空间
listener?	Function	监听函数

返回

• Client

---

offBroadcastMessage
取消广播消息监听,支持链式调用,支持命名空间

offBroadcastMessage(message_type: string, listener?: Function): Client

参数

Name	Type	Description
message_type	string	消息类型或者命名空间
listener?	Function	监听函数

返回

• Client

---

getCachedBroadcastMessage
获取缓存的广播消息（只能用于设置缓存了的广播消息）

getCachedBroadcastMessage(message_type: string): Promise‹object›

参数

Name	Type	Description
message_type	string	消息类型

返回

• Promise‹object›

---

enableDocumentAbility
开启文档功能

enableDocumentAbility(): Promise‹void›

返回

• Promise‹void›

---

disableDocumentAbility
关闭文档功能

disableDocumentAbility(): Promise‹void›

返回

• Promise‹void›

---

createDocUploader
创建文档上传实例

createDocUploader(options: DocUploaderOptions): DocUploader

参数

Name	Type	Description
options	DocUploaderOptions	DocUploaderOptions

返回

• DocUploader

---

getAbilities
获取当前功能开启状态

getAbilities(): object

返回

• object
• document: boolean = this.canUseDocument()

---

getCachedBroadcastMessage
获取缓存的广播消息（只能用于设置缓存了的广播消息）

getCachedBroadcastMessage(message_type: string): Promise‹object›

参数

Name	Type	Description
message_type	string	消息类型

返回

• Promise‹object›

---

fire
触发一个事件

fire(type: string, data?: any): void

参数

Name	Type	Description
type	string	事件类型
data?	any	事件数据

返回

• void

---

on
设置事件监听，支持链式调用支持命名空间 type.namespace，使用 . 来分隔 type 和 namespace

on(type: "user-kicked", listener: typeof client_event_user_kicked, options?: EmitterOptions): this

参数

Name	Type	Description
type	"user-kicked"	事件类型
listener	typeof client_event_user_kicked	监听函数
options?	EmitterOptions	监听选项

返回

• this

---

one
设置一次事件监听

one(type: string, listener: Function, options: EmitterOptions): this

参数

Name	Type	Default	Description
type	string	-	事件类型
listener	Function	-	监听函数
options	EmitterOptions	{}	监听选项

返回

• this

---

off
取消事件监听,支持链式调用

off(type: string, listener?: Function): this

参数

Name	Type	Description
type	string	事件类型或者命名空间 - 如果传入命名空间则解绑此命名空间的所有回调 - 如果不传则解绑所有设置过的回调
listener?	Function	绑定函数 - 如果不传则解绑指定 type 的所有回调，否则只解绑指定 type 和 listener 的回调

返回

• this

ClientEvents

---

Index

---

• USER_KICKED
• CLIENT_BANNED
• BRTM_ABILITIES_CHANGED
• MESSAGE_CHANNEL_OPENED
• ERROR

Variables

---

用户被踢出房间通知，被管理员踢出

client.on('user-kicked', () => {
  console.log('你已被踢出！');
});

---

用户被踢出房间通知，其他端以相同的 user_id 进入了房间

client.on('client-banned', () => {
   console.log('你已被踢出！');
});

---

rtm sdk 功能权限改变

client.on('rtm-abilities-changed', (event) => {

});

---

聊天通道已连接

client.on('message-channel-opened', (event) => {

});

---

错误
• ERROR = "error"