NIMSDK-AOS  10.11.10
MsgService.java
浏览该文件的文档.
1 package com.netease.nimlib.sdk.msg;
2 
3 import android.util.Pair;
4 import androidx.annotation.NonNull;
5 import com.netease.nimlib.NimNosSceneKeyConstant;
6 import com.netease.nimlib.apt.annotation.NIMService;
51 import java.util.ArrayList;
52 import java.util.List;
53 import java.util.Map;
54 import java.util.Set;
55 
56 /**
57  * 云信消息服务接口类,提供消息发送、消息查询、历史消息、消息扩展功能、获取未读数、已读回执、会话列表等相关接口。
58  */
59 @NIMService("消息服务")
60 public interface MsgService {
61 
62  /**
63  * 当前无聊天对象。
64  *
65  * 消息列表界面有消息提醒,无状态栏消息通知。
66  *
67  */
68  String MSG_CHATTING_ACCOUNT_ALL = "all";
69 
70  /**
71  * 当前无聊天对象。
72  *
73  * @see #setChattingAccount(String, com.netease.nimlib.sdk.msg.constant.SessionTypeEnum)
74  * 消息列表界面有消息提醒,有状态栏消息通知。
75  */
76  String MSG_CHATTING_ACCOUNT_NONE = null;
77 
78  /**
79  * 发送消息。
80  *
81  * 该方法为异步。如需更新发送进度,请调用 {@link MsgServiceObserve#observeMsgStatus}。
82  *
83  * @par 使用前提:
84  * 已调用 MessageBuilder#createXXMessage 创建一条消息。
85  *
86  * @param msg 待发送的 IMMessage 消息体,由 {@link MessageBuilder} 构造。
87  * @param resend true 表示消息发送失败后重发;false 表示消息发送失败后不重发。
88  * @return InvocationFuture<Void> 可设置回调函数:消息发送成功后返回通知;消息发送失败后返回具体错误码。
89  */
90  InvocationFuture<Void> sendMessage(IMMessage msg, boolean resend);
91 
92  /**
93  * 发送消息。
94  *
95  * 该方法为异步。如需更新发送进度,请调用 {@link MsgServiceObserve#observeMsgStatus}。
96  *
97  * @par 使用前提:
98  * 已调用 MessageBuilder#createXXMessage 创建一条消息。
99  *
100  * @param msg 待发送的 IMMessage 消息体,由 {@link MessageBuilder} 构造。
101  * @param resend true 表示消息发送失败后重发;false 表示消息发送失败后不重发。
102  * @param option 消息发送选项
103  * @return InvocationFuture<Void> 可设置回调函数:消息发送成功后返回通知;消息发送失败后返回具体错误码。
104  */
105  InvocationFuture<Void> sendMessage(IMMessage msg, boolean resend, MsgSendOption option);
106 
107  /**
108  * 停止流式消息输出
109  * @param msg 需要停止输出的流式消息
110  * @param params 停止输出的配置参数,确定停止输出的操作类型
111  * @return InvocationFuture<Void> 可设置回调函数:停止成功后返回通知;停止失败后返回具体错误码。
112  */
113  InvocationFuture<Void> stopAIStreamMessage(IMMessage msg, NIMMessageAIStreamStopParams params);
114 
115  /**
116  * 重新输出数字人消息
117  * @param msg 需要重新输出的数字人消息
118  * @param params 重新输出的配置参数,确定重新输出的操作类型
119  * @return InvocationFuture<Void> 可设置回调函数:重新输出调用成功后返回通知;重新输出调用失败后返回具体错误码。
120  */
121  InvocationFuture<Void> regenAIMessage(IMMessage msg, NIMMessageAIRegenParams params);
122 
123  /**
124  * 回复消息。
125  *
126  * 该方法为异步。如需更新发送进度,请调用 {@link MsgServiceObserve#observeMsgStatus}。
127  *
128  * @par 使用前提:
129  * - 已收到一条消息。
130  * - 已调用 MessageBuilder#createXXMessage 构建一条消息。
131  *
132  * @param msg 待发送的 IMMessage 消息体,由 {@link MessageBuilder} 构造。
133  * @param replyMsg 被回复的 IMMessage 消息体,由 {@link MessageBuilder} 构造。
134  * @param resend true 表示消息回复失败后重发;false 表示消息回复失败后不重发。
135  * @param option 消息发送选项
136  * @return InvocationFuture<Void> 可设置回调函数:消息回复成功后返回通知;消息回复失败后返回具体错误码。
137  */
138  InvocationFuture<Void> replyMessage(IMMessage msg, IMMessage replyMsg, boolean resend,MsgSendOption option);
139 
140  /**
141  * 回复消息。
142  *
143  * 该方法为异步。如需更新发送进度,请调用 {@link MsgServiceObserve#observeMsgStatus}。
144  *
145  * @par 使用前提:
146  * - 已收到一条消息。
147  * - 已调用 MessageBuilder#createXXMessage 构建一条消息。
148  *
149  * @param msg 待发送的 IMMessage 消息体,由 {@link MessageBuilder} 构造。
150  * @param replyMsg 被回复的 IMMessage 消息体,由 {@link MessageBuilder} 构造。
151  * @param resend true 表示消息回复失败后重发;false 表示消息回复失败后不重发。
152  * @return InvocationFuture<Void> 可设置回调函数:消息回复成功后返回通知;消息回复失败后返回具体错误码。
153  */
154  InvocationFuture<Void> replyMessage(IMMessage msg, IMMessage replyMsg, boolean resend);
155 
156 
157  /**
158  * 发送文件。该方法为异步。
159  *
160  * @par 使用前提:
161  * 已调用 {@link MessageBuilder#createFileAttachment} 创建文件附件。
162  *
163  * @param attachment 待发送的文件附件对象 FileAttachment,由 {@link MessageBuilder} 构造。
164  *
165  * @return AbortableFuture<FileAttachment> 可设置回调函数:文件发送成功后返回 FileAttachment,可随时中断发送;文件发送失败后返回具体错误码。
166  */
167  AbortableFuture<FileAttachment> sendFile(FileAttachment attachment);
168 
169  /**
170  * 插入消息到本地数据库,但不发送到服务器端。该方法为异步。
171  *
172  * 该方法将消息插入到本地数据库后,SDK 会触发 {@link MsgServiceObserve#observeReceiveMessage} 通知到 UI 层。
173  *
174  * @param msg 待插入的消息体 IMMessage,由 {@link MessageBuilder} 构造。
175  * @param fromAccount 消息发送方账号(accid)
176  * @return InvocationFuture<Void> 可设置回调函数:消息插入成功后返回通知;消息插入失败后返回具体错误码。
177  */
178  InvocationFuture<Void> insertLocalMessage(IMMessage msg, String fromAccount);
179 
180  /**
181  * 保存消息到本地数据库,但不发送到服务器端。该方法为异步。<br>
182  * 该方法用于第三方应用保存本地提醒类的消息。<br>
183  * 将消息保存到数据库后,如需通知 UI 层更新,可将 notify 设置为 true,此时会触发 {@link MsgServiceObserve#observeReceiveMessage} 通知。
184  *
185  * @param msg 待保存的消息体 IMMessage,由 {@link MessageBuilder} 构造。
186  * @param notify 是否需要通知
187  * @return InvocationFuture<Void> 可设置回调函数:消息保存成功后返回通知;消息保存失败后返回具体错误码。
188  */
189  InvocationFuture<Void> saveMessageToLocal(IMMessage msg, boolean notify);
190 
191  /**
192  * 保存消息到本地数据库,但不发送到服务器端。该方法为异步。<br>
193  * 该方法用于第三方应用保存本地提醒类的消息。<br>
194  * 将消息保存到数据库后,如需通知 UI 层更新,可将 notify 设置为 true,此时会触发 {@link MsgServiceObserve#observeReceiveMessage} 通知。
195  *
196  * @param msg 待保存的消息体 IMMessage,由 {@link MessageBuilder} 构造。
197  * @param notify 是否需要通知
198  * @param time 待保存的消息时间戳,您可以使用 {@link NIMMessage#getTime()} 方法获取消息时间戳。
199  * @return InvocationFuture<Void> 可设置回调函数:消息保存成功后返回通知;消息保存失败后返回具体错误码。
200  */
201  InvocationFuture<Void> saveMessageToLocalEx(IMMessage msg, boolean notify, long time);
202 
203  /**
204  * 手动下载附件。
205  *
206  * @par 使用场景:
207  * 自动下载附件失败时,可调用该方法手动下载。
208  *
209  * @param msg 附件所在的消息体 IMMessage,由 {@link MessageBuilder} 构造。
210  * @param thumb 是否仅下载缩略图。true 代表仅下载缩略图;false 代表下载缩略图和原文件。该参数仅对图片和视频类消息有效。
211  * @return AbortableFuture<Void> 可设置回调函数,随时中止操作:附件下载成功后返回通知;附件下载失败后返回具体错误码。
212  */
213  AbortableFuture<Void> downloadAttachment(IMMessage msg, boolean thumb);
214 
215  /**
216  * 通过 uuid 批量获取本地历史消息。该方法为同步。
217  *
218  * @param uuids 消息的 uuid 列表
219  * @return IMMessage 列表
220  */
221  List<IMMessage> queryMessageListByUuidBlock(List<String> uuids);
222 
223  /**
224  * 通过 uuid 批量获取本地历史消息。该方法为异步。
225  *
226  * @param uuids 消息的 uuid 列表
227  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:获取成功后返回消息列表;获取失败后返回具体错误码。
228  */
229  InvocationFuture<List<IMMessage>> queryMessageListByUuid(List<String> uuids);
230 
231  /**
232  * 通过 ServerId 批量获取本地历史消息。该方法为同步。
233  *
234  * @param serverIds 消息的 ServerId 列表,一个 ServerId 可能对应多条消息。
235  * @return IMMessage 列表
236  */
237  List<IMMessage> queryMessageListByServerIdBlock(List<String> serverIds);
238 
239  /**
240  * 根据消息类型从后向前查询本地历史消息。该方法为异步。
241  *
242  * @param msgTypeEnum 消息类型
243  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),查询方向为从后往前。
244  * @param limit 查询结果的条数限制,必须大于 0
245  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
246  */
247  InvocationFuture<List<IMMessage>> queryMessageListByType(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit);
248 
249  /**
250  * 根据消息类型从前向后查询本地历史消息。该方法为异步。
251  *
252  * @param maxTime 查询起始时间(不包含),查询方向为从前向后,为空则表示查询所有历史消息。
253  * @param msgTypeEnum 消息类型
254  * @param limit 查询结果的条数限制,必须大于 0。
255  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
256  */
257  InvocationFuture<List<IMMessage>> queryMessageListByType(MsgTypeEnum msgTypeEnum, Long maxTime,
258  int limit);
259 
260  /**
261  * 根据消息子类型查询本地历史消息。该方法为同步。
262  *
263  * @param msgTypeEnum 消息类型
264  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。
265  * @param limit 查询结果的条数限制
266  * @param subtype 消息子类型
267  * @return IMMessage 列表
268  */
269  List<IMMessage> queryMessageListBySubtypeBlock(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit, int subtype);
270 
271  /**
272  * 根据消息子类型查询本地历史消息。该方法为异步。
273  *
274  * @param msgTypeEnum 消息类型
275  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。
276  * @param limit 查询结果的条数限制
277  * @param subtype 消息子类型
278  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
279  */
280  InvocationFuture<List<IMMessage>> queryMessageListBySubtype(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit, int subtype);
281 
282  /**
283  * @deprecated 该方法已废弃,请使用 {@link #queryMessageListEx(IMMessage, QueryDirectionEnum, int, boolean)} 来替代。<br>
284  * 查询指定聊天对象的本地历史消息。该方法为异步。<br>
285  * 该方法按照消息记录时间先后倒序查询,查询条件为 "ORDER BY time desc limit ${limit} offset ${offset}"。<br>
286  *
287  * @param account 待查询的聊天对象帐号(个人帐号或群组 ID)
288  * @param sessionType 聊天对象类型(单聊或群聊)
289  * @param offset 查询偏移量
290  * @param limit 查询列表长度限制
291  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回倒序的消息列表;查询失败后返回具体错误码。
292  *
293  */
294  InvocationFuture<List<IMMessage>> queryMessageList(String account, SessionTypeEnum sessionType, long offset,
295  int limit);
296 
297  /**
298  * 根据锚点和方向查询本地历史消息。该方法为异步。<br>
299  *
300  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。
301  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
302  * @param limit 查询结果的条数限制
303  * @param asc 查询结果的排序规则,true 代表按照时间升序排列,false 代表按照时间降序排列。
304 
305  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
306  */
307  InvocationFuture<List<IMMessage>> queryMessageListEx(IMMessage anchor, QueryDirectionEnum direction, int limit,
308  boolean asc);
309 
310  /**
311  * 根据锚点和方向查询本地历史消息。该方法为同步。<br>
312  *
313  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。
314  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
315  * @param limit 查询结果的条数限制
316  * @param asc 查询结果的排序规则,true 代表按照时间升序排列,false 代表按照时间降序排列。
317  * @return IMMessage 列表
318  */
319  List<IMMessage> queryMessageListExBlock(IMMessage anchor, QueryDirectionEnum direction, int limit,
320  boolean asc);
321 
322  /**
323  * 查询指定时间段的本地历史消息。该方法为异步。<br>
324  *
325  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。
326  * @param toTime 查询截止时间点,若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
327  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
328  * @param limit 查询结果的条数限制
329  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
330  */
331  InvocationFuture<List<IMMessage>> queryMessageListExTime(IMMessage anchor, long toTime,
332  QueryDirectionEnum direction, int limit);
333 
334  /**
335  * @deprecated 该方法已废弃,请使用 queryMessageListByTypesV2 来替代。<br>
336  * 根据消息类型查询指定时间段的本地历史消息。该方法为异步。<br>
337  * @param types 消息类型列表,null 表示所有消息类型,同 {@link MsgService#queryMessageListExTime}
338  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。
339  * @param toTime 查询截止时间点,若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
340  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
341  * @param limit 查询结果的条数限制
342  * @param asc 查询结果的排序规则,true 代表按照时间升序排列,false 代表按照时间降序排列。
343  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
344  *
345  */
346  @Deprecated
347  InvocationFuture<List<IMMessage>> queryMessageListByTypes(List<MsgTypeEnum> types, IMMessage anchor, long toTime,
348  QueryDirectionEnum direction, int limit, boolean asc);
349 
350  /**
351  * 根据消息类型查询指定时间段的本地历史消息。该方法为异步。<br>
352  * @param types 消息类型列表,null 表示所有消息类型,同 {@link MsgService#queryMessageListExTime}
353  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。单位毫秒,不能为 null。
354  * @param toTime 查询截止时间点,若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
355  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
356  * @param limit 查询结果的条数限制
357  * @param asc 查询结果的排序规则,true 代表按照时间升序排列,false 代表按照时间降序排列。
358  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
359  *
360  */
361  InvocationFuture<List<IMMessage>> queryMessageListByTypesV2(List<MsgTypeEnum> types, IMMessage anchor, long toTime,
362  QueryDirectionEnum direction, int limit, boolean asc);
363 
364  /**
365  * 获取指定会话中有漫游消息标记的时间戳。该方法为异步。
366  *
367  * @param sessionId 会话 ID
368  * @param sessionType 会话类型
369  * @return InvocationFuture<Long> 可设置回调函数:获取成功后返回时间戳,如果无漫游消息标记则返回 0L;获取失败后返回具体错误码。
370  */
371  InvocationFuture<Long> queryRoamMsgHasMoreTime(String sessionId, SessionTypeEnum sessionType);
372 
373  /**
374  * 获取指定会话中有漫游消息标记的消息的时间戳。该方法为同步。
375  *
376  * @param sessionId 会话 ID
377  * @param sessionType 会话类型
378  * @return 如果有漫游消息标记则返回时间戳;如果无漫游消息标记则返回 0L。
379  */
380  long queryRoamMsgHasMoreTimeBlock(String sessionId, SessionTypeEnum sessionType);
381 
382  /**
383  * 获取指定会话中有漫游消息标记的消息的 ServerId。该方法为异步。
384  *
385  * @param sessionId 会话 ID
386  * @param sessionType 会话类型
387  * @return InvocationFuture<Long> 可设置回调函数:获取成功后返回 ServerId,如果无漫游消息标记则返回 0L;获取失败后返回具体错误码。
388  */
389  InvocationFuture<Long> queryRoamMsgHasMoreTagServerId(String sessionId, SessionTypeEnum sessionType);
390 
391 
392  /**
393  * 获取指定会话中有漫游消息标记的消息的 ServerId。该方法为同步。
394  *
395  * @param sessionId 会话 ID
396  * @param sessionType 会话类型
397  * @return 如果有漫游消息标记则返回 ServerId;如果无漫游消息标记则返回 0L。
398  */
399  long queryRoamMsgHasMoreTagServerIdBlock(String sessionId, SessionTypeEnum sessionType);
400 
401  /**
402  * 根据消息关键信息批量查询服务端历史消息。该方法为异步。
403  *
404  * @param msgKeyList 消息关键信息列表
405  * @param persist 查询的漫游消息是否同步到本地数据库。
406  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
407  */
408  InvocationFuture<List<IMMessage>> pullHistoryById(List<MessageKey> msgKeyList, boolean persist);
409 
410  /**
411  * 查询同指定用户的最近一条本地历史消息。该方法为同步。
412  *
413  * @param account 用户账号(accid)
414  * @param sessionType 会话类型
415  * @return IMMessage 消息体
416  */
417  IMMessage queryLastMessage(String account, SessionTypeEnum sessionType);
418 
419  /**
420  * 从后向前批量查询服务端历史消息。该方法为异步。<br>
421  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。不能为 null。<br>
422  * 首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
423  * @param limit 查询的消息条数限制(最大为 100)
424  * @param persist 查询的漫游消息是否同步到本地数据库。
425  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
426  */
427  InvocationFuture<List<IMMessage>> pullMessageHistory(IMMessage anchor, int limit, boolean persist);
428 
429 
430  /**
431  * 从后向前批量查询服务端历史消息。该方法为异步。<br>
432  *
433  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。不能为 null。<br>
434  * 首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
435  * @param limit 查询的消息条数限制(最大为 100)
436  * @param persist 查询的漫游消息是否同步到本地数据库。
437  * @param persistClear 清除记录前的消息是否同步到本地数据库。
438  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
439  */
440  InvocationFuture<List<IMMessage>> pullMessageHistory(IMMessage anchor, int limit, boolean persist, boolean persistClear);
441 
442  /**
443  * 查询指定时间段内的服务端历史消息。该方法为异步。<br>
444  *
445  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),单位毫秒。不能设置为 null。<br>
446  * 首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
447  * @param toTime 查询截止时间点,单位毫秒。若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
448  * @param limit 查询的消息条数限制(最大为 100)
449  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
450  * @param persist 查询的漫游消息是否同步到本地数据库。
451  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
452  */
453  InvocationFuture<List<IMMessage>> pullMessageHistoryEx(IMMessage anchor, long toTime, int limit,
454  QueryDirectionEnum direction, boolean persist);
455 
456  /**
457  * 查询指定时间段和消息类型的的服务端历史消息。该方法为异步。默认不同步到数据库。<br>
458  *
459  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),单位毫秒。不能设置为 null。<br>
460  * 首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
461  * @param toTime 查询截止时间点,单位毫秒。若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
462  * @param limit 查询的消息条数限制(最大为 100)
463  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
464  * @param msgTypes 消息类型列表
465  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
466  */
467  InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
468  QueryDirectionEnum direction, MsgTypeEnum[] msgTypes);
469 
470  /**
471  * 查询指定时间段和消息类型的的服务端历史消息,可指定是否同步到数据库。该方法为异步。<br>
472  *
473  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),单位毫秒。不能设置为 null。<br>
474  * 首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
475  * @param toTime 查询截止时间点,单位毫秒。若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
476  * @param limit 查询的消息条数限制(最大为 100)
477  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
478  * @param msgTypes 消息类型列表
479  * @param persist 查询的漫游消息是否同步到本地数据库。
480  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
481  */
482  InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
483  QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist);
484 
485  /**
486  * 查询指定时间段和消息类型的的服务端历史消息,可指定是否同步到数据库及是否同步被清除的消息到数据库。该方法为异步。<br>
487  *
488  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),单位毫秒。不能设置为 null。<br>
489  * 首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
490  * @param toTime 查询截止时间点,单位毫秒。若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
491  * @param limit 查询的消息条数限制(最大为 100)
492  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
493  * @param msgTypes 消息类型列表
494  * @param persist 查询的漫游消息是否同步到本地数据库。
495  * @param persistClear 是否同步被清除的消息到本地数据库。该参数仅在 persist 为 true 时生效。
496  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
497  */
498  InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
499  QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
500  boolean persistClear);
501 
502  /**
503  * 查询指定时间段和消息类型的的服务端历史消息,可指定是否过滤消息通知、是否同步到数据库、是否同步被清除的消息到数据库。该方法为异步。<br>
504  *
505  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),单位毫秒。不能设置为 null。<br>
506  * 首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
507  * @param toTime 查询截止时间点,单位毫秒。若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
508  * @param limit 查询的消息条数限制(最大为 100)
509  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
510  * @param msgTypes 消息类型列表
511  * @param persist 查询的漫游消息是否同步到本地数据库。
512  * @param persistClear 是否同步被清除的消息到本地数据库。该参数仅在 persist 为 true 时生效。
513  * @param customFilter 过滤器回调,可设置是否过滤消息通知。若返回 true 则过滤消息通知,SDK 将不同步该消息通知至数据库,默认为 false。
514  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
515  */
516  InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
517  QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
518  boolean persistClear, IMMessageFilter customFilter);
519 
520  /**
521  * 查询指定时间段和消息类型的的服务端历史消息,可指定是否计算消息未读数、是否过滤消息通知、是否同步到数据库、是否同步被清除的消息到数据库。该方法为异步。<br>
522  *
523  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),单位毫秒。不能设置为 null。<br>
524  * 首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
525  * @param toTime 查询截止时间点,单位毫秒。若查询方向为 QUERY_OLD,toTime 应小于 anchor.getTime;若方向为 QUERY_NEW,toTime 应大于 anchor.getTime。
526  * @param limit 查询的消息条数限制(最大为 100)
527  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
528  * @param msgTypes 消息类型列表
529  * @param persist 查询的漫游消息是否同步到本地数据库。
530  * @param persistClear 是否同步被清除的消息到本地数据库。该参数仅在 persist 为 true 时生效。
531  * @param customFilter 过滤器回调,可设置是否过滤消息通知。若返回 true 则过滤消息通知,SDK 将不同步该消息通知至数据库,默认为 false。
532  * @param updateUnread 是否计算消息未读数
533  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:查询成功后返回消息列表;查询失败后返回具体错误码。
534  */
535  InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
536  QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
537  boolean persistClear, IMMessageFilter customFilter, boolean updateUnread);
538 
539  /**
540  * 云端(服务端)历史消息全文检索。该方法为异步。<br>
541  *
542  * @par 使用前提:
543  * 已在云信控制台开启全文云端消息检索功能。
544  *
545  * @param config 全文检索配置
546  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:成功后返回按照会话分组的消息列表;失败后返回具体错误码。
547  */
549 
550  /**
551  * 云端(服务端)历史消息全文检索,按照消息时间顺序进行排序。该方法为异步。<br>
552  *
553  * @par 使用前提:
554  * 已在云信控制台开启全文云端消息检索功能。
555  *
556  * @param config 按时间顺序的全文检索配置
557  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:成功后返回按时间顺序排序的消息列表;失败后返回具体错误码。
558  */
559  InvocationFuture<List<IMMessage>> pullMessageHistoryOrderByTime(
561 
562  /**
563  * 动态查询本地历史消息。该方法为异步。<br>
564  * 该方法调用在数据同步完成后生效。该方法为完整独立的历史消息查询接口,与其他历史消息查询接口互不影响。
565  *
566  * @par 使用前提:
567  * 已在云信控制台开启动态查询历史消息功能。
568  *
569  * @param param 动态查询历史消息配置
570  * @return InvocationFuture<GetMessagesDynamicallyResult> 可设置回调函数:成功后返回 GetMessagesDynamicallyResult 回调;失败后返回具体错误码。
571  */
573 
574  /**
575  * @deprecated 该方法已废弃,请使用 searchMessage 来替代。
576  *
577  * 从本地消息数据库搜索消息历史。查询范围由anchor的sessionId和sessionType决定。<br>
578  * 以锚点anchor作为起始点开始查询,返回最多limit条匹配key的记录。<br>
579  * 该接口目前仅搜索文本类型的消息,匹配规则为文本内容包含keyword,仅支持精确匹配,不支持模糊匹配和拼音匹配。<br>
580  * 由于sdk并不存储用户数据,因此keyword不会匹配用户资料。如果调用者希望查询指定用户的说话记录,可提供fromAccounts参数。<br>
581  * 如果提供的fromAccounts参数不为空,那么anchor对应的会话(sessionId和sessionType)的消息记录中,
582  * 凡是消息说话者在fromAccounts列表中的记录,也会被当做匹配结果,加入搜索结果中。
583  * 注意:搜索结果不包含anchor
584  *
585  * @param keyword 文本消息的搜索关键字
586  * @param fromAccounts 消息说话者帐号列表,如果消息说话在该列表中,那么无需匹配keyword,对应的消息记录会直接加入搜索结果集中。
587  * @param anchor 搜索的消息锚点
588  * @param limit 搜索结果的条数限制
589  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:成功后返回消息列表;失败后返回具体错误码。
590  */
591  InvocationFuture<List<IMMessage>> searchMessageHistory(String keyword, List<String> fromAccounts, IMMessage anchor,
592  int limit);
593 
594 
595  /**
596  * @deprecated 该方法已废弃,请使用 searchMessage 来替代。
597  *
598  * 从本地消息数据库搜索消息历史。查询范围由anchor的sessionId和sessionType决定。<br>
599  * 该接口查询方向为从后往前。以锚点anchor作为起始点开始查询,返回最多limit条匹配key的记录。<br>
600  * 该接口目前仅搜索文本类型的消息,匹配规则为文本内容包含keyword,仅支持精确匹配,不支持模糊匹配和拼音匹配。<br>
601  * 由于sdk并不存储用户数据,因此keyword不会匹配用户资料。如果调用者希望查询指定用户的说话记录,可提供fromAccounts参数。<br>
602  * 如果提供的fromAccounts参数不为空,那么anchor对应的会话(sessionId和sessionType)的消息记录中,
603  * 凡是消息说话者在fromAccounts列表中的记录,也会被当做匹配结果,加入搜索结果中。
604  * 注意:搜索结果不包含anchor
605  *
606  * @param keyword 文本消息的搜索关键字
607  * @param fromAccounts 消息说话者帐号列表,如果消息说话在该列表中,那么无需匹配keyword,对应的消息记录会直接加入搜索结果集中。
608  * @param anchor 搜索的消息锚点
609  * @param direction 查询方向
610  * @param limit 搜索结果的条数限制
611  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:成功后返回消息列表;失败后返回具体错误码。
612  */
613  InvocationFuture<List<IMMessage>> searchMessageHistory(String keyword, List<String> fromAccounts,
614  IMMessage anchor, QueryDirectionEnum direction, int limit);
615 
616  /**
617  * @deprecated 该方法已废弃,请使用 searchAllMessage 来替代。
618  *
619  * 从本地消息数据库搜索消息历史。
620  * 该接口查询方向以某个时间点为基准从后往前,返回最多limit条匹配key的记录。<br>
621  * 该接口目前仅搜索文本类型的消息,匹配规则为文本内容包含keyword,仅支持精确匹配,不支持模糊匹配和拼音匹配。<br>
622  * 由于sdk并不存储用户数据,因此keyword不会匹配用户资料。如果调用者希望查询指定用户的说话记录,可提供fromAccounts参数。<br>
623  * 如果提供的fromAccounts参数不为空,那么凡是消息说话者在fromAccounts列表中的记录,也会被当做匹配结果,加入搜索结果中。
624  *
625  * @param keyword 文本消息的搜索关键字
626  * @param fromAccounts 消息说话者帐号列表,如果消息说话在该列表中,那么无需匹配keyword,对应的消息记录会直接加入搜索结果集中。
627  * @param time 查询范围时间点,比time小(从后往前查)
628  * @param limit 搜索结果的条数限制
629  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:成功后返回消息列表;失败后返回具体错误码。
630  */
631  InvocationFuture<List<IMMessage>> searchAllMessageHistory(String keyword, List<String> fromAccounts, long time,
632  int limit);
633 
634  /**
635  * 查询指定会话的本地历史消息。该方法为异步。
636  *
637  * @param sessionType 会话类型
638  * @param sessionId 会话 ID。如果是单聊,则为聊天对象 ID;如果是群聊,则为群组 ID。
639  * @param option 查询选项,可指定时间段、查询顺序、查询数量限制等。
640  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:成功后返回消息列表;失败后返回具体错误码。
641  */
642  InvocationFuture<List<IMMessage>> searchMessage(SessionTypeEnum sessionType, String sessionId, MsgSearchOption option);
643 
644  /**
645  * 查询所有本地历史消息。该方法为异步。
646  *
647  * @param option 查询选项,可指定时间段、消息类型、查询数量限制等。
648  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:成功后返回消息列表;失败后返回具体错误码。
649  */
650  InvocationFuture<List<IMMessage>> searchAllMessage(MsgSearchOption option);
651 
652 
653 
654 
655  /**
656  * 指定关键字检索所有会话。该方法为异步。
657  *
658  * @param query 检索的关键字
659  * @param limit 本次调用返回的数量上限
660  * @return InvocationFuture<List<MsgIndexRecord>> 可设置回调函数:成功后返回消息索引记录列表;失败后返回具体错误码。
661  */
662  InvocationFuture<List<MsgIndexRecord>> searchAllSession(String query, int limit);
663 
664  /**
665  * 指定关键字检索所有会话。该方法为同步。
666  *
667  * @param query 检索的关键字
668  * @param limit 本次调用返回的数量上限
669  * @return List<MsgIndexRecord> 消息索引记录列表
670  */
671  List<MsgIndexRecord> searchAllSessionBlock(String query, int limit);
672 
673  /**
674  * 指定关键字检索指定的会话。该方法为异步。
675  *
676  * @param query 检索的关键字
677  * @param sessionType 会话类型
678  * @param sessionId 会话 ID
679  * @return InvocationFuture<List<MsgIndexRecord>> 可设置回调函数:成功后返回消息索引记录列表;失败后返回具体错误码。
680  */
681  InvocationFuture<List<MsgIndexRecord>> searchSession(String query, SessionTypeEnum sessionType, String sessionId);
682 
683  /**
684  * 指定关键字检索指定的会话。该方法为同步。
685  *
686  * @param query 检索的关键字
687  * @param sessionType 会话类型
688  * @param sessionId 会话 ID
689  * @return List<MsgIndexRecord> 消息索引记录列表
690  */
691  List<MsgIndexRecord> searchSessionBlock(String query, SessionTypeEnum sessionType, String sessionId);
692 
693  /**
694  * 删除一条本地历史消息,并同步数据库。<br>
695  * 从服务端拉取消息时,若存在该消息的本地删除记录,则该消息不会同步到数据库中。
696  *
697  * @param message 待删除的 IMMessage 消息体
698  */
699  void deleteChattingHistory(IMMessage message);
700 
701  /**
702  * 删除一条本地历史消息,并指定是否记录删除操作。<br>
703  *
704  * @param message 待删除的 IMMessage 消息体
705  * @param ignore 是否记录删除操作。从服务端拉取消息时,若存在该消息的本地删除记录(ignore 为 true),则该消息不会同步到数据库中。
706  */
707  void deleteChattingHistory(IMMessage message, boolean ignore);
708 
709  /**
710  * 删除一条本地历史消息,并指定是否记录删除操作。<br>
711  *
712  * @param msgList 待删除的 IMMessage 消息体列表
713  * @param ignore 是否记录删除操作。从服务端拉取消息时,若存在该消息的本地删除记录(ignore 为 true),则该消息不会同步到数据库中。
714  */
715  void deleteChattingHistory(List<IMMessage> msgList, boolean ignore);
716 
717  /**
718  * 清除指定用户的所有消息记录,不同步到数据库。
719  *
720  * @param account 用户账号(accid)
721  * @param sessionType 会话类型
722  */
723  void clearChattingHistory(String account, SessionTypeEnum sessionType);
724 
725  /**
726  * 清除指定用户的所有消息记录。
727  *
728  * @param account 用户账号(accid)
729  * @param sessionType 会话类型
730  * @param ignore 是否记录清除操作。从服务端拉取消息时,若存在该消息的本地清除记录(ignore 为 true),则该消息不会同步到数据库中。
731  */
732  void clearChattingHistory(String account, SessionTypeEnum sessionType, boolean ignore);
733 
734  /**
735  * 清空消息数据库的所有消息记录,并指定是否要同时清空最近会话数据库。该方法为异步。 <br>
736  * 若最近会话列表被清空,会触发 {@link MsgServiceObserve#observeRecentContactDeleted(Observer, boolean)} 回调通知。
737  *
738  * @param clearRecent 是否清空最近会话列表数据
739  * @return InvocationFuture<Void> 可设置回调函数:清空成功后返回通知;清空失败后返回具体错误码。
740  */
741  InvocationFuture<Void> clearMsgDatabase(boolean clearRecent);
742 
743  /**
744  * 单向删除指定消息,并同时单向删除服务端历史消息、漫游消息。该方法为异步。<br>
745  * 用户单向删除一条消息成功后,该账号下不再能从服务端拉取到该条消息。而且,本端登录此账号的其他端都会删除本地的该消息记录。其他账号不受到该操作影响。删除成功后,会触发 {@link MsgServiceObserve#observeDeleteMsgSelf} 回调。
746  *
747  * @param msg 单向删除的 IMMessage 消息体
748  * @param ext 消息扩展字段
749  * @return InvocationFuture<Long> 可设置回调函数:成功后返回成功回调;失败后返回具体错误码。
750  */
751  InvocationFuture<Long> deleteMsgSelf(IMMessage msg, String ext);
752 
753  /**
754  * 单向删除指定的消息列表,并同时单向删除服务端历史消息、漫游消息。该方法为异步。<br>
755  * 用户单向删除消息列表成功后,该账号下不再能从服务端拉取到被删除消息。而且,本端登录此账号的其他端都会删除本地的该消息列表。其他账号不受到该操作影响。删除成功后,会触发 {@link MsgServiceObserve#observeDeleteMsgSelf} 回调。
756  * @param msgList 单向删除的 IMMessage 消息体列表
757  * @param ext 消息扩展字段
758  * @return InvocationFuture<Long> 可设置回调函数:成功后返回成功回调;失败后返回具体错误码。
759  */
760  InvocationFuture<Long> deleteMsgSelf(List<IMMessage> msgList, String ext);
761 
762  /**
763  * 查询指定消息是否存在本地删除记录。
764  *
765  * @param message 待查询的 IMMessage 消息体
766  * @return 是否存在本地删除记录
767  */
768  boolean everBeenDeleted(IMMessage message);
769 
770  /**
771  * 设置当前正在聊天的对象。<br>
772  * 设置后会影响内建的消息提醒。如果有新消息到达,且消息来源是正在聊天的对象,将不会有消息提醒。<br>
773  * 调用该接口的同时 SDK 会自动调用 {@link #clearUnreadCount(String, SessionTypeEnum)},将正在聊天对象的未读数清零。
774  *
775  * @param account 聊天对象账户(accid),或者以下两个值:<br>
776  * {@link #MSG_CHATTING_ACCOUNT_ALL}<br>
777  * {@link #MSG_CHATTING_ACCOUNT_NONE}
778  * @param sessionType 会话类型。若 account 未设置为具体对象,则该参数不生效。
779  */
780  void setChattingAccount(String account, SessionTypeEnum sessionType);
781 
782  /**
783  * 获取会话消息总未读数。
784  *
785  * @return 会话总未读数
786  */
787  int getTotalUnreadCount();
788 
789  /**
790  * 根据免打扰状态获取会话消息总未读数。
791  *
792  * @param notify 是否获取免打扰会话的消息未读数:true 表示只查询排除免打扰之外的消息总未读数,false 表示只查询免打扰的消息总未读数。
793  * @return 消息总未读数
794  */
795  int getTotalUnreadCount(boolean notify);
796 
797  /**
798  * 获取指定类型的会话总未读数。
799  *
800  * @param sessionType 会话类型
801  * @return 消息总未读数
802  */
803  int getUnreadCountBySessionType(SessionTypeEnum sessionType);
804 
805  /**
806  * 获取指定会话的未读消息列表。该方法为异步。
807  *
808  * @param sessionId 会话ID
809  * @param sessionType 会话类型
810  * @return InvocationFuture<List<IMMessage>> 可设置回调函数:成功后返回消息列表;失败后返回具体错误码。
811  */
812  InvocationFuture<List<IMMessage>> queryUnreadMessageList(String sessionId,SessionTypeEnum sessionType);
813  /**
814  * 获取指定会话的未读消息列表。该方法为同步。
815  * @param sessionId 会话ID
816  * @param sessionType 会话类型
817  * @return List<IMMessage> 消息列表
818  */
819  List<IMMessage> queryUnreadMessageListBlock(String sessionId,SessionTypeEnum sessionType);
820 
821  /**
822  * 将指定聊天对象的会话未读数清零(标记已读)。<br>
823  * 调用该接口后,SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
824  *
825  * @param account 如果会话类型为单聊,则为聊天对象帐号(accid);如果会话类型为群组或超大群,则为群组 ID。
826  * @param sessionType 会话类型
827  * @return InvocationFuture<Void> 可设置回调函数:清零成功后返回通知;清零失败后返回具体错误码。
828  */
829  InvocationFuture<Void> clearUnreadCount(String account, SessionTypeEnum sessionType);
830 
831  /**
832  * 将指定聊天对象的会话未读数清零(标记已读)。该方法为异步。<br>
833  * 调用该接口后,SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
834  *
835  * @param sessionKeyList 会话关键字列表。第一项为会话 ID,第二项为会话类型。
836  * 会话类型支持单聊(P2P)和群组(Team)。
837  * @return InvocationFuture<List<SessionAckInfo>> 可设置回调函数:成功后返回会话关键信息列表;失败后返回具体错误码。
838  */
839  InvocationFuture<List<SessionAckInfo>> clearUnreadCount(List<Pair<String, SessionTypeEnum>> sessionKeyList);
840 
841  /**
842  * 将指定类型的会话未读数清零(标记已读)。该方法为异步。<br>
843  * 调用该接口后,SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
844  *
845  * @param sessionType 会话类型,支持单聊(P2P)和群组(Team)。
846  * @return InvocationFuture<List<SessionAckInfo>> 可设置回调函数:成功后返回会话关键信息列表;失败后返回具体错误码。
847  */
848  InvocationFuture<List<SessionAckInfo>> clearUnreadCount(SessionTypeEnum sessionType);
849 
850 
851  /**
852  * 将会话所有未读数清零(标记已读)。该接口为同步。<br>
853  * 调用该接口后,SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
854  */
855  void clearAllUnreadCount();
856 
857  /**
858  * 发送单聊消息已读回执。
859  *
860  * @param sessionId 会话 ID,即聊天对象账号(accid)。
861  * @param message 已读的 IMMessage 消息体
862  * @return InvocationFuture<Void> 可设置回调函数:发送成功后返回通知;发送失败后返回具体错误码。
863  */
864  InvocationFuture<Void> sendMessageReceipt(String sessionId, IMMessage message);
865 
866  /**
867  * 更新消息属性。
868  *
869  * 可更新的属性如下:<br>
870  * - 消息状态 {@link IMMessage#getStatus()}
871  * - 附件状态 {@link IMMessage#getAttachStatus()}
872  * - 附件内容 {@link IMMessage#getAttachment()}
873  *
874  * @param message 待更新的 IMMessage 消息体
875  */
876  void updateIMMessageStatus(IMMessage message);
877 
878  /**
879  * 更新消息。目前仅支持更新本地扩展字段 LocalExtension。
880  *
881  * @param message 待更新的 IMMessage 消息体
882  */
883  void updateIMMessage(IMMessage message);
884 
885  /**
886  * 注册附件解析器。<br>
887  *
888  * <p>
889  * 使用场景:
890  * - 第三方 app 需要自定义的附件消息类型。
891  * - 客户自定义的消息类型为{@link com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#custom}。
892  * - 自定义附件类型须继承自 {@link com.netease.nimlib.sdk.msg.attachment.MsgAttachment}。
893  *
894  * @param customParser 附件解析器
895  */
896  void registerCustomAttachmentParser(MsgAttachmentParser customParser);
897 
898  /**
899  * 发送自定义系统通知。该接口为异步。<br>
900  * 调用该接口后,SDK 会触发 {@link MsgServiceObserve#observeCustomNotification(Observer, boolean)} 回调通知。
901  *
902  * @param notification 自定义的系统通知
903  * @return InvocationFuture<Void> 可设置回调函数:发送成功后返回通知;发送失败后返回具体错误码。
904  */
905  InvocationFuture<Void> sendCustomNotification(CustomNotification notification);
906 
907  /**
908  * 查询全部最近会话。该接口为异步。
909  *
910  * @return InvocationFuture<List<RecentContact>> 可设置回调函数:成功后返回最近会话列表;失败后返回具体错误码。
911  */
912  InvocationFuture<List<RecentContact>> queryRecentContacts();
913 
914  /**
915  * 查询全部最近会话。该接口为同步。
916  *
917  * @return List<RecentContact> 最近会话列表
918  */
919  List<RecentContact> queryRecentContactsBlock();
920 
921  /**
922  * 查询指定数量的最近会话列表。该接口为异步。
923  * <p>
924  * 使用场景:
925  * 最近会话数量较大。
926  *
927  * @param limit 本次查询最近会话的数量上限。最大可设置到 100,超过 100 则默认为 100。
928  * @return InvocationFuture<List<RecentContact>> 可设置回调函数:成功后返回指定数量的最近会话列表;失败后返回具体错误码。
929  */
930  InvocationFuture<List<RecentContact>> queryRecentContacts(int limit);
931 
932 
933  /**
934  * 分页查询指定数量的最近会话列表。该接口为异步。
935  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),单位毫秒。<br>
936  * 每次查询传入上一页数据的最后一个 RecentContact。<br>
937  * 首次查询传 null 即可。<br>
938  * 首次查询当查询方向 direction 为 QUERY_NEW 时,则从 0 开始查询;
939  * 首次查询当查询方向 direction 为 QUERY_OLD 时,则从当前系统时间开始查询。
940  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
941  * @param limit 查询的消息条数限制(最大为 100)
942  * @return InvocationFuture<List<RecentContact>> 可设置回调函数:成功后分页返回最近会话列表;失败后返回具体错误码。
943  */
944  InvocationFuture<List<RecentContact>> queryRecentContacts(RecentContact anchor,QueryDirectionEnum direction,int limit);
945 
946  /**
947  * 查询指定数量的最近会话列表。该接口为同步。
948  *
949  * @param limit 本次查询最近会话的数量上限。最大可设置到 100,超过 100 则默认为 100。
950  * @return List<RecentContact> 指定数量的最近会话列表。
951  */
952  List<RecentContact> queryRecentContactsBlock(int limit);
953 
954  /**
955  * 分页查询指定数量的最近会话列表。该接口为同步。
956  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点),单位毫秒。<br>
957  * 每次查询传入上一页数据的最后一个 RecentContact。<br>
958  * 首次查询传 null 即可。<br>
959  * 首次查询当查询方向 direction 为 QUERY_NEW 时,则从 0 开始查询;
960  * 首次查询当查询方向 direction 为 QUERY_OLD 时,则从当前系统时间开始查询。
961  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
962  * @param limit 查询的消息条数限制(最大为 100)
963  * @return List<RecentContact> 分页返回最近会话列表
964  */
965  List<RecentContact> queryRecentContactsBlock(RecentContact anchor,QueryDirectionEnum direction,int limit);
966 
967 
968  /**
969  * 过滤指定消息类型的会话,例如过滤文本消息,则返回最近一条非文本消息的会话。该接口为异步。
970  *
971  * @param filterMsgType 过滤的消息类型
972  * @return InvocationFuture<List<RecentContact>> 可设置回调函数:成功后返回最近会话列表;失败后返回具体错误码。
973  */
974  InvocationFuture<List<RecentContact>> queryRecentContacts(MsgTypeEnum filterMsgType);
975 
976  /**
977  * 过滤指定消息类型的会话,例如过滤文本消息,则返回最近一条非文本消息的会话。该接口为同步。
978  *
979  * @param filterMsgType 过滤的消息类型
980  * @return List<RecentContact> 过滤后的最近会话列表
981  */
982  List<RecentContact> queryRecentContactsBlock(MsgTypeEnum filterMsgType);
983 
984 
985  /**
986  * 查过滤指定消息类型的会话,例如过滤文本和音频消息,则返回最近一条非文本或音频消息的会话。该接口为异步。
987  *
988  * @param filterMsgTypeSet 过滤的消息类型列表
989  * @return InvocationFuture<List<RecentContact>> 可设置回调函数:成功后返回最近会话列表;失败后返回具体错误码。
990  */
991  InvocationFuture<List<RecentContact>> queryRecentContacts(Set<MsgTypeEnum> filterMsgTypeSet);
992 
993  /**
994  * 查过滤指定消息类型的会话,例如过滤文本和音频消息,则返回最近一条非文本或音频消息的会话。该接口为同步。
995  *
996  * @param filterMsgTypeSet 过滤的消息类型列表
997  * @return List<RecentContact> 过滤后的最近会话列表
998  */
999  List<RecentContact> queryRecentContactsBlock(Set<MsgTypeEnum> filterMsgTypeSet);
1000 
1001  /**
1002  * 更新指定的最近会话。<br>
1003  * 如需收到更新的回调通知,可使用 {@link MsgService#updateRecentAndNotify(RecentContact)}。
1004  *
1005  * @param recent 最近会话对象
1006  */
1007  void updateRecent(RecentContact recent);
1008 
1009 
1010  /**
1011  * 更新指定的最近会话。<br>
1012  * 更新成功后,SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知 。
1013  *
1014  * @param recent 最近会话对象
1015  */
1016  void updateRecentAndNotify(RecentContact recent);
1017 
1018 
1019  /**
1020  * 更新指定消息所属的最近会话。
1021  *
1022  * @param message IMMessage 消息体
1023  * @param needNotify 是否需要触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知
1024  */
1025  void updateRecentByMessage(IMMessage message, boolean needNotify);
1026 
1027 
1028  /**
1029  * 根据是否有更多漫游消息的标记更新最近会话。
1030  *
1031  * @param newTag IMMessage 消息体
1032  */
1033  void updateRoamMsgHasMoreTag(IMMessage newTag);
1034 
1035  /**
1036  * 删除指定的最近会话记录,包括本地最近会话和漫游消息。<br>
1037  * 调用该接口删除后,不会返回回调通知。
1038  *
1039  * @param recent 待删除的最近联系人会话项
1040  */
1041  void deleteRecentContact(RecentContact recent);
1042 
1043  /**
1044  * 删除指定聊天对象和会话类型的最近会话记录,包括本地最近会话和漫游消息。<br>
1045  * 调用该接口删除后,会触发 {@link MsgServiceObserve#observeRecentContactDeleted(Observer, boolean)} 回调通知。
1046  *
1047  * @param account 如果会话类型为单聊,则为聊天对象账号(accid);如果会话类型为群组或超大群,则为群组 ID。
1048  * @param sessionType 会话类型
1049  */
1050  void deleteRecentContact2(String account, SessionTypeEnum sessionType);
1051 
1052  /**
1053  * 删除指定会话的漫游消息。<br>
1054  * 不删除本地消息,如果在其他端登录,当前时间点该会话已经产生的消息不漫游。
1055  *
1056  * @param contactId 会话 ID。如果会话类型为单聊,则为聊天对象账号(accid);如果会话类型为群组,则为群组 ID。
1057  * @param sessionTypeEnum 会话类型
1058  * @return InvocationFuture<Void> 可设置回调函数:删除成功后返回通知;删除失败后返回具体错误码。
1059  */
1060  InvocationFuture<Void> deleteRoamingRecentContact(String contactId, SessionTypeEnum sessionTypeEnum);
1061 
1062  /**
1063  * 删除最近联系人记录。<br>
1064  * 调用该接口后,不会触发{@link MsgServiceObserve#observeRecentContactDeleted(Observer, boolean)}通知
1065  *
1066  * @param account 如果会话类型为单聊,则为聊天对象账号(accid);如果会话类型为群组,则为群组 ID。
1067  * @param sessionType 会话类型,仅支持设置为单聊(P2P)和群组(Team)。
1068  * @param deleteType 删除类型,设置删除本地记录或漫游记录,默认为均不删除。
1069  * @param sendAck 是否向其他端发送已读回执
1070  * @return InvocationFuture<Void> 可设置回调函数:删除成功后返回通知;删除失败后返回具体错误码。
1071  */
1072  InvocationFuture<Void> deleteRecentContact(String account, SessionTypeEnum sessionType, DeleteTypeEnum deleteType, boolean sendAck);
1073 
1074  /**
1075  * 根据是否有更多漫游消息的标记删除指定会话。
1076  *
1077  * @param sessionId 会话 ID
1078  * @param sessionType 会话类型
1079  */
1080  void deleteRoamMsgHasMoreTag(String sessionId, SessionTypeEnum sessionType);
1081 
1082  /**
1083  * 语音转文字。
1084  *
1085  * <p>返回的 Future 可按普通 {@link InvocationFuture} 使用,通过回调获取转写结果。</p>
1086  * <p>调用 {@code abort()} 不会取消已开始的语音文件上传或转写流程;上传成功后仍会发起转写请求,已发送的请求也不会被撤回。
1087  * {@code abort()} 返回 {@code true} 仅表示已取消该 Future 的结果回调,不表示底层操作已停止。
1088  * 若结果已进入回调派发阶段,{@code abort()} 返回 {@code false},仍可能收到回调。</p>
1089  * <p>特殊情况:SDK 尚未就绪且调用仍在初始化等待队列中时,{@code abort()} 可移除该调用,使上传和转写流程不再启动。</p>
1090  *
1091  * @param voiceUrl 语音文件 URL
1092  * @param path 语音文件本地路径。请确保语音文件已下载到本地。
1093  * @param duration 语音时长
1094  * @return 可设置回调函数监听的 {@code AbortableFuture<String>}。成功后返回字符串;失败后返回具体错误码。
1095  */
1096  AbortableFuture<String> transVoiceToText(String voiceUrl, String path, long duration);
1097 
1098  /**
1099  * 语音转文字并指定上传文件的场景。
1100  *
1101  * <p>返回的 Future 可按普通 {@link InvocationFuture} 使用,通过回调获取转写结果。</p>
1102  * <p>调用 {@code abort()} 不会取消已开始的语音文件上传或转写流程;上传成功后仍会发起转写请求,已发送的请求也不会被撤回。
1103  * {@code abort()} 返回 {@code true} 仅表示已取消该 Future 的结果回调,不表示底层操作已停止。
1104  * 若结果已进入回调派发阶段,{@code abort()} 返回 {@code false},仍可能收到回调。</p>
1105  * <p>特殊情况:SDK 尚未就绪且调用仍在初始化等待队列中时,{@code abort()} 可移除该调用,使上传和转写流程不再启动。</p>
1106  *
1107  * @param voiceUrl 语音文件 URL
1108  * @param path 语音文件本地路径。请确保语音文件已下载到本地。
1109  * @param duration 语音时长
1110  * @param sceneKey 上传文件时使用的 nos sceneKey,默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}。详见 {@link NosTokenSceneConfig}。
1111  * @return 可设置回调函数监听的 {@code AbortableFuture<String>}。成功后返回字符串;失败后返回具体错误码。
1112  */
1113  AbortableFuture<String> transVoiceToTextAtScene(String voiceUrl, String path, long duration, String sceneKey);
1114 
1115 
1116  /**
1117  * 语音转文字并指定上传文件的场景,以及是否要强制重新上传文件。
1118  *
1119  * <p>返回的 Future 可按普通 {@link InvocationFuture} 使用,通过回调获取转写结果。</p>
1120  * <p>调用 {@code abort()} 不会取消已开始的语音文件上传或转写流程;上传成功后仍会发起转写请求,已发送的请求也不会被撤回。
1121  * {@code abort()} 返回 {@code true} 仅表示已取消该 Future 的结果回调,不表示底层操作已停止。
1122  * 若结果已进入回调派发阶段,{@code abort()} 返回 {@code false},仍可能收到回调。</p>
1123  * <p>特殊情况:SDK 尚未就绪且调用仍在初始化等待队列中时,{@code abort()} 可移除该调用,使上传和转写流程不再启动。</p>
1124  *
1125  * @param voiceUrl 语音文件 URL
1126  * @param path 语音文件本地路径。请确保语音文件已下载到本地。
1127  * @param duration 语音时长
1128  * @param sceneKey 上传文件时使用的 nos sceneKey,默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}。详见 {@link NosTokenSceneConfig}。
1129  * @param enableForceUploadFile 如果服务器存在相同的文件,是否强制重新上传文件,默认为 false。
1130  * @return 可设置回调函数监听的 {@code AbortableFuture<String>}。成功后返回字符串;失败后返回具体错误码。
1131  */
1132  AbortableFuture<String> transVoiceToTextEnableForce(String voiceUrl, String path, long duration, String sceneKey,
1133  boolean enableForceUploadFile);
1134 
1135  /**
1136  * 搜索指定聊天对象的漫游消息。
1137  *
1138  * @param otherAccid 聊天对象账号(accid)
1139  * @param fromTime 搜索起始时间,单位毫秒。
1140  * @param endTime 搜索结束时间点,单位毫秒。
1141  * @param keyword 搜索关键词
1142  * @param limit 本次查询的消息条数上限(最多 100)
1143  * @param reverse 是否反转,true 表示按时间倒序搜索,false 表示按时间正序搜索,默认为 false。
1144  * @return InvocationFuture<ArrayList<IMMessage>> 可设置回调函数监听:成功后返回漫游消息列表;失败后返回具体错误码。
1145  */
1146  InvocationFuture<ArrayList<IMMessage>> searchRoamingMsg(String otherAccid, long fromTime, long endTime, String keyword, int limit, boolean reverse);
1147 
1148  /**
1149  * 注册通知类消息的过滤器。
1150  *
1151  * @param filter 通知类消息的过滤器,决定是否过滤通知消息(即不存储到数据库中)。<br>
1152  * 传 null 表示注销通知消息过滤器。
1153  */
1154  void registerIMMessageFilter(IMMessageFilter filter);
1155 
1156  /**
1157  * 注册在撤回消息时展示通知类消息的过滤器。
1158  *
1159  * @param filter 通知类消息的过滤器,决定是否在撤回消息时展示通知类消息的过滤器。<br>
1160  * 传 null 表示展示通知类消息的过滤器。
1161  */
1162  void registerShouldShowNotificationWhenRevokeFilter(ShowNotificationWhenRevokeFilter filter);
1163 
1164  /**
1165  * 撤回指定的消息。<br>
1166  * 默认不包含第三方推送消息(包括 iOS 推送)。
1167  *
1168  * @param message 待撤回的 IMMessage 消息体
1169  * @return InvocationFuture<Void> 可设置回调函数:撤回成功后返回通知;撤回失败后返回具体错误码。
1170  */
1171  InvocationFuture<Void> revokeMessage(IMMessage message);
1172 
1173 
1174  /**
1175  * 撤回指定的消息,并设置第三方推送属性(包括 iOS 推送)。<br>
1176  *
1177  * @param message 待撤回的 IMMessage 消息体
1178  * @param customApnsText 第三方推送文本
1179  * @param pushPayload 第三方推送属性,仅支持 JSON 格式,长度上限为 2048。
1180  * @return InvocationFuture<Void> 可设置回调函数:撤回成功后返回通知;撤回失败后返回具体错误码。
1181  */
1182  InvocationFuture<Void> revokeMessageEx(IMMessage message, String customApnsText, Map<String, Object> pushPayload);
1183 
1184 
1185  /**
1186  * 撤回指定的消息,并设置第三方推送属性(包括 iOS 推送),及是否更新未读数。
1187  *
1188  * @param message 待撤回的 IMMessage 消息体
1189  * @param customApnsText 第三方推送文本
1190  * @param pushPayload 第三方推送属性,仅支持 JSON 格式,长度上限为 2048。
1191  * @param shouldNotifyBeCount 是否更新未读数
1192  * @return InvocationFuture<Void> 可设置回调函数:撤回成功后返回通知;撤回失败后返回具体错误码。
1193  */
1194  InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
1195  Map<String, Object> pushPayload, boolean shouldNotifyBeCount);
1196 
1197  /**
1198  * 撤回指定的消息,并设置第三方推送属性(包括 iOS 推送)、附言,及是否更新未读数。
1199  *
1200  * @param message 待撤回的 IMMessage 消息体
1201  * @param customApnsText 第三方推送文本
1202  * @param pushPayload 第三方推送属性,仅支持 JSON 格式,长度上限为 2048。
1203  * @param shouldNotifyBeCount 是否更新未读数
1204  * @param postscript 附言信息
1205  * @return InvocationFuture<Void> 可设置回调函数:撤回成功后返回通知;撤回失败后返回具体错误码。
1206  */
1207  InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
1208  Map<String, Object> pushPayload, boolean shouldNotifyBeCount,
1209  String postscript);
1210 
1211  /**
1212  * 撤回指定的消息,并设置第三方推送属性(包括 iOS 推送)、附言、扩展信息,及是否更新未读数。
1213  *
1214  * @param message 待撤回的 IMMessage 消息体
1215  * @param customApnsText 第三方推送文本
1216  * @param pushPayload 第三方推送属性,仅支持 JSON 格式,长度上限为 2048。
1217  * @param shouldNotifyBeCount 是否更新未读数
1218  * @param postscript 附言
1219  * @param attach 扩展字段
1220  * @return InvocationFuture<Void> 可设置回调函数:撤回成功后返回通知;撤回失败后返回具体错误码。
1221  */
1222  InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
1223  Map<String, Object> pushPayload, boolean shouldNotifyBeCount,
1224  String postscript, String attach);
1225 
1226  /**
1227  * 批量导入最近会话,仅支持 contactId 和 sessionType 两个字段
1228  *
1229  * @param sessions 会话列表。由 contactId(会话 ID) 和 SessionTypeEnum(会话类型)两个字段组成。
1230  * @return InvocationFuture<Void> 可设置回调函数:导入成功后返回通知;导入失败后返回具体错误码。
1231  */
1232  InvocationFuture<Void> importRecentSessions(List<Pair<String, SessionTypeEnum>> sessions);
1233 
1234 
1235  /**
1236  * 检验本地反垃圾词库。
1237  *
1238  * @param content 待检查的文本
1239  * @param replacement 反垃圾词库命中后的替换文本
1240  * @return 检验结果 LocalAntiSpamResult 对象
1241  */
1242  LocalAntiSpamResult checkLocalAntiSpam(String content, String replacement);
1243 
1244  /**
1245  * 创建一条空的最近会话。
1246  *
1247  * @param contactId 会话 ID,聊天对方帐号或群组 ID。
1248  * @param sessionType 会话类型
1249  * @param tag 会话标签。例如置顶标签,如不需要可传 0。
1250  * @param time 会话时间戳,单位为毫秒。
1251  * @param saveToDB 是否需要将会话保存在数据库中:<br>
1252  * - 如果已经存在相同会话,则不保存。<br>
1253  * - 如果之前不存在相同会话,保存到数据库后会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
1254  *
1255  * @return RecentContact 创建的最近会话
1256  */
1257  RecentContact createEmptyRecentContact(String contactId, SessionTypeEnum sessionType, long tag, long time,
1258  boolean saveToDB);
1259 
1260  /**
1261  * 创建一条空的最近会话。
1262  *
1263  * @param contactId 会话 ID,聊天对方帐号或群组 ID。
1264  * @param sessionType 会话类型
1265  * @param tag 会话标签。例如置顶标签,如不需要可传 0。
1266  * @param time 会话时间戳,单位为毫秒。
1267  * @param saveToDB 是否需要将会话保存在数据库中:<br>
1268  * - 如果已经存在相同会话,则不保存。<br>
1269  * - 如果之前不存在相同会话,保存到数据库后会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
1270  * @param withLastMsg 是否包含最后一条消息的相关信息
1271  * @return RecentContact 创建的最近会话
1272  */
1273  RecentContact createEmptyRecentContact(String contactId, SessionTypeEnum sessionType, long tag, long time,
1274  boolean saveToDB, boolean withLastMsg);
1275 
1276 
1277  /**
1278  * 查询指定的会话记录。
1279  *
1280  * @param contactId 会话 ID,聊天对象帐号或群组 ID。
1281  * @param sessionType 会话类型
1282  * @return RecentContact 最近会话
1283  */
1284  RecentContact queryRecentContact(String contactId, SessionTypeEnum sessionType);
1285 
1286 
1287  /**
1288  * 取消上传消息附件(图片、视频、文件类型)。<br/>
1289  * 如果成功取消了附件的上传,对应的消息会发送失败,消息状态是 {@link MsgStatusEnum#fail},附件状态是 {@link AttachStatusEnum#cancel}。<br>
1290  * <p>
1291  * 注意事项
1292  * 此方法暂时不支持聊天室。
1293  *
1294  * @param imMessage 取消上传附件的 IMMessage 消息体
1295  * @return InvocationFuture<Void> 可设置回调函数:取消成功后返回通知;取消失败后返回具体错误码。
1296  */
1297  InvocationFuture<Void> cancelUploadAttachment(IMMessage imMessage);
1298 
1299 
1300  /**
1301  * 导出本地所有历史消息。导出消息类型包括:文本消息 、图片消息、 音频消息、 视频消息 、文件消息、自定义消息。<br/>
1302  * 如果有服务端消息记录,不建议使用该接口。<br/>
1303  * 整个过程如下:<br/>
1304  * step1 : 消息转换成文件 <br/>
1305  * step2 : 压缩文件(用户自定义过程) <br/>
1306  * step3 : 加密文件(用户自定义过程)<br/>
1307  * step4 : 上传文件 <br/><br/>
1308  * 错误码:<br/>
1309  * DB中没有数据 : {@link MigrationConstant#EXPORT_ERR_DB_EMPTY}<br/>
1310  * 本地消息格式化失败 : {@link MigrationConstant#EXPORT_ERR_LOCAL_FORMAT}<br/>
1311  * 文件压缩失败(用户自定义过程) : {@link MigrationConstant#EXPORT_ERR_USER_CUSTOM_ZIP}<br/>
1312  * 消息导出时,文件加密失败(用户自定义过程) : {@link MigrationConstant#EXPORT_ERR_USER_CUSTOM_ENCRYPT}<br/>
1313  * 上传文件失败 : {@link MigrationConstant#EXPORT_ERR_UPLOAD_FILE}<br/>
1314  * 消息导出时,本地有消息,但是都被过滤了 : {@link MigrationConstant#EXPORT_ERR_EMPTY_AFTER_FILTER}<br/>
1315  *
1316  * @param exportProcessor 消息导出处理器
1317  * @param safeMode 是否为安全模式,安全模式下处理完成后会删除相关的文件(包括用户自定义过程的)
1318  * @return AbortableFuture<Void> 可设置回调函数:导出成功后返回通知,可随时中断导入;导出失败后返回具体错误码。
1319  */
1320  AbortableFuture<Void> exportAllMessage(IMsgExportProcessor exportProcessor, boolean safeMode);
1321 
1322 
1323  /**
1324  * 导入已导出的历史消息。
1325  *
1326  * 该方法用于端到端的历史消息迁移,请先调用 {@link MsgService#exportAllMessage(IMsgExportProcessor, boolean safeMode)} 导出历史消息。<br/>
1327  * 导入步骤:<br/>
1328  * step1 : 请求服务器,下载备份文件。 <br/>
1329  * step2 : 解密文件(用户自定义过程)。 <br/>
1330  * step3 : 解压缩文件(用户自定义过程)。<br/>
1331  * step4 : 解析文件。<br/>
1332  * 错误码:<br/>
1333  * 服务端上没有备份记录 : {@link MigrationConstant#IMPORT_ERR_NO_BACKUP}<br/>
1334  * 服务端返回了备份记录,可是为空 : {@link MigrationConstant#IMPORT_ERR_RECORD_EMPTY}<br/>
1335  * 文件下载失败 : {@link MigrationConstant#IMPORT_ERR_DOWN_FILE}<br/>
1336  * 文件解密失败(用户自定义过程) : {@link MigrationConstant#IMPORT_ERR_CUSTOM_DECRYPT}<br/>
1337  * 文件解压缩失败(用户自定义过程) : {@link MigrationConstant#IMPORT_ERR_CUSTOM_UNZIP}<br/>
1338  * 文件格式错误 : {@link MigrationConstant#IMPORT_ERR_FILE_FORMAT}<br/>
1339  * 部分成功: {@link MigrationConstant#IMPORT_ERR_PART_SUCCESS}<br/>
1340  *
1341  * @param iMsgImportProcessor 消息导入处理器
1342  * @param safeMode 是否为安全模式。安全模式下处理完成后会删除相关的文件(包括用户自定义过程的)。
1343  * @return AbortableFuture<Void> 可设置回调函数:导入成功后返回通知,可随时中断导入;导入失败后返回具体错误码。
1344  */
1345  AbortableFuture<Void> importAllMessage(IMsgImportProcessor iMsgImportProcessor, boolean safeMode);
1346 
1347  /**
1348  * 清空服务端单聊历史消息,并指定是否删除漫游消息。
1349  *
1350  * @param sessionId 会话 ID,即聊天对象用户账号(accid)
1351  * @param deleteRoam 是否删除漫游消息
1352  */
1353  void clearServerHistory(String sessionId, boolean deleteRoam);
1354 
1355 
1356  /**
1357  * 清空服务端单聊历史消息,默认删除漫游消息。
1358  *
1359  * @param sessionId 会话 ID,即聊天对象用户账号(accid)
1360  * @param sessionType 聊天类型,仅支持单聊
1361  */
1362  void clearServerHistory(String sessionId, SessionTypeEnum sessionType);
1363 
1364  /**
1365  * 清空服务端单聊历史消息。
1366  *
1367  * @param sessionId 会话 ID,即聊天对象用户账号(accid)
1368  * @param sessionType 聊天类型
1369  * @param deleteRoam 是否删除漫游消息
1370  * @deprecated 仅当P2P时,支持保留漫游消息。
1371  * 如果要保留漫游消息,请使用{@link MsgService#clearServerHistory(String, boolean)}
1372  * 如果不保留漫游消息,请使用{@link MsgService#clearServerHistory(String, SessionTypeEnum)}
1373  */
1374  void clearServerHistory(String sessionId, SessionTypeEnum sessionType, boolean deleteRoam);
1375 
1376  /**
1377  * 清空服务端指定会话的历史消息。
1378  *
1379  * @param sessionId 会话 ID
1380  * @param sessionType 会话类型
1381  * @param sync 是否多端同步
1382  * @param ext 扩展字段
1383  */
1384  void clearServerHistory(String sessionId, SessionTypeEnum sessionType, boolean sync, String ext);
1385 
1386 
1387  /**
1388  * 根据时间范围删除指定用户的本地历史消息。
1389  *
1390  * @param account 用户账号(accid)
1391  * @param sessionType 删除会话类型
1392  * @param startTime 开始时间(不包含)
1393  * @param endTime 结束时间(不包含)
1394  */
1395  void deleteRangeHistory(String account, SessionTypeEnum sessionType, long startTime, long endTime);
1396 
1397  /**
1398  * 分页获取服务端指定会话列表。
1399  *
1400  * @deprecated 该方法已废弃,请使用 {@link MsgService#queryMySessionList(QueryMySessionOption)}。
1401  *
1402  * @param minTimestamp 最小时间戳,作为请求参数时表示增量获取Session列表,传0表示全量获取
1403  * @param maxTimestamp 最大时间戳,翻页时使用
1404  * @param needLastMsg 是否需要最后一条消息
1405  * @param limit 本次查询条数上线,最大为 100,默认为 100。
1406  * @param hasMore 预留字段
1407  * @return InvocationFuture
1408  *
1409  */
1410  InvocationFuture<RecentSessionList> queryMySessionList(long minTimestamp, Long maxTimestamp, Integer needLastMsg, Integer limit, Integer hasMore);
1411 
1412  /**
1413  * 分页获取服务端指定会话列表。
1414  *
1415  * @param option 查询参数
1416  * @return InvocationFuture<RecentSessionList> 可设置回调函数:获取成功后返回会话;获取失败后返回具体错误码。
1417  */
1418  InvocationFuture<RecentSessionList> queryMySessionList(QueryMySessionOption option);
1419 
1420  /**
1421  * 获取服务端指定会话。
1422  *
1423  * @param sessionId 会话 ID,格式分别是:p2p|accid、team|tid、super_team|tid,不可为空
1424  * @return InvocationFuture<RecentSession> 可设置回调函数:获取成功后返回会话;获取失败后返回具体错误码。
1425  * @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
1426  */
1427  InvocationFuture<RecentSession> queryMySession(@NonNull String sessionId);
1428 
1429  /**
1430  * 更新服务端会话扩展字段。
1431  *
1432  * @param sessionId 会话 ID,格式分别是:p2p|accid、team|tid、super_team|tid
1433  * @param ext 会话的扩展字段,仅自己可见
1434  * @return InvocationFuture<Void> 可设置回调函数:更新成功后返回通知;更新失败后返回具体错误码。
1435  * @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
1436  */
1437  InvocationFuture<Void> updateMySession(@NonNull String sessionId, @NonNull String ext);
1438 
1439  /**
1440  * 删除服务端指定会话。
1441  *
1442  * @param sessionIdArr 每一项的格式:分为p2p/team/superTeam,格式分别是:p2p|accid、team|tid、super_team|tid。
1443  * @return InvocationFuture<Void> 可设置回调函数:删除成功后返回通知;删除失败后返回具体错误码。
1444  * @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
1445  */
1446  InvocationFuture<Void> deleteMySession(@NonNull String[] sessionIdArr);
1447 
1448  /**
1449  * 查询服务端 Thread 历史消息(支持单聊、群、超大群)。
1450  *
1451  * @param anchor 查询锚点消息,锚点为指定的 Thread 消息。
1452  * @param fromTime 查询起始时间
1453  * @param toTime 查询终止时间
1454  * @param limit 本次查询条数限制
1455  * @param direction 查询方向:早于或晚于锚点。
1456  * @param persist 查询结果是否同步到本地数据库。
1457  * @return InvocationFuture<ThreadTalkHistory> 可设置回调函数:查询成功后返回 Thread 历史消息;查询失败后返回具体错误码。
1458  */
1459  InvocationFuture<ThreadTalkHistory> queryThreadTalkHistory(IMMessage anchor, long fromTime, long toTime,
1460  int limit, QueryDirectionEnum direction, boolean persist);
1461 
1462  /**
1463  * 查询服务端 Thread 历史消息(支持单聊、群、超大群)。
1464  *
1465  * @param threadMessageKey 要查询的Thread的顶部消息的{@link MessageKey}。
1466  * @param option 分页参数
1467  * @return InvocationFuture<ThreadTalkHistory> 可设置回调函数:查询成功后返回 Thread 历史消息;查询失败后返回具体错误码。
1468  */
1469  InvocationFuture<ThreadTalkHistory> queryThreadTalkHistory(MessageKey threadMessageKey, QueryThreadTalkHistoryOption option);
1470 
1471  /**
1472  * 获取指定 Thread 的回复消息条数。
1473  *
1474  * <p>
1475  * 前提条件 已联系商务经理开通 Thread 消息功能。
1476  *
1477  * @param msg Thread 消息,该消息不计入总数。
1478  * @return 回复消息数
1479  */
1480  int queryReplyCountInThreadTalkBlock(IMMessage msg);
1481 
1482  /**
1483  * 查询本地thread聊天历史消息
1484  * @param threadMsg thread根消息
1485  * @return InvocationFuture 可设置回调函数:查询成功后返回 Thread 历史消息;查询失败后返回具体错误码。
1486  */
1487  InvocationFuture<List<IMMessage>> queryLocalThreadTalkHistory(IMMessage threadMsg);
1488 
1489  /**
1490  * 添加一条快捷评论。
1491  *
1492  * @param msg 回复的 IMMessage 消息
1493  * @param replyType 回复类型
1494  * @param ext 自定义扩展字段,最大 8 字符。
1495  * @return InvocationFuture<Void> 可设置回调函数:添加成功后返回通知;添加失败后返回具体错误码。
1496  */
1497  InvocationFuture<Void> addQuickComment(IMMessage msg, long replyType, String ext);
1498 
1499  /**
1500  * 添加一条快捷评论并设置推送。
1501  *
1502  * @param msg 回复的 IMMessage 消息
1503  * @param replyType 回复类型
1504  * @param ext 自定义扩展字段,最大 8 字符。
1505  * @param needPush 是否需要推送
1506  * @param needBadge 是否需要角标
1507  * @param pushTitle 推送标题
1508  * @param pushContent 推送内容
1509  * @param pushPayload 第三方推送属性,仅支持 JSON 类型。
1510  * @return InvocationFuture<Long> 可设置回调函数:添加成功后返回通知;添加失败后返回具体错误码。
1511  */
1512  InvocationFuture<Long> addQuickComment(IMMessage msg, long replyType, String ext, boolean needPush,
1513  boolean needBadge, String pushTitle, String pushContent,
1514  Map<String, Object> pushPayload);
1515 
1516  /**
1517  * 删除一条快捷评论。
1518  *
1519  * @param msg 回复的 IMMessage 消息
1520  * @param replyType 回复类型
1521  * @param ext 自定义扩展字段,最大 8 字符。
1522  * @return InvocationFuture<Void> 可设置回调函数:删除成功后返回通知;删除失败后返回具体错误码。
1523  */
1524  InvocationFuture<Void> removeQuickComment(IMMessage msg, long replyType, String ext);
1525 
1526  /**
1527  * 删除一条快捷评论并设置推送。
1528  *
1529  * @param msg 回复的 IMMessage 消息
1530  * @param replyType 回复类型
1531  * @param ext 自定义扩展字段,最大 8 字符。
1532  * @param needPush 是否需要消息推送
1533  * @param needBadge 是否需要角标
1534  * @param pushTitle 推送标题
1535  * @param pushContent 推送内容
1536  * @param pushPayload 第三方推送属性,仅支持 JSON 类型。
1537  * @return InvocationFuture<Long> 可设置回调函数:删除成功后返回通知;删除失败后返回具体错误码。
1538  */
1539  InvocationFuture<Long> removeQuickComment(IMMessage msg, long replyType, String ext, boolean needPush,
1540  boolean needBadge, String pushTitle, String pushContent,
1541  Map<String, Object> pushPayload);
1542  /**
1543  * 获取消息的快捷评论列表。
1544  *
1545  * @param msgList 消息列表,最多为 20 条。
1546  * @return InvocationFuture<List<QuickCommentOptionWrapper>> 可设置回调函数:获取成功后返回收藏列表信息;获取失败后返回具体错误码。
1547  */
1548  InvocationFuture<List<QuickCommentOptionWrapper>> queryQuickComment(List<IMMessage> msgList);
1549 
1550  /**
1551  * 添加一条收藏。
1552  *
1553  * @param type 收藏类型
1554  * @param date 收藏数据,最大长度为 20k 字符。
1555  * @param ext 扩展字段,最大长度为 1k 字符。
1556  * @param uniqueId 去重 ID,如果多个收藏具有相同的去重 ID,则视为同一条收藏
1557  * @return InvocationFuture<CollectInfo> 可设置回调函数:添加成功后返回收藏列表信息;添加失败后返回具体错误码。
1558  */
1559  InvocationFuture<CollectInfo> addCollect(int type, String date, String ext, String uniqueId);
1560 
1561  /**
1562  * 批量移除收藏列表。
1563  *
1564  * @param collectInfo 待移除的收藏的关键信息组成的列表,每一项为一个Pair,其中第一项为收藏 ID,第二项为收藏的创建时间。
1565  * @return InvocationFuture<Integer> 可设置回调函数:移除成功后返回通知;更新失败后返回具体错误码。
1566  */
1567  InvocationFuture<Integer> removeCollect(List<Pair<Long, Long>> collectInfo);
1568 
1569  /**
1570  * 更新一个收藏列表的扩展字段。
1571  *
1572  * @param info 收藏 ID,由服务端生成,具有唯一性。
1573  * @param ext 更新后的扩展字段
1574  * @return InvocationFuture<CollectInfo> 可设置回调函数:更新成功后返回收藏列表信息;更新失败后返回具体错误码。
1575  */
1576  InvocationFuture<CollectInfo> updateCollect(CollectInfo info, String ext);
1577 
1578  /**
1579  * 更新一个指定创建时间的收藏列表的扩展字段。
1580  *
1581  * @param infoId 收藏 ID,由服务端生成,具有唯一性。
1582  * @param createTime 收藏列表创建时间
1583  * @param ext 更新后的扩展字段
1584  * @return InvocationFuture<CollectInfo> 可设置回调函数:更新成功后返回收藏列表信息;更新失败后返回具体错误码。
1585  */
1586  InvocationFuture<CollectInfo> updateCollect(long infoId, long createTime, String ext);
1587 
1588  /**
1589  * 从服务查询消息收藏列表。
1590  *
1591  * @param limit 本次查询的条数上限,最多为 100。
1592  * @return InvocationFuture<CollectInfoPage> 可设置回调函数:查询成功后返回收藏列表;添加失败后返回具体错误码。
1593  */
1594  InvocationFuture<CollectInfoPage> queryCollect(int limit);
1595 
1596  /**
1597  * 分页查询服务端消息收藏列表。
1598  *
1599  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。
1600  * @param toTime 查询结束时间点,单位毫秒。
1601  * @param limit 本次查询的条数上限,最多为 100。
1602  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
1603  * @return InvocationFuture<CollectInfoPage> 可设置回调函数:查询成功后返回收藏列表;添加失败后返回具体错误码。
1604  */
1605  InvocationFuture<CollectInfoPage> queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction);
1606 
1607  /**
1608  * 按照收藏类型分页查询服务端消息收藏列表。
1609  *
1610  * @param anchor 查询锚点消息,作为查询起始点(不包含锚点)。
1611  * @param toTime 查询结束时间点,单位毫秒。
1612  * @param limit 本次查询的条数上限,最多为 100。
1613  * @param direction 查询方向:查询早于 anchor 消息或晚于 anchor 消息。
1614  * @param type 收藏类型
1615  * @param persist 查询的收藏消息是否同步到本地数据库。
1616  * @return InvocationFuture<CollectInfoPage> 可设置回调函数:查询成功后返回收藏列表;添加失败后返回具体错误码。
1617  */
1618  InvocationFuture<CollectInfoPage> queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction, int type, boolean persist);
1619 
1620  /**
1621  * 添加一条 PIN 消息。
1622  *
1623  * @param msg 被 PIN 标记的 IMMessage 消息体
1624  * @param ext 扩展字段
1625  * @return InvocationFuture<Long> 可设置回调函数:添加成功后返回通知;添加失败后返回具体错误码。
1626  */
1627  InvocationFuture<Long> addMsgPin(IMMessage msg, String ext);
1628 
1629  /**
1630  * 更新一条 PIN 消息。
1631  *
1632  * @param msg 被 PIN 标记的 IMMessage 消息体
1633  * @param ext 扩展字段
1634  * @return InvocationFuture<Long> 可设置回调函数:更新成功后返回通知;更新失败后返回具体错误码。
1635  */
1636  InvocationFuture<Long> updateMsgPin(IMMessage msg, String ext);
1637 
1638  /**
1639  * 移除一条 PIN 消息标记。
1640  *
1641  * @param msg 被 PIN 标记的 IMMessage 消息体
1642  * @param ext 扩展字段
1643  * @return InvocationFuture<Long> 可设置回调函数:移除成功后返回通知;移除失败后返回具体错误码。
1644  */
1645  InvocationFuture<Long> removeMsgPin(IMMessage msg, String ext);
1646 
1647  /**
1648  * 同步会话的 PIN 消息。
1649  *
1650  * @param sessionType 会话类型
1651  * @param sessionId 会话 ID
1652  * @param timestamp 消息时间戳,同步该时间戳以后的 PIN 消息。
1653  * @return InvocationFuture<MsgPinSyncResponseOptionWrapper> 可设置回调函数:同步成功后返回 PIN 消息;同步失败后返回具体错误码。
1654  */
1655  InvocationFuture<MsgPinSyncResponseOptionWrapper> syncMsgPin(SessionTypeEnum sessionType, String sessionId, long timestamp);
1656 
1657  /**
1658  * 获取本地会话的 PIN 消息列表。
1659  *
1660  * @param sessionId 会话 ID
1661  * @param sessionType 会话类型
1662  * @return List<MsgPinDbOption> PIN 消息列表
1663  */
1664  List<MsgPinDbOption> queryMsgPinBlock(String sessionId, SessionTypeEnum sessionType);
1665 
1666  /**
1667  * 添加一个置顶会话。
1668  *
1669  * @param sessionId 会话 ID
1670  * @param sessionType 会话类型
1671  * @param ext 扩展字段,最大 512 字符。
1672  * @return InvocationFuture<StickTopSessionInfo> 可设置回调函数:添加成功后返回置顶会话信息;添加失败后返回具体错误码。
1673  */
1674  InvocationFuture<StickTopSessionInfo> addStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);
1675 
1676  /**
1677  * 移除一个置顶会话。
1678  *
1679  * @param sessionId 会话 ID
1680  * @param sessionType 会话类型
1681  * @param ext 扩展字段,最大 512 字符。
1682  * @return InvocationFuture<Void> 可设置回调函数:移除成功后返回通知;移除失败后返回具体错误码。
1683  */
1684  InvocationFuture<Void> removeStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);
1685 
1686  /**
1687  * 更新一个置顶会话的扩展字段。
1688  *
1689  * @param sessionId 会话 ID
1690  * @param sessionType 会话类型
1691  * @param ext 扩展字段,最大为 512 字符
1692  * @return InvocationFuture<StickTopSessionInfo> 可设置回调函数:更新成功后返回置顶会话信息;更新失败后返回具体错误码。
1693  */
1694  InvocationFuture<StickTopSessionInfo> updateStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);
1695 
1696  /**
1697  * 获取置顶会话信息列表。该方法为同步。
1698  *
1699  * @return List<StickTopSessionInfo> 置顶会话信息列表
1700  */
1701  List<StickTopSessionInfo> queryStickTopSessionBlock();
1702 
1703 
1704  /**
1705  * 获取会话是否被置顶。
1706  *
1707  * @param sessionId 会话 ID
1708  * @param sessionType 会话类型
1709  * @return 该会话是否被置顶。如果会话 ID 或会话类型为 "" 或 null,或不合法不存在,则返回 false。
1710  */
1711  boolean isStickTopSession(String sessionId, SessionTypeEnum sessionType);
1712 
1713  /**
1714  * 迁移历史消息。<br>
1715  * 调用该方法将消息发送端的历史消息迁移到消息接收端的数据库中,包括消息内容和联系人信息。
1716  *
1717  * @param from 消息发送端用户账号(accid)
1718  * @param to 消息接收端用户账号(accid)
1719  * @param changeFrom 是否将历史消息 IMMessage 的 fromAccount 改为消息接收端用户账号(to)
1720  */
1721  void migrateMessages(String from, String to, boolean changeFrom);
1722 }
带有文件的附件类型的基类 描述文件的相关信息
聊天消息全文检索结果记录
可中断操作的调用跟踪接口。
历史消息牵移时导出时自定义处理器,导出时参考IMsgExportProcessor
NIM消息实体数据结构。 第三方APP不要调用设置类接口,调用之后不会被持久化
Definition: IMMessage.java:11
消息本身发送/接收状态,附件状态见AttachStatusEnum
历史消息牵移时导出时自定义处理器
消息的关键信息,通过这些信息可以从服务端查询到该消息的完整部分
Definition: MessageKey.java:17
云信消息服务接口类,提供消息发送、消息查询、历史消息、消息扩展功能、获取未读数、已读回执、会话列表等ç›...
Definition: MsgService.java:60
SDK nos token场景配置,不配置的话,走默认值,默认值只有以下3种场景:
自定义通知。 区别于IMMessage,SDK仅透传该类型消息,不负责解析和存储。消息内容由第三方APP自由扩展。 ...
请求Thread聊天里的消息列表得到的信息