Web

Chat

Index

on	one	pull
send	sendTo	revoke

Methods

---

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

// 收到消息
on(type: "message-received", listener: typeof chat_event_message-revoked, options?: EmitterOptions): this

参数

Name	Type	Description
type	"message-revoked"	事件类型
listener	typeof client_event_message-revoked	监听函数
options?	EmitterOptions	监听选项

返回

• this

// 收到私聊消息
on(type: "message-whisper-received", listener: typeof client_event_message-whisper-received, options?: EmitterOptions): this

参数

Name	Type
type	"message-whisper-received"
listener	typeof client_event_message-whisper-received
options?	EmitterOptions

返回

• this

// 收到撤回消息
on(type: "message-revoked", listener: typeof client_event_message_received, options?: EmitterOptions): this

参数

Name	Type
type	"message-revoked"
listener	typeof client_event_message-revoked
options?	EmitterOptions

返回

• this

on(type: string, listener: Function, options?: EmitterOptions): this

参数

Name	Type
type	"string"
listener	typeof client_string
options?	EmitterOptions

返回

• this

---

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

one(type: "message-received", listener: typeof chat_event_message_received, options?: EmitterOptions): this

参数

Name	Type	Description
type	"message-received"	事件类型
listener	typeof chat_event_message-received	监听函数
options	EmitterOptions	监听选项

返回

• this

one(type: "message-whisper-received", listener: typeof client_event_message-whisper-received, options?: EmitterOptions): this

参数

Name	Type
type	"message-whisper-received"
listener	typeof client_event_message-whisper-received
options?	EmitterOptions

返回

• this

one(type: "message-revoked", listener: typeof client_event_message_received, options?: EmitterOptions): this

参数

Name	Type
type	"message-revoked"
listener	typeof client_event_message-revoked
options?	EmitterOptions

返回

• this

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

参数

Name	Type
type	"string"
listener	typeof client_string
options?	EmitterOptions

返回

• this

---

pull
拉取消息

pull(channel: string, next?: number, count?: number): Promise‹object›

参数

Name	Type	Description
channel	string	拉取频道
next?	number	拉取锚点，表示取当前锚点之前的聊天 默认 -1 表示从最新的聊天开始往前取
count?	number	拉取数量，默认 10，最大 30

返回

• Promise‹object›

• Object

  • next 下一次锚点
  • 'channel' 频道
  • hasMore 是否还有未拉取的消息
  • messageList 消息列表

---

send
发送聊天消息

send(message: ChatMessageData): Promise‹ChannelMessage›

参数

Name	Type	Description
message	ChatMessageData	消息数据

返回

• Promise‹ChannelMessage›(服务器返回的聊天数据)

---

sendTo
发送私聊消息

sendTo(to: UserId, message: ChatMessageData): Promise‹ChannelMessage›

参数

Name	Type	Description
to	UserId	私聊用户 id
message	ChatMessageData	消息数据

返回

• Promise‹ChannelMessage›(服务器返回的聊天数据)

---

revoke
撤回

revoke(id: string, fromId: UserId): boolean

参数

Name	Type	Description
id	string	消息 id
fromId	UserId	撤回的消息来自于谁

返回

• boolean(是否撤回成功)

chatEvents

Index

---

• MESSAGE_RECEIVED
• MESSAGE_REVOKED
• MESSAGE_WHISPER_RECEIVED

Variables

---

收到聊天消息

client.on('message-received', (event) => {
});

---

收到撤回消息

client.on('message-revoked', (event) => {
});

---

收到私聊消息

client.on('message-whisper-received', (event) => {
});