HyphenateChatSDK 3.9.9.1
|
#import <IEMChatManager.h>
聊天相关操作代理协议。 消息都是从本地数据库中加载,不是从服务端加载。
|
required |
发送会话已读回执。
该方法仅适用于单聊会话。
发送会话已读回执会通知服务器将指定的会话未读消息数置为 0。调用该方法后对方会收到 onConversationRead 回调。 对话方(包含多端多设备)将会在回调方法 EMChatManagerDelegate onConversationRead(String, String) 中接收到回调。
为了减少调用次数,我们建议在进入聊天页面有大量未读消息时调用该方法,在聊天过程中调用 sendMessageReadAck 方法发送消息已读回执。
异步方法。
conversationId | 会话 ID。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
添加回调代理。
aDelegate | 实现代理协议的对象。 |
aQueue | 执行代理方法的队列。 |
|
required |
添加 Reaction。
reaction | Reaction 内容。 |
messageId | 消息 ID。 |
completion | 该方法完成的回调。如果有错误会包含错误信息。 |
|
required |
从服务器获取指定群消息的已读回执,即指定的群消息有多少人已读。
异步方法。
aMessageId | 要获取的消息 ID。 |
aGroupId | 要获取回执对应的群 ID。 |
aGroupAckId | 要获取的群回执 ID。 |
aPageSize | 获取消息条数。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
从服务器获取指定会话的消息。
异步方法。
aConversationId | 要获取消息的 Conversation ID。 |
aConversationType | 要获取消息的 Conversation type。 |
aStartMessageId | 起始消息的 ID。 |
direction | EMMessageFetchHistoryDirection 向上或者向下 |
aPageSize | 获取消息条数。(单次限制最大50条) |
aCompletionBlock | 获取消息结束的 callback。 |
|
required |
从服务器获取指定会话的消息。
异步方法。
aConversationId | 要获取消息的 Conversation ID。 |
aConversationType | 要获取消息的 Conversation type。 |
aStartMessageId | 起始消息的 ID。 |
aPageSize | 获取消息条数。 |
aCompletionBlock | 获取消息结束的 callback。 |
|
required |
从本地数据库中删除一个会话。
aConversationId | 会话 ID。 |
aIsDeleteMessages | 是否删除会话中的消息。
|
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
删除一组会话。
aConversations | 会话列表。 |
aIsDeleteMessages | 是否删除会话中的消息。
|
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
删除某个时间点之前的消息。
异步方法。
aTimestamp | 指定的时间点,Unix 时间戳,单位为毫秒。 |
aCompletion | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
删除服务器会话。
aConversationId | 会话 ID。 |
aConversationType | 会话类型。 |
aIsDeleteMessages | 是否同时删除会话中的消息。
|
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
下载消息附件(语音、视频、图片原图、文件)。
SDK 会自动下载语音消息。如果自动下载失败,你可以调用该方法。
异步方法。
aMessage | 消息。 |
aProgressBlock | 附件下载进度回调 block。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
下载缩略图(图片消息的缩略图或视频消息的第一帧图片)。
SDK 会自动下载缩略图。如果自动下载失败,你可以调用该方法下载缩略图。
aMessage | 消息对象。 |
aProgressBlock | 附件下载进度回调 block。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
从服务器获取指定会话的消息。
aConversationId | 要获取消息的 Conversation ID。 |
aConversationType | 要获取消息的 Conversation type。 |
aStartMessageId | 起始消息的 ID。 |
direction | EMMessageFetchHistoryDirection 根据某条消息向上或者向下 |
aPageSize | 获取消息条数。 |
pError | 错误信息。 |
|
required |
从服务器获取指定会话的消息。
aConversationId | 要获取消息的 Conversation ID。 |
aConversationType | 要获取消息的 Conversation type。 |
aStartMessageId | 起始消息的 ID。 |
aPageSize | 获取消息条数。 |
pError | 错误信息。 |
|
required |
获取翻译服务支持的语言。
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
获取所有会话,如果缓存中不存在会从本地数据库中加载。
|
required |
获取一个会话。
aConversationId | 会话 ID。 |
aType | 会话类型。 |
aIfCreate | 如果不存在是否创建。 |
|
required |
获取一个会话。
aConversationId | 会话 ID。 |
aType | 会话类型。 |
aIfCreate | 如果不存在是否创建。 |
isThread | 是否是threadChat类型的会话 |
|
required |
获取一个会话。
aConversationId | 会话 ID。 |
aType | 会话类型。 |
aIfCreate | 如果不存在是否创建。 |
isThread | 是否是threadChat类型的会话 |
isChannel | 是否是channel类型的会话 |
|
required |
从服务器获取所有会话。
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
从本地数据库中获取一个已存在的会话。
aConversationId | 会话 ID。 |
|
required |
获取一个会话中消息附件的本地路径。
删除会话时,会话中的消息附件也会被删除。
aConversationId | 会话 ID。 |
|
required |
获取指定的消息。
aMessageId | 消息 ID。 |
|
required |
分页获取群聊消息的 Reaction 详细列表。
messageId | 消息 ID。 |
reaction | Reaction 内容。 |
cursor | 查询的开始位置。首次调用该方法可传 nil 或 @"" 以 Reaction 创建时间的正序获取。 |
pageSize | 每页期望返回的 Reaction 数量。该值不能超过 100。 |
completion | 该方法完成的回调,返回 Reaction 列表和用于继续获取数据的 cursor。当 cursor 为 nil 时表示已获取全部数据。 |
|
required |
获取消息的 Reaction 列表。
messageId | 消息 ID。 |
groupId | 群组 ID,该参数只在群聊生效。 |
chatType | 会话类型,仅支持单聊( EMChatTypeChat )和群聊(EMChatTypeGroupChat )。 |
completion | 该方法完成的回调。如果有错误会包含错误信息。 |
|
required |
导入一组会话到本地数据库。
aConversations | 会话列表。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
导入一组消息到本地数据库。
aMessages | 消息列表。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
通过关键词从数据库获取消息。
该方法返回的消息按时间顺序排列。
同步方法,会阻塞当前线程。
aKeywords | 关键词。设为 nil 表示忽略该参数。 |
aTimestamp | 参考时间戳。如果该参数设置的时间戳为负数,则从最新消息向前获取。 |
aCount | 获取的消息条数。如果设为小于等于 0,SDK 会将该参数作 1 处理。 |
aSender | 消息发送方。设为 nil 表示忽略该参数。 |
aDirection | 消息搜索方向,详见 MessageSearchDirection 。
|
|
required |
通过关键词从数据库获取消息。
该方法返回的消息按时间逆序返回排列。
aKeywords | 搜索关键词,设为 nil 表示忽略该参数。 |
aTimestamp | 参考时间戳。如果该参数设置的时间戳为负数,则从最新消息向前获取。 |
aCount | 获取的消息条数。如果设为小于等于 0,SDK 会将该参数作 1 处理。 |
aSender | 消息发送方。设为 nil 表示忽略该参数。 |
aDirection | 消息搜索方向,详见 MessageSearchDirection 。
|
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
通过关键词从数据库获取消息。
该方法返回的消息按时间顺序排列。
同步方法,会阻塞当前线程。
aType | 消息类型。 |
aTimestamp | 参考时间戳。如果该参数设置的时间戳为负数,则从最新消息向前获取。 |
aCount | 获取的消息条数。如果设为小于等于 0,SDK 会将该参数作 1 处理。 |
aUsername | 消息发送方。设为 nil 表示忽略该参数。 |
aDirection | 消息搜索方向,详见 MessageSearchDirection 。
|
|
required |
通过关键词从数据库获取消息。
该方法返回的消息按时间顺序排列。
aType | 消息类型。 |
aTimestamp | 参考时间戳。如果该参数设置的时间戳为负数,则从最新消息向前获取。 |
aCount | 获取的消息条数。如果设为小于等于 0,SDK 会将该参数作 1 处理。 |
aUsername | 消息发送方。设为 nil 表示忽略该参数。 |
aDirection | 消息搜索方向,详见 MessageSearchDirection 。
|
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
撤回一条消息。
异步方法。
aMessageId | 消息 ID。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
移除回调代理。
aDelegate | 要移除的代理。 |
|
required |
从会话中删除消息(包括本地存储和服务器存储)。
conversation | 会话对象EMConversation |
messageIds | 要删除消息id字符串数组。 |
completion | 接口回调成功或者失败 |
|
required |
从会话中删除消息(包括本地存储和服务器存储)。
conversation | 会话对象EMConversation |
beforeTimeStamp | 要删除哪一条消息之前的消息时间戳。 |
completion | 接口回调成功或者失败 |
|
required |
删除 Reaction。
reaction | Reaction 内容。 |
messageId | 消息 ID。 |
completion | 该方法完成的回调。如果有错误会包含错误信息。 |
|
required |
举报违规消息
异步方法
aMessageId | 违规消息id |
aTag | 举报类型 |
aReason | 举报原因 |
aCompletion | 执行上报结果 |
|
required |
重新发送消息。
aMessage | 消息对象。 |
aProgressBlock | 附件上传进度回调 block。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
发送群消息已读回执。
异步方法。
aMessageId | 消息 ID。 |
aGroupId | 群组 ID。 |
aContent | 消息内容。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
发送消息。
异步方法。
aMessage | 消息。 |
aProgressBlock | 附件上传进度回调。如果该方法调用失败,会包含调用失败的原因。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
发送消息已读回执。
异步方法。
aMessage | 消息 ID。 |
aUsername | 已读接收方。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
翻译消息。
aMessage | 消息对象。 |
aLanguages | 目标语言. |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
|
required |
更新消息到本地数据库,会话中最新的消息会先更新,消息 ID 不会更新。
aMessage | 消息。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |