node-nim 9.14.2 → 10.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. package/README.md +7 -1
  2. package/dist/loader.js +35 -35
  3. package/dist/nim/client.js +184 -184
  4. package/dist/nim/client.js.map +1 -1
  5. package/dist/nim/data_sync.js +19 -19
  6. package/dist/nim/friend.js +150 -150
  7. package/dist/nim/global.js +131 -131
  8. package/dist/nim/msglog.js +687 -687
  9. package/dist/nim/nos.js +216 -180
  10. package/dist/nim/nos.js.map +1 -1
  11. package/dist/nim/online_session.js +85 -85
  12. package/dist/nim/pass_through_proxy.js +39 -39
  13. package/dist/nim/plugin.js +65 -65
  14. package/dist/nim/session.js +392 -392
  15. package/dist/nim/subscribe_event.js +142 -142
  16. package/dist/nim/super_team.js +592 -592
  17. package/dist/nim/sysmsg.js +194 -194
  18. package/dist/nim/talk.js +209 -209
  19. package/dist/nim/talk.js.map +1 -1
  20. package/dist/nim/talkex.js +191 -191
  21. package/dist/nim/team.js +818 -818
  22. package/dist/nim/tool.js +119 -119
  23. package/dist/nim/user.js +201 -201
  24. package/dist/nim_def/client_def.js +245 -245
  25. package/dist/nim_def/client_def.js.map +1 -1
  26. package/dist/nim_def/data_sync_def.js +20 -20
  27. package/dist/nim_def/doc_trans_def.js +16 -16
  28. package/dist/nim_def/friend_def.js +37 -37
  29. package/dist/nim_def/global_def.js +39 -39
  30. package/dist/nim_def/msglog_def.js +148 -148
  31. package/dist/nim_def/nos_def.js +16 -16
  32. package/dist/nim_def/online_session_def.js +2 -2
  33. package/dist/nim_def/pass_through_proxy_def.js +10 -10
  34. package/dist/nim_def/plugin_def.js +2 -2
  35. package/dist/nim_def/session_def.js +26 -26
  36. package/dist/nim_def/subscribe_event_def.js +52 -52
  37. package/dist/nim_def/super_team_def.js +64 -64
  38. package/dist/nim_def/sysmsg_def.js +28 -28
  39. package/dist/nim_def/talk_def.js +2 -2
  40. package/dist/nim_def/talkex_def.js +2 -2
  41. package/dist/nim_def/team_def.js +69 -69
  42. package/dist/nim_def/tool_def.js +11 -11
  43. package/dist/nim_def/user_def.js +22 -22
  44. package/dist/node-nim.js +171 -171
  45. package/dist/node-nim.js.map +1 -1
  46. package/dist/qchat/attachment.js +63 -63
  47. package/dist/qchat/channel.js +314 -314
  48. package/dist/qchat/channel_category.js +187 -187
  49. package/dist/qchat/instance.js +77 -77
  50. package/dist/qchat/message.js +285 -285
  51. package/dist/qchat/role.js +423 -423
  52. package/dist/qchat/server.js +453 -453
  53. package/dist/qchat/system_notification.js +74 -74
  54. package/dist/qchat_def/attachment_def.js +2 -2
  55. package/dist/qchat_def/channel_def.js +2 -2
  56. package/dist/qchat_def/instance_def.js +2 -2
  57. package/dist/qchat_def/message_def.js +2 -2
  58. package/dist/qchat_def/public_def.js +649 -649
  59. package/dist/qchat_def/public_def.js.map +1 -1
  60. package/dist/qchat_def/role_def.js +2 -2
  61. package/dist/qchat_def/server_def.js +2 -2
  62. package/dist/qchat_def/system_notification_def.js +2 -2
  63. package/dist/v2/v2_nim_chatroom_client.js +135 -0
  64. package/dist/v2/v2_nim_chatroom_client.js.map +1 -0
  65. package/dist/v2/v2_nim_chatroom_service.js +244 -0
  66. package/dist/v2/v2_nim_chatroom_service.js.map +1 -0
  67. package/dist/v2/v2_nim_client.js +138 -0
  68. package/dist/v2/v2_nim_client.js.map +1 -0
  69. package/dist/v2/v2_nim_conversation_group_service.js +116 -0
  70. package/dist/v2/v2_nim_conversation_group_service.js.map +1 -0
  71. package/dist/v2/v2_nim_conversation_service.js +236 -0
  72. package/dist/v2/v2_nim_conversation_service.js.map +1 -0
  73. package/dist/v2/v2_nim_friend_service.js +128 -0
  74. package/dist/v2/v2_nim_friend_service.js.map +1 -0
  75. package/dist/v2/v2_nim_login_service.js +119 -123
  76. package/dist/v2/v2_nim_login_service.js.map +1 -1
  77. package/dist/v2/v2_nim_message_service.js +382 -0
  78. package/dist/v2/v2_nim_message_service.js.map +1 -0
  79. package/dist/v2/v2_nim_notification_service.js +30 -0
  80. package/dist/v2/v2_nim_notification_service.js.map +1 -0
  81. package/dist/v2/v2_nim_setting_service.js +86 -0
  82. package/dist/v2/v2_nim_setting_service.js.map +1 -0
  83. package/dist/v2/v2_nim_storage_service.js +58 -0
  84. package/dist/v2/v2_nim_storage_service.js.map +1 -0
  85. package/dist/v2/v2_nim_team_service.js +360 -0
  86. package/dist/v2/v2_nim_team_service.js.map +1 -0
  87. package/dist/v2/v2_nim_user_service.js +76 -0
  88. package/dist/v2/v2_nim_user_service.js.map +1 -0
  89. package/dist/v2/v2_nim_utilities.js +276 -0
  90. package/dist/v2/v2_nim_utilities.js.map +1 -0
  91. package/dist/v2_def/v2_nim_callback_def.js +2 -2
  92. package/dist/v2_def/v2_nim_enum_def.js +1087 -325
  93. package/dist/v2_def/v2_nim_enum_def.js.map +1 -1
  94. package/dist/v2_def/v2_nim_struct_def.js +2 -2
  95. package/package.json +74 -74
  96. package/script/download-sdk.js +78 -78
  97. package/script/exec-node-nim-tester.js +17 -17
  98. package/script/publish-to-netease-npm.js +3 -2
  99. package/types/loader.d.ts +2 -2
  100. package/types/nim/client.d.ts +123 -123
  101. package/types/nim/data_sync.d.ts +12 -12
  102. package/types/nim/friend.d.ts +82 -82
  103. package/types/nim/global.d.ts +69 -69
  104. package/types/nim/msglog.d.ts +392 -392
  105. package/types/nim/nos.d.ts +118 -118
  106. package/types/nim/online_session.d.ts +44 -44
  107. package/types/nim/pass_through_proxy.d.ts +24 -24
  108. package/types/nim/plugin.d.ts +39 -39
  109. package/types/nim/session.d.ts +212 -212
  110. package/types/nim/subscribe_event.d.ts +87 -87
  111. package/types/nim/super_team.d.ts +331 -331
  112. package/types/nim/sysmsg.d.ts +105 -105
  113. package/types/nim/talk.d.ts +94 -94
  114. package/types/nim/talkex.d.ts +95 -95
  115. package/types/nim/team.d.ts +461 -461
  116. package/types/nim/tool.d.ts +77 -77
  117. package/types/nim/user.d.ts +111 -111
  118. package/types/nim_def/client_def.d.ts +284 -284
  119. package/types/nim_def/data_sync_def.d.ts +19 -19
  120. package/types/nim_def/doc_trans_def.d.ts +11 -11
  121. package/types/nim_def/friend_def.d.ts +65 -65
  122. package/types/nim_def/global_def.d.ts +62 -62
  123. package/types/nim_def/msglog_def.d.ts +373 -373
  124. package/types/nim_def/nos_def.d.ts +72 -72
  125. package/types/nim_def/online_session_def.d.ts +34 -34
  126. package/types/nim_def/pass_through_proxy_def.d.ts +13 -13
  127. package/types/nim_def/plugin_def.d.ts +8 -8
  128. package/types/nim_def/session_def.d.ts +114 -114
  129. package/types/nim_def/subscribe_event_def.d.ts +83 -83
  130. package/types/nim_def/super_team_def.d.ts +144 -137
  131. package/types/nim_def/sysmsg_def.d.ts +70 -70
  132. package/types/nim_def/talk_def.d.ts +96 -96
  133. package/types/nim_def/talkex_def.d.ts +112 -112
  134. package/types/nim_def/team_def.d.ts +167 -167
  135. package/types/nim_def/tool_def.d.ts +28 -28
  136. package/types/nim_def/user_def.d.ts +59 -59
  137. package/types/node-nim.d.ts +90 -93
  138. package/types/qchat/attachment.d.ts +40 -40
  139. package/types/qchat/channel.d.ts +139 -139
  140. package/types/qchat/channel_category.d.ts +82 -82
  141. package/types/qchat/instance.d.ts +46 -46
  142. package/types/qchat/message.d.ts +128 -128
  143. package/types/qchat/role.d.ts +166 -166
  144. package/types/qchat/server.d.ts +198 -198
  145. package/types/qchat/system_notification.d.ts +39 -39
  146. package/types/qchat_def/attachment_def.d.ts +71 -71
  147. package/types/qchat_def/channel_def.d.ts +643 -643
  148. package/types/qchat_def/instance_def.d.ts +214 -214
  149. package/types/qchat_def/message_def.d.ts +565 -565
  150. package/types/qchat_def/public_def.d.ts +754 -754
  151. package/types/qchat_def/role_def.d.ts +413 -413
  152. package/types/qchat_def/server_def.d.ts +529 -529
  153. package/types/qchat_def/system_notification_def.d.ts +172 -172
  154. package/types/v2/v2_nim_chatroom_client.d.ts +73 -0
  155. package/types/v2/v2_nim_chatroom_service.d.ts +114 -0
  156. package/types/v2/v2_nim_client.d.ts +75 -0
  157. package/types/v2/v2_nim_conversation_group_service.d.ts +54 -0
  158. package/types/v2/v2_nim_conversation_service.d.ts +110 -0
  159. package/types/v2/v2_nim_friend_service.d.ts +58 -0
  160. package/types/v2/v2_nim_login_service.d.ts +80 -96
  161. package/types/v2/v2_nim_message_service.d.ts +143 -0
  162. package/types/v2/v2_nim_notification_service.d.ts +18 -0
  163. package/types/v2/v2_nim_setting_service.d.ts +43 -0
  164. package/types/v2/v2_nim_storage_service.d.ts +28 -0
  165. package/types/v2/v2_nim_team_service.d.ts +184 -0
  166. package/types/v2/v2_nim_user_service.d.ts +34 -0
  167. package/types/v2/v2_nim_utilities.d.ts +168 -0
  168. package/types/v2_def/v2_nim_callback_def.d.ts +7 -20
  169. package/types/v2_def/v2_nim_enum_def.d.ts +1009 -300
  170. package/types/v2_def/v2_nim_struct_def.d.ts +1539 -338
  171. package/dist/chatroom/chatroom.js +0 -263
  172. package/dist/chatroom/chatroom.js.map +0 -1
  173. package/dist/chatroom_def/chatroom_def.js +0 -120
  174. package/dist/chatroom_def/chatroom_def.js.map +0 -1
  175. package/dist/v2/v2_nim_instance.js +0 -44
  176. package/dist/v2/v2_nim_instance.js.map +0 -1
  177. package/types/chatroom/chatroom.d.ts +0 -55
  178. package/types/chatroom_def/chatroom_def.d.ts +0 -448
  179. package/types/v2/v2_nim_instance.d.ts +0 -25
@@ -1,392 +1,392 @@
1
- import { EventEmitter } from 'eventemitter3';
2
- import { NIMSessionType } from '../nim_def/session_def';
3
- import { NIMMsgLogAPI, QuerySingleMsgCallback, QueryMsgCallback, NIMMessageType, ModifyMultipleMsglogCallback, NIMMsgLogStatus, ModifySingleMsglogCallback, NIMMsgLogSubStatus, DBFunctionCallback, ImportDbPrgCallback, MessageStatusChangedCallback, LogsBackupExportInfo, LogsBackupImportInfo, DeleteHistoryOnLineAsyncCallback, DeleteHistoryOnLineAsyncExCallback, DeleteMessageSelfAsyncCallback, QueryMessageIsThreadRootCallback, QueryMsgAsyncParam, QueryMessageOnlineCallback, QueryThreadHistoryMsgAsyncParam, QueryThreadHistoryMsgCallback, FullTextSearchOnlineAsyncParam, FullTextSearchOnlineAsyncCallback, IMMessage, QueryMsgByKeywordOnlineParam, QueryMsgOnlineAsyncParam, DeleteMsglogSelfNotifyItemInfo, DeleteMsglogSelfNotifyParam, MessageStatusChangedResult, QueryMsgByOptionsAsyncParam, QueryMsglogResult, NIMMsglogSearchDirection, GetMessagesDynamicallyCallback, GetMessagesResult } from '../nim_def/msglog_def';
4
- import { NIMResCode } from '../nim_def/client_def';
5
- export declare interface NIMMsgLogEvents {
6
- /** 单向删除消息记录通知 */
7
- localMsgDeleted: [Array<DeleteMsglogSelfNotifyItemInfo>];
8
- /** 删除某一会话的云端的历史记录通知 */
9
- onlineMsgDeleted: [Array<DeleteMsglogSelfNotifyParam>];
10
- /** 消息状态变更 */
11
- msgStatusChanged: [MessageStatusChangedResult];
12
- }
13
- export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
14
- msglog: NIMMsgLogAPI;
15
- constructor();
16
- /** 注册全局回调 */
17
- initEventHandlers(): void;
18
- /** 根据消息ID查询本地(单条)消息
19
- * @param clientMsgId 客户端消息ID
20
- * @param jsonExtension json扩展参数(备用,目前不需要)
21
- * @param cb 查询本地消息的回调函数
22
- * @return boolean 检查参数如果不符合要求则返回失败
23
- * @note
24
- * <pre>
25
- * 200:成功
26
- * </pre>
27
- */
28
- queryMsgByIDAysnc(clientMsgId: string, cb: QuerySingleMsgCallback | null, jsonExtension: string): Promise<[NIMResCode, string, IMMessage] | null>;
29
- /** 查询本地消息
30
- * @param accid 查询id,account_id/uid或者tid
31
- * @param to_type 会话类型,双人0,群组1 (见nim_msglog_def.h)
32
- * @param limit_count 一次查询数量,建议20
33
- * @param anchor_msg_time
34
- * 作为此次查询的定位点的消息历史的消息时间戳(上次查询最后一条消息的时间戳,按指定的时间的顺序起查,默认为逆序,2.4.0之前命名为last_name)
35
- * @param jsonExtension json扩展参数(备用,目前不需要)
36
- * @param cb 查询本地消息的回调函数
37
- * @return boolean 检查参数如果不符合要求则返回失败
38
- * @note
39
- * <pre>
40
- * 200:成功
41
- * </pre>
42
- */
43
- queryMsgAsync(accid: string, to_type: NIMSessionType, limit_count: number, anchor_msg_time: number, cb: QueryMsgCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
44
- /** 查询历史消息,基于本地可信时间段信息来动态判断获取消息的途径
45
- * @param session_id 会话id
46
- * @param to_type 会话类型, 双人0,群组1, 超大群5
47
- * @param from_time 开始时间, 包含
48
- * @param to_time 结束时间, 大于from_time, 0表示当前时间; 只有在direction为kForward且anchor_client_msg_id不为空时才包含
49
- * @param limit_count 查询数量
50
- * @param anchor_client_msg_id 查询起始的客户端消息id, 查询结果不包括这条消息
51
- * @param anchor_server_msg_id 查询起始的服务器消息id, 查询结果不包括这条消息
52
- * @param direction 查询方向
53
- * @param cb 查询消息的回调函数
54
- * @param json_extension json扩展参数(备用,目前不需要)
55
- * @return void
56
- * @note 错误码 200:成功
57
- */
58
- getMessagesDynamically(session_id: string, to_type: NIMSessionType, from_time: number, to_time: number, limit_count: number, anchor_client_msg_id: string, anchor_server_msg_id: string, direction: NIMMsglogSearchDirection, cb: GetMessagesDynamicallyCallback | null, jsonExtension: string): Promise<[GetMessagesResult] | null>;
59
- /** 在线查询消息(不包括系统消息)
60
- * @param param 查询参数
61
- * @param cb 在线查询消息的回调函数
62
- * @return boolean 检查参数如果不符合要求则返回失败
63
- * @note
64
- * <pre>
65
- * 200:成功
66
- * 403:禁止访问(不在该群,只针对群组会话)
67
- * 414:参数错误
68
- * </pre>
69
- */
70
- queryMsgOnlineAsync(param: QueryMsgOnlineAsyncParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
71
- /** 在线查询消息(不包括系统消息)
72
- * @param param 查询参数
73
- * @param cb 在线查询消息的回调函数
74
- * @return boolean 检查参数如果不符合要求则返回失败
75
- * @note
76
- * <pre>
77
- * 200:成功
78
- * 403:禁止访问(不在该群,只针对群组会话)
79
- * 414:参数错误
80
- * </pre>
81
- */
82
- queryMsgByKeywordOnlineAsync(param: QueryMsgByKeywordOnlineParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
83
- /** 根据指定条件在一个会话中查询指定单个或多个类型的本地消息
84
- * @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
85
- * @param id 查询id,对方的account id或者群组tid。
86
- * @param limit_count 本次查询的消息条数上限(最多100条)
87
- * @param fromTime 起始时间点,单位:毫秒
88
- * @param endTime 结束时间点,单位:毫秒
89
- * @param endClientMsgId 结束查询的最后一条消息的end_client_msg_id(不包含在查询结果中)
90
- * @param reverse true:反向查询(按时间正序起查,正序排列),false:按时间逆序起查,逆序排列(建议默认为false)
91
- * @param msgType 检索的消息类型
92
- * @param jsonExtension json扩展参数(备用,目前不需要)
93
- * @param cb 在线查询消息的回调函数
94
- * @return boolean 检查参数如果不符合要求则返回失败
95
- * @note
96
- * <pre>
97
- * 200:成功
98
- * </pre>
99
- */
100
- queryMsgOfSpecifiedTypeInASessionAsync(to_type: NIMSessionType, id: string, limit_count: number, fromTime: number, endTime: number, endClientMsgId: string, reverse: boolean, msgType: Array<NIMMessageType>, cb: QueryMsgCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
101
- /** 根据指定条件查询本地消息,使用此接口可以完成全局搜索等功能,具体请参阅开发手册
102
- * @param param 查询参数
103
- * @param cb 在线查询消息的回调函数
104
- * @return boolean 检查参数如果不符合要求则返回失败
105
- * @note
106
- * <pre>
107
- * 200:成功
108
- * </pre>
109
- */
110
- queryMsgByOptionsAsync(param: QueryMsgByOptionsAsyncParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
111
- /** 批量设置已读状态
112
- * @param accid 查询id,account_id/uid或者tid
113
- * @param to_type 会话类型,双人0,群组1 (见nim_msglog_def.h)
114
- * @param jsonExtension json扩展参数(备用,目前不需要)
115
- * @param cb 操作结果的回调函数
116
- * @return boolean 检查参数如果不符合要求则返回失败
117
- * @note
118
- * <pre>
119
- * 200:成功
120
- * </pre>
121
- */
122
- batchStatusReadAsync(accid: string, to_type: NIMSessionType, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
123
- /** 删除某个会话的全部聊天记录
124
- * @param accid 要删除会话的id,account_id/uid或者tid
125
- * @param to_type 会话类型,双人0,群组1 (见nim_msglog_def.h)
126
- * @param revert_by_query_online 是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
127
- * @param cb 操作结果的回调函数
128
- * @param jsonExtension json扩展参数(备用,目前不需要)
129
- * @return boolean 检查参数如果不符合要求则返回失败
130
- * @note
131
- * <pre>
132
- * 200:成功
133
- * </pre>
134
- */
135
- batchStatusDeleteAsync(accid: string, to_type: NIMSessionType, revert_by_query_online: boolean, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
136
- /** 设置消息状态
137
- * @param msg_id 消息id
138
- * @param status 消息状态枚举值
139
- * @param jsonExtension json扩展参数(备用,目前不需要)
140
- * @param cb 操作结果的回调函数
141
- * @return boolean 检查参数如果不符合要求则返回失败
142
- * @note
143
- * <pre>
144
- * 200:成功
145
- * </pre>
146
- */
147
- setStatusAsync(msg_id: string, status: NIMMsgLogStatus, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string] | null>;
148
- /** 设置消息子状态
149
- * @param msg_id 消息id
150
- * @param status 消息子状态枚举值
151
- * @param jsonExtension json扩展参数(备用,目前不需要)
152
- * @param cb 操作结果的回调函数
153
- * @return boolean 检查参数如果不符合要求则返回失败
154
- * @note
155
- * <pre>
156
- * 200:成功
157
- * </pre>
158
- */
159
- setSubStatusAsync(msg_id: string, status: NIMMsgLogSubStatus, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string] | null>;
160
- /** 只往本地消息历史数据库里写入一条消息(如果已存在这条消息,则更新。通常是APP的本地自定义消息,并不会发给服务器)
161
- * @param talkId 会话id,对方的account id或者群组tid
162
- * @param msg 消息内容
163
- * @param needUpdateSession 是否更新会话列表(一般最新一条消息有这个需求)
164
- * @param composeLastMsg 如果消息历史中有该会话的消息,是否将该会话最后一条消息随会话变更上报,true 为携带,否则不携带
165
- * @param excludeMsgType 如果 compose_last_msg = true,则可根据需要排除指定最后一条消息的类型
166
- * @param cb 操作结果的回调函数
167
- * @return boolean 检查参数如果不符合要求则返回失败
168
- * @note
169
- * <pre>
170
- * 200:成功
171
- * </pre>
172
- */
173
- writeMsglogToLocalAsync(talkId: string, msg: IMMessage, needUpdateSession: boolean, composeLastMsg: boolean, excludeMsgType: Array<number>, cb: ModifySingleMsglogCallback | null): Promise<[NIMResCode, string] | null>;
174
- /** 删除指定会话类型的所有消息
175
- * @param delSessions 是否删除会话
176
- * @param to_type 会话类型
177
- * @param revert_by_query_online 是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
178
- * @param jsonExtension json扩展参数(备用,目前不需要)
179
- * @param cb 操作结果的回调函数
180
- * @return boolean 检查参数如果不符合要求则返回失败
181
- * @note
182
- * <pre>
183
- * 200:成功
184
- * </pre>
185
- */
186
- deleteBySessionTypeAsync(delSessions: boolean, to_type: NIMSessionType, revert_by_query_online: boolean, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
187
- /** 删除指定一条消息
188
- * @param session_id 会话id,对方的account id或者群组tid
189
- * @param to_type 会话类型
190
- * @param msg_id 消息id
191
- * @param jsonExtension json扩展参数(备用,目前不需要)
192
- * @param cb 操作结果的回调函数
193
- * @return boolean 检查参数如果不符合要求则返回失败
194
- * @note
195
- * <pre>
196
- * 200:成功
197
- * </pre>
198
- */
199
- deleteAsync(session_id: string, to_type: NIMSessionType, msg_id: string, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string] | null>;
200
- /** 删除全部消息历史
201
- * @param del_session 是否删除所有会话列表项(即全部最近联系人)。
202
- ture则删除,并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAll事件(不会触发每个会话项的kNIMSessionCommandRemove事件);
203
- false则不删除,并将所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态,并通过nim_session_reg_change_cb注册的回调通知上层kNIMSession
204
- CommandAllMsgDeleted事件(不会触发每个会话项的kNIMSessionCommandUpdate事件,避免频繁通知上层)。
205
- * @param revert_by_query_online 是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
206
- * @param jsonExtension json扩展参数(备用,目前不需要)
207
- * @param cb 操作结果的回调函数
208
- * @return boolean 检查参数如果不符合要求则返回失败
209
- * @note
210
- * <pre>
211
- * 200:成功
212
- * </pre>
213
- */
214
- deleteAllAsync(del_session: boolean, revert_by_query_online: boolean, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
215
- /** 根据时间段删除部分会话的历史消息
216
- * @param session_id 要删除消息的会话ID
217
- * @param to_type 要删除消息的会话类型
218
- * @param revert_by_query_online 是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
219
- * @param timestamp1 单位ms timestamp1 与 timestamp2 组成一个时间段,SDK 内部会判断大小调整入参顺序
220
- * @param timestamp2 单位ms timestamp2 与 timestamp1 组成一个时间段,SDK 内部会判断大小调整入参顺序
221
- * @param jsonExtension json扩展参数(备用,目前不需要)
222
- * @param cb 操作结果的回调函数
223
- * @return boolean 检查参数如果不符合要求则返回失败
224
- * @note
225
- * <pre>
226
- * 200:成功
227
- * </pre>
228
- */
229
- deleteMsgByTimeAsync(session_id: string, to_type: NIMSessionType, revert_by_query_online: boolean, timestamp1: number, timestamp2: number, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
230
- /** 导出整个消息历史DB文件(不包括系统消息历史)
231
- * @param dst_path 导出时保存的目标全路径(UTF-8编码)。
232
- * @param jsonExtension json扩展参数(备用,目前不需要)
233
- * @param cb 操作结果的回调函数
234
- * @return boolean 检查参数如果不符合要求则返回失败
235
- * @note
236
- * <pre>
237
- * 200:成功
238
- * </pre>
239
- */
240
- exportDbAsync(dst_path: string, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
241
- /** 导入消息历史DB文件(不包括系统消息历史)。先验证是否自己的消息历史文件和DB加密密钥(见nim_client_def.h里的kNIMDataBaseEncryptKey),如果验证不通过,则不导入。
242
- * @param src_path 导入源文件的全路径(UTF-8编码)。
243
- * @param jsonExtension json扩展参数(备用,目前不需要)
244
- * @param cb 操作结果的回调函数
245
- * @param prg_cb 导入进度的回调函数
246
- * @return boolean 检查参数如果不符合要求则返回失败
247
- * @note
248
- * <pre>
249
- * 200:成功
250
- * 10600:导入消息历史时验证身份和加密密钥不通过
251
- * 10601:导入消息历史时写记录失败
252
- * </pre>
253
- */
254
- importDbAsync(src_path: string, cb: DBFunctionCallback, prg_cb: ImportDbPrgCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
255
- /** 发送消息已读回执
256
- * @param msg 已读消息
257
- * @param cb 操作结果的回调函数
258
- * @return void 无返回值
259
- * @note
260
- * <pre>
261
- * 200:成功
262
- * 403:服务器关闭此功能,或者应用没权限
263
- * 404:请求的目标(用户或对象)不存在
264
- * 10414:本地错误码,参数错误
265
- * </pre>
266
- */
267
- sendReceiptAsync(msg: IMMessage, cb: MessageStatusChangedCallback | null): Promise<[MessageStatusChangedResult]>;
268
- /** 查询自己发送的消息是否被对方已读
269
- * @param msg 消息。
270
- * @return boolean 是否被已读
271
- */
272
- querySentMessageBeReaded(msg: IMMessage): boolean;
273
- /** 查询收到的消息是否已经发送过已读回执
274
- * @param msg 消息。
275
- * @return boolean 是否已发送过
276
- */
277
- queryReceivedMsgReceiptSent(msg: IMMessage): boolean;
278
- /** 更新本地消息扩展字段内容
279
- * @param msg_id 消息id
280
- * @param local_ext 本地扩展字段内容
281
- * @param jsonExtension json扩展参数(备用,目前不需要)
282
- * @param cb 操作结果的回调函数
283
- * @return boolean 检查参数如果不符合要求则返回失败
284
- * @note
285
- * <pre>
286
- * 200:成功
287
- * </pre>
288
- */
289
- updateLocalExtAsync(msg_id: string, local_ext: string, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string]>;
290
- /** 全部未读消息历史标记为已读
291
- * @param jsonExtension json扩展参数(备用,目前不需要)
292
- * @param cb 操作结果的回调函数
293
- * @return boolean 检查参数如果不符合要求则返回失败
294
- * @note
295
- * <pre>
296
- * 200:成功
297
- * </pre>
298
- */
299
- readAllAsync(cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
300
- /** 导出本地消息记录到云端
301
- * @param export_info 导出需要的参数参考LogsBackupExportInfo定义
302
- * @return boolean false : 当前有导入/导出操作正在进行中
303
- */
304
- exportBackupToRemote(export_info: LogsBackupExportInfo): boolean;
305
- /** 导入已备份在云端的消息记录
306
- * @param import_info 导入需要的参数参考LogsBackupImportInfo定义
307
- * @return boolean false : 当前有导入/导出操作正在进行中
308
- */
309
- importBackupToRemote(export_info: LogsBackupImportInfo): boolean;
310
- /** 取消导入已备份在云端的消息记录
311
- * @return void
312
- */
313
- cancelImportBackupFromRemote(): void;
314
- /** 取消导出本地消息记录到云端
315
- * @return void
316
- */
317
- cancelExportBackupToRemote(): void;
318
- /** 删除与某账号的所有云端历史记录与漫游消息(p2p)
319
- * @param accid 对方的accid
320
- * @param del_remote 是否同时删除所有的漫游消息 true : 是 false : 否
321
- * @param jsonExtension json扩展参数(备用,目前不需要)
322
- * @param cb 操作结果的回调函数
323
- * @return void
324
- * @note
325
- * <pre>
326
- * 200:成功
327
- * </pre>
328
- */
329
- deleteHistoryOnlineAsync(accid: string, del_remote: boolean, jsonExtension: string, cb: DeleteHistoryOnLineAsyncCallback | null): Promise<[NIMResCode, string]>;
330
- /** 删除某一会话的云端的历史记录[v8.0.0]
331
- * @param accid 对方的accid(p2p:accid team:tid)
332
- * @param to_type 会话类型,双人0,群组1 (见nim_msglog_def.h)
333
- * @param needs_notify_self 是否通知其它终端
334
- * @param jsonExtension 扩展字段
335
- * @param cb 操作结果的回调函数
336
- * @return void
337
- * @note 错误码 200:成功
338
- */
339
- deleteHistoryOnlineAsyncEx(accid: string, to_type: number, needs_notify_self: boolean, jsonExtension: string, cb: DeleteHistoryOnLineAsyncExCallback | null): Promise<[NIMResCode, string, number, number, string]>;
340
- /** 单向删除某条消息记录(同时删除本地与云端)
341
- * @param msg 要删除的消息
342
- * @param exts 用户自定义扩展字段
343
- * @param cb 操作结果的回调函数
344
- * @return void 无返回值
345
- * @note
346
- * <pre>
347
- * 200:成功
348
- * </pre>
349
- */
350
- deleteMessageSelfAsync(msg: IMMessage, ext: string, cb: DeleteMessageSelfAsyncCallback | null): Promise<[NIMResCode]>;
351
- /** 查询某条消息是否为thread聊天的根消息
352
- * @param client_id 要查询的消息的客户端ID
353
- * @param cb 操作结果的回调函数
354
- * @return void 无返回值
355
- * @note
356
- * <pre>
357
- * 200:成功
358
- * </pre>
359
- */
360
- queryMessageIsThreadRoot(client_id: string, cb: QueryMessageIsThreadRootCallback | null): Promise<[NIMResCode, string, boolean]>;
361
- /** 查询某条消息的具体内容一般用在thread talk 场景中
362
- * @param param 要查询的消息的相关参数,可以在msglog.threadinfo中得到
363
- * @param cb 查询结果的回调函数
364
- * @return void 无返回值
365
- * @note
366
- * <pre>
367
- * 200:成功
368
- * </pre>
369
- */
370
- queryMessageOnline(param: QueryMsgAsyncParam, cb: QueryMessageOnlineCallback | null): Promise<[NIMResCode, string, IMMessage]>;
371
- /** 分页查询thread talk消息历史
372
- * @param msg 要查询的消息
373
- * @param param 要查询的消息的相关参数,可以在msglog.threadinfo中得到
374
- * @param cb 查询结果的回调函数
375
- * @return void 无返回值
376
- * @note
377
- * <pre>
378
- * 200:成功
379
- * </pre>
380
- */
381
- queryThreadHistoryMsg(msg: IMMessage, param: QueryThreadHistoryMsgAsyncParam, cb: QueryThreadHistoryMsgCallback | null): Promise<[NIMResCode, IMMessage, number, number, Array<IMMessage>]>;
382
- /** 在线全文检索
383
- * @param param 全文检索参数
384
- * @param cb 全文检索结果回调函数
385
- * @return void 无返回值
386
- * @note
387
- * <pre>
388
- * 200:成功
389
- * </pre>
390
- */
391
- fullTextSearchOnlineAsync(param: FullTextSearchOnlineAsyncParam, cb: FullTextSearchOnlineAsyncCallback | null): Promise<[NIMResCode, QueryMsglogResult]>;
392
- }
1
+ import { EventEmitter } from 'eventemitter3';
2
+ import { NIMSessionType } from '../nim_def/session_def';
3
+ import { NIMMsgLogAPI, QuerySingleMsgCallback, QueryMsgCallback, NIMMessageType, ModifyMultipleMsglogCallback, NIMMsgLogStatus, ModifySingleMsglogCallback, NIMMsgLogSubStatus, DBFunctionCallback, ImportDbPrgCallback, MessageStatusChangedCallback, LogsBackupExportInfo, LogsBackupImportInfo, DeleteHistoryOnLineAsyncCallback, DeleteHistoryOnLineAsyncExCallback, DeleteMessageSelfAsyncCallback, QueryMessageIsThreadRootCallback, QueryMsgAsyncParam, QueryMessageOnlineCallback, QueryThreadHistoryMsgAsyncParam, QueryThreadHistoryMsgCallback, FullTextSearchOnlineAsyncParam, FullTextSearchOnlineAsyncCallback, IMMessage, QueryMsgByKeywordOnlineParam, QueryMsgOnlineAsyncParam, DeleteMsglogSelfNotifyItemInfo, DeleteMsglogSelfNotifyParam, MessageStatusChangedResult, QueryMsgByOptionsAsyncParam, QueryMsglogResult, NIMMsglogSearchDirection, GetMessagesDynamicallyCallback, GetMessagesResult } from '../nim_def/msglog_def';
4
+ import { NIMResCode } from '../nim_def/client_def';
5
+ export declare interface NIMMsgLogEvents {
6
+ /** 单向删除消息记录通知 */
7
+ localMsgDeleted: [Array<DeleteMsglogSelfNotifyItemInfo>];
8
+ /** 删除某一会话的云端的历史记录通知 */
9
+ onlineMsgDeleted: [Array<DeleteMsglogSelfNotifyParam>];
10
+ /** 消息状态变更 */
11
+ msgStatusChanged: [MessageStatusChangedResult];
12
+ }
13
+ export declare class NIMMsgLog extends EventEmitter<NIMMsgLogEvents> {
14
+ msglog: NIMMsgLogAPI;
15
+ constructor();
16
+ /** 注册全局回调 */
17
+ initEventHandlers(): void;
18
+ /** 根据消息ID查询本地(单条)消息
19
+ * @param clientMsgId 客户端消息ID
20
+ * @param jsonExtension json扩展参数(备用,目前不需要)
21
+ * @param cb 查询本地消息的回调函数
22
+ * @return boolean 检查参数如果不符合要求则返回失败
23
+ * @note
24
+ * <pre>
25
+ * 200:成功
26
+ * </pre>
27
+ */
28
+ queryMsgByIDAysnc(clientMsgId: string, cb: QuerySingleMsgCallback | null, jsonExtension: string): Promise<[NIMResCode, string, IMMessage] | null>;
29
+ /** 查询本地消息
30
+ * @param accid 查询id,account_id/uid或者tid
31
+ * @param to_type 会话类型,双人0,群组1 (见nim_msglog_def.h)
32
+ * @param limit_count 一次查询数量,建议20
33
+ * @param anchor_msg_time
34
+ * 作为此次查询的定位点的消息历史的消息时间戳(上次查询最后一条消息的时间戳,按指定的时间的顺序起查,默认为逆序,2.4.0之前命名为last_name)
35
+ * @param jsonExtension json扩展参数(备用,目前不需要)
36
+ * @param cb 查询本地消息的回调函数
37
+ * @return boolean 检查参数如果不符合要求则返回失败
38
+ * @note
39
+ * <pre>
40
+ * 200:成功
41
+ * </pre>
42
+ */
43
+ queryMsgAsync(accid: string, to_type: NIMSessionType, limit_count: number, anchor_msg_time: number, cb: QueryMsgCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
44
+ /** 查询历史消息,基于本地可信时间段信息来动态判断获取消息的途径
45
+ * @param session_id 会话id
46
+ * @param to_type 会话类型, 双人0,群组1, 超大群5
47
+ * @param from_time 开始时间, 包含
48
+ * @param to_time 结束时间, 大于from_time, 0表示当前时间; 只有在direction为kForward且anchor_client_msg_id不为空时才包含
49
+ * @param limit_count 查询数量
50
+ * @param anchor_client_msg_id 查询起始的客户端消息id, 查询结果不包括这条消息
51
+ * @param anchor_server_msg_id 查询起始的服务器消息id, 查询结果不包括这条消息
52
+ * @param direction 查询方向
53
+ * @param cb 查询消息的回调函数
54
+ * @param json_extension json扩展参数(备用,目前不需要)
55
+ * @return void
56
+ * @note 错误码 200:成功
57
+ */
58
+ getMessagesDynamically(session_id: string, to_type: NIMSessionType, from_time: number, to_time: number, limit_count: number, anchor_client_msg_id: string, anchor_server_msg_id: string, direction: NIMMsglogSearchDirection, cb: GetMessagesDynamicallyCallback | null, jsonExtension: string): Promise<[GetMessagesResult] | null>;
59
+ /** 在线查询消息(不包括系统消息)
60
+ * @param param 查询参数
61
+ * @param cb 在线查询消息的回调函数
62
+ * @return boolean 检查参数如果不符合要求则返回失败
63
+ * @note
64
+ * <pre>
65
+ * 200:成功
66
+ * 403:禁止访问(不在该群,只针对群组会话)
67
+ * 414:参数错误
68
+ * </pre>
69
+ */
70
+ queryMsgOnlineAsync(param: QueryMsgOnlineAsyncParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
71
+ /** 在线查询消息(不包括系统消息)
72
+ * @param param 查询参数
73
+ * @param cb 在线查询消息的回调函数
74
+ * @return boolean 检查参数如果不符合要求则返回失败
75
+ * @note
76
+ * <pre>
77
+ * 200:成功
78
+ * 403:禁止访问(不在该群,只针对群组会话)
79
+ * 414:参数错误
80
+ * </pre>
81
+ */
82
+ queryMsgByKeywordOnlineAsync(param: QueryMsgByKeywordOnlineParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
83
+ /** 根据指定条件在一个会话中查询指定单个或多个类型的本地消息
84
+ * @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
85
+ * @param id 查询id,对方的account id或者群组tid。
86
+ * @param limit_count 本次查询的消息条数上限(最多100条)
87
+ * @param fromTime 起始时间点,单位:毫秒
88
+ * @param endTime 结束时间点,单位:毫秒
89
+ * @param endClientMsgId 结束查询的最后一条消息的end_client_msg_id(不包含在查询结果中)
90
+ * @param reverse true:反向查询(按时间正序起查,正序排列),false:按时间逆序起查,逆序排列(建议默认为false)
91
+ * @param msgType 检索的消息类型
92
+ * @param jsonExtension json扩展参数(备用,目前不需要)
93
+ * @param cb 在线查询消息的回调函数
94
+ * @return boolean 检查参数如果不符合要求则返回失败
95
+ * @note
96
+ * <pre>
97
+ * 200:成功
98
+ * </pre>
99
+ */
100
+ queryMsgOfSpecifiedTypeInASessionAsync(to_type: NIMSessionType, id: string, limit_count: number, fromTime: number, endTime: number, endClientMsgId: string, reverse: boolean, msgType: Array<NIMMessageType>, cb: QueryMsgCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
101
+ /** 根据指定条件查询本地消息,使用此接口可以完成全局搜索等功能,具体请参阅开发手册
102
+ * @param param 查询参数
103
+ * @param cb 在线查询消息的回调函数
104
+ * @return boolean 检查参数如果不符合要求则返回失败
105
+ * @note
106
+ * <pre>
107
+ * 200:成功
108
+ * </pre>
109
+ */
110
+ queryMsgByOptionsAsync(param: QueryMsgByOptionsAsyncParam, cb: QueryMsgCallback | null): Promise<[NIMResCode, string, NIMSessionType, QueryMsglogResult] | null>;
111
+ /** 批量设置已读状态
112
+ * @param accid 查询id,account_id/uid或者tid
113
+ * @param to_type 会话类型,双人0,群组1 (见nim_msglog_def.h)
114
+ * @param jsonExtension json扩展参数(备用,目前不需要)
115
+ * @param cb 操作结果的回调函数
116
+ * @return boolean 检查参数如果不符合要求则返回失败
117
+ * @note
118
+ * <pre>
119
+ * 200:成功
120
+ * </pre>
121
+ */
122
+ batchStatusReadAsync(accid: string, to_type: NIMSessionType, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
123
+ /** 删除某个会话的全部聊天记录
124
+ * @param accid 要删除会话的id,account_id/uid或者tid
125
+ * @param to_type 会话类型,双人0,群组1 (见nim_msglog_def.h)
126
+ * @param revert_by_query_online 是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
127
+ * @param cb 操作结果的回调函数
128
+ * @param jsonExtension json扩展参数(备用,目前不需要)
129
+ * @return boolean 检查参数如果不符合要求则返回失败
130
+ * @note
131
+ * <pre>
132
+ * 200:成功
133
+ * </pre>
134
+ */
135
+ batchStatusDeleteAsync(accid: string, to_type: NIMSessionType, revert_by_query_online: boolean, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
136
+ /** 设置消息状态
137
+ * @param msg_id 消息id
138
+ * @param status 消息状态枚举值
139
+ * @param jsonExtension json扩展参数(备用,目前不需要)
140
+ * @param cb 操作结果的回调函数
141
+ * @return boolean 检查参数如果不符合要求则返回失败
142
+ * @note
143
+ * <pre>
144
+ * 200:成功
145
+ * </pre>
146
+ */
147
+ setStatusAsync(msg_id: string, status: NIMMsgLogStatus, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string] | null>;
148
+ /** 设置消息子状态
149
+ * @param msg_id 消息id
150
+ * @param status 消息子状态枚举值
151
+ * @param jsonExtension json扩展参数(备用,目前不需要)
152
+ * @param cb 操作结果的回调函数
153
+ * @return boolean 检查参数如果不符合要求则返回失败
154
+ * @note
155
+ * <pre>
156
+ * 200:成功
157
+ * </pre>
158
+ */
159
+ setSubStatusAsync(msg_id: string, status: NIMMsgLogSubStatus, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string] | null>;
160
+ /** 只往本地消息历史数据库里写入一条消息(如果已存在这条消息,则更新。通常是APP的本地自定义消息,并不会发给服务器)
161
+ * @param talkId 会话id,对方的account id或者群组tid
162
+ * @param msg 消息内容
163
+ * @param needUpdateSession 是否更新会话列表(一般最新一条消息有这个需求)
164
+ * @param composeLastMsg 如果消息历史中有该会话的消息,是否将该会话最后一条消息随会话变更上报,true 为携带,否则不携带
165
+ * @param excludeMsgType 如果 compose_last_msg = true,则可根据需要排除指定最后一条消息的类型
166
+ * @param cb 操作结果的回调函数
167
+ * @return boolean 检查参数如果不符合要求则返回失败
168
+ * @note
169
+ * <pre>
170
+ * 200:成功
171
+ * </pre>
172
+ */
173
+ writeMsglogToLocalAsync(talkId: string, msg: IMMessage, needUpdateSession: boolean, composeLastMsg: boolean, excludeMsgType: Array<number>, cb: ModifySingleMsglogCallback | null): Promise<[NIMResCode, string] | null>;
174
+ /** 删除指定会话类型的所有消息
175
+ * @param delSessions 是否删除会话
176
+ * @param to_type 会话类型
177
+ * @param revert_by_query_online 是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
178
+ * @param jsonExtension json扩展参数(备用,目前不需要)
179
+ * @param cb 操作结果的回调函数
180
+ * @return boolean 检查参数如果不符合要求则返回失败
181
+ * @note
182
+ * <pre>
183
+ * 200:成功
184
+ * </pre>
185
+ */
186
+ deleteBySessionTypeAsync(delSessions: boolean, to_type: NIMSessionType, revert_by_query_online: boolean, cb: ModifyMultipleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string, NIMSessionType] | null>;
187
+ /** 删除指定一条消息
188
+ * @param session_id 会话id,对方的account id或者群组tid
189
+ * @param to_type 会话类型
190
+ * @param msg_id 消息id
191
+ * @param jsonExtension json扩展参数(备用,目前不需要)
192
+ * @param cb 操作结果的回调函数
193
+ * @return boolean 检查参数如果不符合要求则返回失败
194
+ * @note
195
+ * <pre>
196
+ * 200:成功
197
+ * </pre>
198
+ */
199
+ deleteAsync(session_id: string, to_type: NIMSessionType, msg_id: string, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string] | null>;
200
+ /** 删除全部消息历史
201
+ * @param del_session 是否删除所有会话列表项(即全部最近联系人)。
202
+ ture则删除,并通过nim_session_reg_change_cb注册的回调通知上层kNIMSessionCommandRemoveAll事件(不会触发每个会话项的kNIMSessionCommandRemove事件);
203
+ false则不删除,并将所有会话项的最后一条消息的状态kNIMSessionMsgStatus设置为已删除状态,并通过nim_session_reg_change_cb注册的回调通知上层kNIMSession
204
+ CommandAllMsgDeleted事件(不会触发每个会话项的kNIMSessionCommandUpdate事件,避免频繁通知上层)。
205
+ * @param revert_by_query_online 是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
206
+ * @param jsonExtension json扩展参数(备用,目前不需要)
207
+ * @param cb 操作结果的回调函数
208
+ * @return boolean 检查参数如果不符合要求则返回失败
209
+ * @note
210
+ * <pre>
211
+ * 200:成功
212
+ * </pre>
213
+ */
214
+ deleteAllAsync(del_session: boolean, revert_by_query_online: boolean, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
215
+ /** 根据时间段删除部分会话的历史消息
216
+ * @param session_id 要删除消息的会话ID
217
+ * @param to_type 要删除消息的会话类型
218
+ * @param revert_by_query_online 是否可以通过服务端查询消息记录(含入库选项)进行恢复,true:是,false:否
219
+ * @param timestamp1 单位ms timestamp1 与 timestamp2 组成一个时间段,SDK 内部会判断大小调整入参顺序
220
+ * @param timestamp2 单位ms timestamp2 与 timestamp1 组成一个时间段,SDK 内部会判断大小调整入参顺序
221
+ * @param jsonExtension json扩展参数(备用,目前不需要)
222
+ * @param cb 操作结果的回调函数
223
+ * @return boolean 检查参数如果不符合要求则返回失败
224
+ * @note
225
+ * <pre>
226
+ * 200:成功
227
+ * </pre>
228
+ */
229
+ deleteMsgByTimeAsync(session_id: string, to_type: NIMSessionType, revert_by_query_online: boolean, timestamp1: number, timestamp2: number, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
230
+ /** 导出整个消息历史DB文件(不包括系统消息历史)
231
+ * @param dst_path 导出时保存的目标全路径(UTF-8编码)。
232
+ * @param jsonExtension json扩展参数(备用,目前不需要)
233
+ * @param cb 操作结果的回调函数
234
+ * @return boolean 检查参数如果不符合要求则返回失败
235
+ * @note
236
+ * <pre>
237
+ * 200:成功
238
+ * </pre>
239
+ */
240
+ exportDbAsync(dst_path: string, cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
241
+ /** 导入消息历史DB文件(不包括系统消息历史)。先验证是否自己的消息历史文件和DB加密密钥(见nim_client_def.h里的kNIMDataBaseEncryptKey),如果验证不通过,则不导入。
242
+ * @param src_path 导入源文件的全路径(UTF-8编码)。
243
+ * @param jsonExtension json扩展参数(备用,目前不需要)
244
+ * @param cb 操作结果的回调函数
245
+ * @param prg_cb 导入进度的回调函数
246
+ * @return boolean 检查参数如果不符合要求则返回失败
247
+ * @note
248
+ * <pre>
249
+ * 200:成功
250
+ * 10600:导入消息历史时验证身份和加密密钥不通过
251
+ * 10601:导入消息历史时写记录失败
252
+ * </pre>
253
+ */
254
+ importDbAsync(src_path: string, cb: DBFunctionCallback, prg_cb: ImportDbPrgCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
255
+ /** 发送消息已读回执
256
+ * @param msg 已读消息
257
+ * @param cb 操作结果的回调函数
258
+ * @return void 无返回值
259
+ * @note
260
+ * <pre>
261
+ * 200:成功
262
+ * 403:服务器关闭此功能,或者应用没权限
263
+ * 404:请求的目标(用户或对象)不存在
264
+ * 10414:本地错误码,参数错误
265
+ * </pre>
266
+ */
267
+ sendReceiptAsync(msg: IMMessage, cb: MessageStatusChangedCallback | null): Promise<[MessageStatusChangedResult]>;
268
+ /** 查询自己发送的消息是否被对方已读
269
+ * @param msg 消息。
270
+ * @return boolean 是否被已读
271
+ */
272
+ querySentMessageBeReaded(msg: IMMessage): boolean;
273
+ /** 查询收到的消息是否已经发送过已读回执
274
+ * @param msg 消息。
275
+ * @return boolean 是否已发送过
276
+ */
277
+ queryReceivedMsgReceiptSent(msg: IMMessage): boolean;
278
+ /** 更新本地消息扩展字段内容
279
+ * @param msg_id 消息id
280
+ * @param local_ext 本地扩展字段内容
281
+ * @param jsonExtension json扩展参数(备用,目前不需要)
282
+ * @param cb 操作结果的回调函数
283
+ * @return boolean 检查参数如果不符合要求则返回失败
284
+ * @note
285
+ * <pre>
286
+ * 200:成功
287
+ * </pre>
288
+ */
289
+ updateLocalExtAsync(msg_id: string, local_ext: string, cb: ModifySingleMsglogCallback | null, jsonExtension: string): Promise<[NIMResCode, string]>;
290
+ /** 全部未读消息历史标记为已读
291
+ * @param jsonExtension json扩展参数(备用,目前不需要)
292
+ * @param cb 操作结果的回调函数
293
+ * @return boolean 检查参数如果不符合要求则返回失败
294
+ * @note
295
+ * <pre>
296
+ * 200:成功
297
+ * </pre>
298
+ */
299
+ readAllAsync(cb: DBFunctionCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
300
+ /** 导出本地消息记录到云端
301
+ * @param export_info 导出需要的参数参考LogsBackupExportInfo定义
302
+ * @return boolean false : 当前有导入/导出操作正在进行中
303
+ */
304
+ exportBackupToRemote(export_info: LogsBackupExportInfo): boolean;
305
+ /** 导入已备份在云端的消息记录
306
+ * @param import_info 导入需要的参数参考LogsBackupImportInfo定义
307
+ * @return boolean false : 当前有导入/导出操作正在进行中
308
+ */
309
+ importBackupToRemote(export_info: LogsBackupImportInfo): boolean;
310
+ /** 取消导入已备份在云端的消息记录
311
+ * @return void
312
+ */
313
+ cancelImportBackupFromRemote(): void;
314
+ /** 取消导出本地消息记录到云端
315
+ * @return void
316
+ */
317
+ cancelExportBackupToRemote(): void;
318
+ /** 删除与某账号的所有云端历史记录与漫游消息(p2p)
319
+ * @param accid 对方的accid
320
+ * @param del_remote 是否同时删除所有的漫游消息 true : 是 false : 否
321
+ * @param jsonExtension json扩展参数(备用,目前不需要)
322
+ * @param cb 操作结果的回调函数
323
+ * @return void
324
+ * @note
325
+ * <pre>
326
+ * 200:成功
327
+ * </pre>
328
+ */
329
+ deleteHistoryOnlineAsync(accid: string, del_remote: boolean, jsonExtension: string, cb: DeleteHistoryOnLineAsyncCallback | null): Promise<[NIMResCode, string]>;
330
+ /** 删除某一会话的云端的历史记录[v8.0.0]
331
+ * @param accid 对方的accid(p2p:accid team:tid)
332
+ * @param to_type 会话类型,双人0,群组1 (见nim_msglog_def.h)
333
+ * @param needs_notify_self 是否通知其它终端
334
+ * @param jsonExtension 扩展字段
335
+ * @param cb 操作结果的回调函数
336
+ * @return void
337
+ * @note 错误码 200:成功
338
+ */
339
+ deleteHistoryOnlineAsyncEx(accid: string, to_type: number, needs_notify_self: boolean, jsonExtension: string, cb: DeleteHistoryOnLineAsyncExCallback | null): Promise<[NIMResCode, string, number, number, string]>;
340
+ /** 单向删除某条消息记录(同时删除本地与云端)
341
+ * @param msg 要删除的消息
342
+ * @param exts 用户自定义扩展字段
343
+ * @param cb 操作结果的回调函数
344
+ * @return void 无返回值
345
+ * @note
346
+ * <pre>
347
+ * 200:成功
348
+ * </pre>
349
+ */
350
+ deleteMessageSelfAsync(msg: IMMessage, ext: string, cb: DeleteMessageSelfAsyncCallback | null): Promise<[NIMResCode]>;
351
+ /** 查询某条消息是否为thread聊天的根消息
352
+ * @param client_id 要查询的消息的客户端ID
353
+ * @param cb 操作结果的回调函数
354
+ * @return void 无返回值
355
+ * @note
356
+ * <pre>
357
+ * 200:成功
358
+ * </pre>
359
+ */
360
+ queryMessageIsThreadRoot(client_id: string, cb: QueryMessageIsThreadRootCallback | null): Promise<[NIMResCode, string, boolean]>;
361
+ /** 查询某条消息的具体内容一般用在thread talk 场景中
362
+ * @param param 要查询的消息的相关参数,可以在msglog.threadinfo中得到
363
+ * @param cb 查询结果的回调函数
364
+ * @return void 无返回值
365
+ * @note
366
+ * <pre>
367
+ * 200:成功
368
+ * </pre>
369
+ */
370
+ queryMessageOnline(param: QueryMsgAsyncParam, cb: QueryMessageOnlineCallback | null): Promise<[NIMResCode, string, IMMessage]>;
371
+ /** 分页查询thread talk消息历史
372
+ * @param msg 要查询的消息
373
+ * @param param 要查询的消息的相关参数,可以在msglog.threadinfo中得到
374
+ * @param cb 查询结果的回调函数
375
+ * @return void 无返回值
376
+ * @note
377
+ * <pre>
378
+ * 200:成功
379
+ * </pre>
380
+ */
381
+ queryThreadHistoryMsg(msg: IMMessage, param: QueryThreadHistoryMsgAsyncParam, cb: QueryThreadHistoryMsgCallback | null): Promise<[NIMResCode, IMMessage, number, number, Array<IMMessage>]>;
382
+ /** 在线全文检索
383
+ * @param param 全文检索参数
384
+ * @param cb 全文检索结果回调函数
385
+ * @return void 无返回值
386
+ * @note
387
+ * <pre>
388
+ * 200:成功
389
+ * </pre>
390
+ */
391
+ fullTextSearchOnlineAsync(param: FullTextSearchOnlineAsyncParam, cb: FullTextSearchOnlineAsyncCallback | null): Promise<[NIMResCode, QueryMsglogResult]>;
392
+ }