Protected
Optional
_eventPrivate
_messageStatic
TAG添加消息监听器。
要添加的消息监听器。
添加 Reaction。
Reaction 的内容。
要添加 Reaction 的消息 ID。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
创建子区。
子区所属群组的所有成员均可调用该方法。
子区创建成功后,会出现如下情况:
单设备登录时,子区所属群组的所有成员均会收到 ChatMessageEventListener#onChatMessageThreadCreated 回调。 你可通过设置 ChatMessageEventListener 监听相关事件。
多端多设备登录时,各设备会收到 ChatMultiDeviceEventListener#onThreadEvent 回调。 你可通过设置 ChatMultiDeviceEventListener 监听相关事件。
要创建的子区的名称。长度不超过 64 个字符。
父消息 ID。
父 ID,即群组 ID。
调用成功时,返回创建的子区对象;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
删除指定会话及其本地历史消息。
会话 ID。
删除会话时是否同时删除本地的历史消息。
- (默认)true
:删除;
- false
:不删除。
会话是否删除成功。
- true
:是;
- false
: 否。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
清除内存和数据库中指定会话中的消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType.
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
删除指定消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
要删除消息的 ID。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
删除指定时间戳之前的所有本地消息。
指定的时间戳,单位为毫秒。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
从本地数据库中删除指定时间段内的消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType.
startTs: 删除消息的起始时间。Unix 时间戳,单位为毫秒。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
解散子区。
只有子区所属群组的群主及管理员可调用该方法。
注意
单设备登录时,子区所属群组的所有成员均会收到 ChatMessageEventListener.onChatMessageThreadDestroyed 回调。 你可通过设置 ChatMessageEventListener 监听子区事件。
多端多设备登录时,设备会收到 ChatMultiDeviceEventListener.onThreadEvent 回调。 你可通过设置 ChatMultiDeviceEventListener 监听子区事件。
子区 ID。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
下载消息的附件。
若附件自动下载失败,也可以调用此方法下载。
要下载附件的消息。
Optional
callback: ChatMessageStatusCallback消息状态变化监听器。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
下载消息的缩略图。
要下载缩略图的消息 ID。只有图片消息和视频消息有缩略图。
Optional
callback: ChatMessageStatusCallback如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
从服务器获取会话列表。
该功能需联系商务开通。开通后,用户默认可拉取 7 天内的 10 个会话(每个会话包含最新一条历史消息)。如需调整会话数量或时间限制请联系商务经理。
会话列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
从服务器获取子区详情。
子区 ID。
若调用成功,返回子区详情;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
分页从服务器端获取指定群组的子区列表。
父 ID,即群组 ID。
开始取数据的游标位置。首次获取数据时传 null
或空字符串,按子区创建时间的倒序获取数据。
每页期望返回的子区数。取值范围为 [1,400]。
若调用成功,返回子区列表;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
获取合并类型消息中的原始消息列表。
合并消息包含 1 条或者多条其它类型消息。
合并类型的消息。
消息 body 里面的原始消息列表。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
分页从服务器获取会话列表。
SDK 按照会话活跃时间(会话的最后一条消息的时间戳)倒序返回会话列表。
若会话中没有消息,则 SDK 按照会话创建时间的倒序返回会话列表。
Optional
cursor: stringOptional
pageSize: number会话列表。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
从服务器分页获取会话列表。
当前页码,从 1 开始。
每页获取的会话数量,取值范围为 [1,20]。
当前用户的会话列表。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
从服务器分页获取群组消息已读回执详情。
发送群组消息已读回执见 {@link #sendConversationReadAck(String)。
消息 ID。
开始的已读回执 ID。如果该参数设置为空字符串或 null
,从服务器接收已读回执时间的倒序开始获取。
每页期望获取群消息已读回执的条数。
已读回执列表和用于下次查询的 cursor。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
分页获取指定会话的历史消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型。详见 ChatConversationType。
Optional
direction?: ChatSearchDirectionOptional
pageOptional
start获取到的消息和下次查询的 cursor。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
根据消息拉取参数配置从服务器分页获取指定会话的历史消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型。详见 ChatConversationType.
Optional
params: { options: 查询历史消息的参数配置类。详见 ChatFetchMessageOptions.
Optional
cursor?: stringOptional
options?: ChatFetchMessageOptionsOptional
page消息列表(不包含查询起始 ID 的消息)和下次查询的 cursor。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
分页从服务器获取当前用户加入的子区列表。
开始获取数据的游标位置。首次调用方法时传 null
或空字符串,按用户加入子区时间的倒序获取数据。
每页期望返回的子区数。取值范围为 [1,400]。
若调用成功,返回子区列表;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
分页从服务器获取当前用户加入指定群组的子区列表。
父 ID,即群组 ID。
开始取数据的游标位置。首次调用方法时传 null
或空字符串,按用户加入子区时间的倒序获取数据。
每页期望返回的子区数。取值范围为 [1,400]。
若调用成功,返回子区列表;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
从服务器批量获取指定子区中的最新一条消息。
要查询的子区 ID 列表,每次最多可传 20 个子区。
若调用成功,返回子区的最新一条消息列表;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
分页获取子区成员。
子区所属群组的所有成员均可调用该方法。
子区 ID。
开始获取数据的游标位置,首次调用方法时传 null
或空字符串,按成员加入子区时间的正序获取数据。
每页期望返回的成员数。取值范围为 [1,400]。
若调用成功,返回子区成员列表;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
分页从服务器获取置顶会话。
SDK 按照会话置顶时间倒序返回。
Optional
cursor: stringOptional
pageSize: number会话列表。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
获取 Reaction 详情。
消息 ID。
Reaction 内容。
Optional
cursor: string开始获取 Reaction 的游标位置。
Optional
pageSize: number每页期望返回的 Reaction 数量。
若调用成功,返回 Reaction 详情。若返回 null
,则所有数据均获取。
若调用失败,则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
获取 Reaction 列表。
消息 ID 列表。
群组 ID,该参数仅在会话类型为群聊时有效。
会话类型。
若调用成功,返回 Reaction 列表;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
查询翻译服务支持的语言。
翻译服务支持的语言列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取本地数据库中所有会话。
该方法会先从内存中获取,如果未找到任何会话,从本地数据库获取。
获取的会话。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
根据会话 ID 和会话类型获取会话。
会话 ID。
会话类型,详见 ChatConversationType。
未找到指定会话时是否创建一个新会话。
true
:是。false
:否。会话。未找到时返回空值。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
Gets the message count of the conversation.
note If the conversation object does not exist, this method will create it.
The conversation ID.
The conversation type. See ChatConversationType.
The message count.
A description of the exception. See ChatError.
获取指定会话中的未读消息数。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
未读消息数。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取指定会话的最新一条消息。
该操作不影响未读消息数量。
SDK 会先从内存中获取。如果没有找到会从本地数据库中获取,并放到内存中。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
获取到的消息。如果没有找到返回 undefined
。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取指定会话最新收到的一条消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
消息实例。如果没有找到返回 undefined
。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
从本地数据库获取指定 ID 的消息对象。
消息 ID。
获取的消息对象。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取本地子区详情。
子区 ID。
若调用成功,返回子区详情;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
从本地数据库获取指定会话在一段时间内的消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
搜索起始时间戳,单位为毫秒。
搜索结束时间戳,单位为毫秒。
消息查询方向,详见 ChatSearchDirection。
ChatSearchDirection.UP
:按消息中的时间戳 (sortMessageByServerTime) 的倒序加载。ChatSearchDirection.DOWN
:按消息中的时间戳 (sortMessageByServerTime) 的顺序加载。获取的最大消息数量。取值范围为 [1,400]。
消息列表。若未获取到消息,返回空列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
从本地数据库获取指定会话中一定数量的消息。
注意 获取到的消息也会放入到内存中。 注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
开始消息 ID。若该参数设为空或 null
,SDK 按服务器接收消息时间的倒序加载消息。
消息查询方向,详见 ChatSearchDirection。
ChatSearchDirection.UP
:按消息中的时间戳 (sortMessageByServerTime) 的倒序加载。ChatSearchDirection.DOWN
:按消息中的时间戳 (sortMessageByServerTime) 的顺序加载。获取的最大消息数量。取值范围为 [1,400]。
消息列表。若未获取到消息,返回空列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
从本地数据库获取会话中的指定用户在一定时间段内发送的特定消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
查询的关键字。
消息查询方向,详见 ChatSearchDirection。
ChatSearchDirection.UP
:按消息中的时间戳 (sortMessageByServerTime) 的倒序加载。ChatSearchDirection.DOWN
:按消息中的时间戳 (sortMessageByServerTime) 的顺序加载。搜索的开始时间戳,单位为毫秒。
获取的最大消息数量。取值范围为 [1,400]。
Optional
sender: string消息发送者,该参数也可以在搜索群组消息和聊天室消息时使用。
消息列表。若未获取到消息,返回空列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
从本地数据库获取会话中的指定用户发送的某些类型的消息。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
消息类型。详见 ChatMessageType。
消息查询方向,详见 ChatSearchDirection。
ChatSearchDirection.UP
:按消息中的时间戳 (sortMessageByServerTime) 的倒序加载。ChatSearchDirection.DOWN
:按消息中的时间戳 (sortMessageByServerTime) 的顺序加载。搜索的起始时间戳,单位为毫秒。
获取的最大消息数量。
Optional
sender: string消息发送方。该参数也可以在搜索群组消息或聊天室消息时使用。
消息列表。若未获取到,返回空列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取指定消息的 Reaction 列表。
消息 ID。
若调用成功,则返回 Reaction 列表;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
根据指定会话 ID 获取本地子区会话对象。
会话 ID。
未找到会话时是否自动创建该会话:
true
: 是;false
: 否。子区会话实例。如果未找到会话,SDK 返回空值。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
获取未读消息数。
未读消息数。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
获取群组消息的已读人数。
消息 ID。
若调用成功,返回群组消息的已读人数;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
将消息导入本地数据库。
你只能将你发送或接收的消息导入本地数据库。
要导入的消息列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
在本地会话中插入一条消息。
例如,收到一些推送消息后,可以构建消息,写入会话。若该消息已存在(msgId 或 localMsgId 已存在),该插入操作失败。
消息会根据消息里的 Unix 时间戳插入本地数据库,SDK 会更新会话的 latestMessage
等属性。
要插入的消息。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
子区 ID。
若调用成功,返回子区详情 ChatMessageThread;失败则抛出异常。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
退出子区。
子区中的所有成员均可调用该方法。
多设备登录情况下,注意以下几点:
各设备会收到 ChatMultiDeviceEventListener.onThreadEvent 回调。
你可通过设置 ChatMultiDeviceEventListener 监听相关事件。
要退出的子区的 ID。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
将所有的会话都设成已读。
该方法仅对本地会话有效。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
将所有消息标为已读。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
将指定消息标为已读。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
消息ID。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
修改文本消息。
调用该方法修改消息内容后,本地和服务端的消息均会修改。
调用该方法只能修改单聊和群聊中的文本消息,不能修改聊天室消息。
修改消息 ID。
文本消息 body。详见 ChatTextMessageBody。
修改后的消息。 详见 ChatMessageBody。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
Private
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
on设置会话是否置顶。
会话 ID.
是否置顶。
true
:置顶;false
: 取消置顶。如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
撤回发送成功的消息。
消息 ID。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
删除服务端的指定会话及其历史消息。
会话 ID。
会话类型,详见 ChatConversationType。
删除会话时是否同时删除历史消息。
true
:是;false
: 否。如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
移除子区成员。
只有子区所属群主、群管理员及子区创建者可调用该方法。
被移出的成员会收到 ChatMessageEventListener.onChatMessageThreadUserRemoved 回调。
你可通过设置 ChatMessageEventListener 监听子区事件。
子区 ID。
被移出子区的成员的用户 ID。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
移除消息监听器。
要移除的消息监听器。
根据消息 ID 单向删除漫游消息
注意 调用该方法,如果会话对象不存在则创建。
会话ID。
会话类型。
将要删除的消息ID列表。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
根据消息 时间戳 单向删除漫游消息
注意 调用该方法,如果会话对象不存在则创建。
会话ID。
会话类型。
UNIX 时间戳,单位为毫秒。若消息的 UNIX 时间戳小于设置的值,则会被删除。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError。
删除 Reaction。
要删除的 Reaction。
添加了该 Reaction 的消息 ID。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
举报消息。
要举报的消息 ID。
非法消息的标签。你需要填写自定义标签,例如涉政
或广告
。
举报原因。你需要自行填写举报原因。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
重发消息。
需要重发的消息。
消息状态监听器。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
从本地数据库获取指定会话中包含特定关键字的消息。
查询关键字。
查询的起始消息 Unix 时间戳,单位为毫秒。该参数设置后,SDK 从指定时间戳的消息开始,按消息搜索方向获取。 如果该参数设置为负数,SDK 从当前时间开始搜索。
每次获取的最大消息数。取值范围为 [1,400]。
单聊或群聊中的消息发送方的用户 ID。若设置为 null
或空字符串,SDK 将在整个会话中搜索消息。
消息搜索方向。详见 ChatSearchDirection.
- (Default) ChatSearchDirection.UP
: 按照消息中的时间戳的逆序查询
- ChatSearchDirection.DOWN
: 按照消息中的时间戳的正序查询。
消息列表(不包含查询起始时间戳对应的消息)。若未查找到任何消息,返回空列表。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
发送会话的已读回执。
注意
该方法仅适用于单聊会话。
该方法通知服务器将此会话未读数设置为 0
,消息发送方(包含多端多设备)将会收到 ChatMessageEventListener.onConversationRead 回调。
会话 ID。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
发送群消息已读回执。
Warning
true
时才会生效。消息 ID。
群组 ID。
Optional
opt: { 扩展信息。用户通过定义关键字指定动作或命令。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
要发送的消息,必填。
Optional
callback: ChatMessageStatusCallback消息状态监听器。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
发送消息的已读回执。
该方法只针对单聊会话。
注意
该方法只有在 ChatOptions.requireAck 为 true
时才生效。
若发送群消息已读回执,详见 sendGroupMessageReadAck。
推荐进入会话页面时调用 sendConversationReadAck,其他情况下调用该方法以减少调用频率。
需要发送已读回执的消息。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
设置会话的扩展属性。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
扩展信息。可添加自定义扩展信息。
翻译一条文本消息。
要翻译的文本消息。
目标语言。
译文。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
修改子区名称。
只有子区所属群主、群管理员及子区创建者可调用该方法。
子区所属群组的成员会收到 ChatMessageEventListener.onChatMessageThreadUpdated 回调。
你可通过设置 ChatMessageEventListener 监听子区事件。
子区 ID。
子区的新名称。长度不超过 64 个字符。
如果有异常会在此抛出,包括错误码和错误信息,详见 ChatError.
更新本地数据库的消息。
消息更新后,消息 ID 不会修改,SDK 会自动更新会话的 latestMessage
等属性。
注意 调用该方法,如果会话对象不存在则创建。
会话 ID。
会话类型,详见 ChatConversationType。
要更新的消息的 ID。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
更新本地消息。
该方法会同时更新本地内存和数据库中的消息。
更新后的消息。
如果有异常会在这里抛出,包含错误码和错误描述,详见 ChatError。
Static
Protected
_callStatic
Protected
checkStatic
Private
handleOptional
callback: ChatMessageStatusCallbackStatic
Private
handleOptional
callback: ChatMessageStatusCallbackStatic
Protected
handleOptional
callback: ChatGroupFileStatusCallbackStatic
Protected
handleOptional
callback: ChatMessageStatusCallbackStatic
Private
handleOptional
callback: ChatMessageStatusCallbackStatic
Private
handleOptional
callback: ChatMessageStatusCallbackGenerated using TypeDoc
聊天管理类,该类负责收发消息、管理会话(加载,删除等)、下载消息附件等。
发送文文本消息示例如下: