这是聊天模块,可用于在会议中发送和接收消息。
- RTKChat
.messages- .setMaxTextLimit(limit)
- .updateRateLimits(num, period)
- .sendTextMessage(message, [peerIds])
- .sendCustomMessage(message, [peerIds])
- .sendImageMessage(image, [peerIds])
- .sendFileMessage(file, [peerIds])
- .sendMessage(message, [participantIds])
- .editTextMessage(messageId, message)
- .editImageMessage(messageId, image)
- .editFileMessage(messageId, file)
- .editMessage(messageId, message)
- .deleteMessage(messageId)
- .pin(id)
- .unpin(id)
- .fetchPublicMessages(options)
- .fetchPrivateMessages(options)
- .fetchPinnedMessages(options)
已弃用
类型: RTKChat 的实例属性
设置文本消息的最大字符数限制
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| limit | number |
文本消息的最大字符数限制。 |
类型: RTKChat 的实例方法
| 参数 | 类型 |
|---|---|
| num | number |
| period | number |
向会议室发送聊天文本消息。
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| message | string |
必须发送到会议室的消息。 |
| [peerIds] | Array.<string> |
要发送消息的目标 Peer ID。 |
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| message | CustomMessagePayload |
自定义消息负载。 |
| [peerIds] | Array.<string> |
要发送消息的目标 Peer ID。 |
向会议发送图像消息。
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| image | File | ReactNativeFile |
要发送的图像。 |
| [peerIds] | Array.<string> |
要发送消息的目标 Peer ID。 |
向会议发送文件。
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| file | File | ReactNativeFile |
一个 File 对象。 |
| [peerIds] | Array.<string> |
要发送消息的目标 Peer ID。 |
向会议发送消息。此方法可用于发送文本、图像或文件消息。消息类型由 message 对象中的键 'type' 决定。
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| message | MessagePayload |
包含消息类型和内容的对象。 |
| [participantIds] | Array.<string> |
包含参与者 userId 的数组。 |
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| messageId | string |
要编辑的消息的 ID。 |
| message | string |
更新后的文本消息。 |
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| messageId | string |
要编辑的消息的 ID。 |
| image | File | ReactNativeFile |
更新后的图像文件。 |
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| messageId | string |
要编辑的消息的 ID。 |
| file | File | ReactNativeFile |
更新后的文件。 |
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| messageId | string |
要编辑的消息的 ID。 |
| message | MessagePayload |
更新后的消息负载。 |
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| messageId | string |
要删除的消息的 ID。 |
固定聊天消息
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| id | string |
要固定的消息的 ID |
取消固定聊天消息
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| id | string |
要取消固定的消息的 ID |
使用分页从聊天中获取消息。
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| options | FetchMessageOptions |
用于获取消息的配置选项,包括用于分页的时间戳、限制和方向。 |
使用分页获取当前用户与另一位参与者之间的私聊消息。
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| options | FetchPrivateMessagesOptions |
用于获取私聊消息的配置选项,包括私有 RTKChat ID(参与者的用户 ID)和分页设置。 |
使用分页获取已固定的消息。
类型: RTKChat 的实例方法
| 参数 | 类型 | 描述 |
|---|---|---|
| options | FetchMessageOptions |
用于获取已固定消息的配置选项,包括时间戳、限制和方向。 |