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
@@ -0,0 +1,110 @@
1
+ import { V2NIMError, V2NIMConversation, V2NIMConversationFilter, V2NIMConversationOperationResult, V2NIMConversationUpdate, V2NIMConversationResult, V2NIMConversationOption } from 'ts/v2_def/v2_nim_struct_def';
2
+ import { EventEmitter } from 'eventemitter3';
3
+ export declare interface V2NIMConversationServiceEvents {
4
+ /** 会话同步开始通知 */
5
+ syncStarted: [];
6
+ /** 会话同步完成通知 */
7
+ syncFinished: [];
8
+ /** 会话同步错误通知 */
9
+ syncFailed: [V2NIMError];
10
+ /** 会话创建通知 */
11
+ conversationCreated: [V2NIMConversation];
12
+ /** 会话删除通知 */
13
+ conversationDeleted: [Array<string>];
14
+ /** 会话更新通知 */
15
+ conversationChanged: [Array<V2NIMConversation>];
16
+ /** 会话总未读数变更通知 */
17
+ totalUnreadCountChanged: [number];
18
+ /** 根据过滤条件订阅的会话未读数变更通知 */
19
+ unreadCountChangedByFilter: [V2NIMConversationFilter, number];
20
+ }
21
+ export declare class V2NIMConversationService extends EventEmitter<V2NIMConversationServiceEvents> {
22
+ instance: any;
23
+ constructor();
24
+ /** @brief 创建空会话
25
+ * @param conversationId 会话 ID
26
+ */
27
+ createConversation(conversationId: string): Promise<V2NIMConversation>;
28
+ /** @brief 删除会话
29
+ * @param conversationId 会话 ID
30
+ * @param clearMessage 是否清除会话消息
31
+ */
32
+ deleteConversation(conversationId: string, clearMessage: boolean): Promise<void>;
33
+ /** @brief 批量删除会话
34
+ * @param conversationIds 会话ID列表
35
+ * @param clearMessage 是否清除会话消息
36
+ */
37
+ deleteConversationListByIds(conversationIds: string[], clearMessage: boolean): Promise<Array<V2NIMConversationOperationResult>>;
38
+ /** @brief 置顶会话
39
+ * @param conversationId 会话 ID
40
+ * @param stickTop 是否置顶
41
+ */
42
+ stickTopConversation(conversationId: string, stickTop: boolean): Promise<void>;
43
+ /** @brief 更新会话
44
+ * @param conversationId 会话 ID
45
+ * @param updateInfo 更新参数
46
+ */
47
+ updateConversation(conversationId: string, updateInfo: V2NIMConversationUpdate): Promise<void>;
48
+ /** @brief 更新会话本地扩展
49
+ * @param conversationId 会话 ID
50
+ * @param localExtension 本地扩展
51
+ */
52
+ updateConversationLocalExtension(conversationId: string, localExtension: string): Promise<void>;
53
+ /** @brief 获取会话
54
+ * @param conversationId 会话 ID
55
+ */
56
+ getConversation(conversationId: string): Promise<V2NIMConversation>;
57
+ /** @brief 分页获取会话列表
58
+ * @param offset 分页偏移, 首页传 0, 后续拉取采用上一次返还的 offset
59
+ * @param limit 分页数量
60
+ */
61
+ getConversationList(offset: number, limit: number): Promise<V2NIMConversationResult>;
62
+ /** @brief 根据会话ID获取会话列表
63
+ * @param conversationIds 会话ID列表
64
+ */
65
+ getConversationListByIds(conversationIds: string[]): Promise<Array<V2NIMConversation>>;
66
+ /** @brief 根据条件筛选分页获取会话列表
67
+ * @param offset 分页偏移, 首页传 0, 后续拉取采用上一次返还的 offset
68
+ * @param limit 分页数量
69
+ * @param option 查询参数
70
+ */
71
+ getConversationListByOption(offset: number, limit: number, option: V2NIMConversationOption): Promise<V2NIMConversationResult>;
72
+ /** @brief 获取会话未读总数
73
+ * @param conversationId 会话 ID
74
+ * @return uint32_t 未读总数
75
+ */
76
+ getTotalUnreadCount(): number;
77
+ /** @brief 根据会话 ID 列表获取未读总数
78
+ * @param conversationIds 会话 ID 列表
79
+ */
80
+ getUnreadCountByIds(conversationIds: string[]): Promise<number>;
81
+ /** @brief 根据过滤条件获取会话未读总数
82
+ * @param filter 过滤条件
83
+ */
84
+ getUnreadCountByFilter(filter: V2NIMConversationFilter): Promise<number>;
85
+ /** @brief 清除会话总未读数
86
+ */
87
+ clearTotalUnreadCount(): Promise<void>;
88
+ /** @brief 根据会话 ID 列表清除会话未读数
89
+ * @param conversationIds 会话 ID 列表
90
+ */
91
+ clearUnreadCountByIds(conversationIds: string[]): Promise<Array<V2NIMConversationOperationResult>>;
92
+ /** @brief 根据会话类型清除会话未读数
93
+ * @param conversationTypes 会话类型列表
94
+ */
95
+ clearUnreadCountByTypes(conversationTypes: V2NIMConversationType[]): Promise<void>;
96
+ /** @brief 根据会话分组清除会话未读数
97
+ * @param groupId 会话分组ID
98
+ */
99
+ clearUnreadCountByGroupId(groupId: string): Promise<void>;
100
+ /** @brief 订阅指定过滤条件的会话未读数
101
+ * @param filter 过滤条件
102
+ * @return void
103
+ */
104
+ subscribeUnreadCountByFilter(filter: V2NIMConversationFilter): null | V2NIMError;
105
+ /** @brief 取消订阅指定过滤条件的会话未读数
106
+ * @param filter 过滤条件
107
+ * @return void
108
+ */
109
+ unsubscribeUnreadCountByFilter(filter: V2NIMConversationFilter): null | V2NIMError;
110
+ }
@@ -0,0 +1,58 @@
1
+ import { V2NIMFriend, V2NIMFriendAddApplication, V2NIMFriendAddRejection, V2NIMFriendAddParams, V2NIMFriendDeleteParams, V2NIMFriendSetParams, V2NIMFriendAddApplicationQueryOption, V2NIMFriendAddApplicationResult } from 'ts/v2_def/v2_nim_struct_def';
2
+ import { EventEmitter } from 'eventemitter3';
3
+ export declare interface V2NIMFriendServiceEvents {
4
+ /** 添加好友 */
5
+ friendAdded: [V2NIMFriend];
6
+ /** 删除好友 */
7
+ friendDeleted: [string, V2NIMFriendDeletionType];
8
+ /** 添加好友申请 */
9
+ friendAddApplication: [V2NIMFriendAddApplication];
10
+ /** 添加好友申请被拒绝 */
11
+ friendAddRejected: [V2NIMFriendAddRejection];
12
+ /** 更新好友信息 */
13
+ friendInfoChanged: [V2NIMFriend];
14
+ }
15
+ /** @brief 好友服务 */
16
+ export declare class V2NIMFriendService extends EventEmitter<V2NIMFriendServiceEvents> {
17
+ instance: any;
18
+ constructor();
19
+ /** @brief 添加好友 */
20
+ /** @param accountId 账号 ID */
21
+ /** @param params 添加好友参数 */
22
+ /** @return void */
23
+ addFriend(accountId: string, params: V2NIMFriendAddParams): Promise<void>;
24
+ /** @brief 删除好友 */
25
+ /** @param accountId 账号 ID */
26
+ /** @param params 删除好友参数 */
27
+ /** @return void */
28
+ deleteFriend(accountId: string, params: V2NIMFriendDeleteParams): Promise<void>;
29
+ /** @brief 接受好友申请 */
30
+ /** @param application 好友申请 */
31
+ /** @return void */
32
+ acceptAddApplication(application: V2NIMFriendAddApplication): Promise<void>;
33
+ /** @brief 拒绝好友申请 */
34
+ /** @param application 好友申请 */
35
+ /** @param postscript 拒绝理由 */
36
+ /** @return void */
37
+ rejectAddApplication(application: V2NIMFriendAddApplication, postscript: String): Promise<void>;
38
+ /** @brief 设置好友信息 */
39
+ /** @param accountId 账号 ID */
40
+ /** @param params 设置好友信息参数 */
41
+ /** @return void */
42
+ setFriendInfo(accountId: string, params: V2NIMFriendSetParams): Promise<void>;
43
+ /** @brief 获取好友列表 */
44
+ /** @return void */
45
+ getFriendList(): Promise<Array<V2NIMFriend>>;
46
+ /** @brief 根据账号 ID 获取好友信息 */
47
+ /** @param accountIds 账号 ID 列表 */
48
+ /** @return void */
49
+ getFriendByIds(accountIds: Array<string>): Promise<Array<V2NIMFriend>>;
50
+ /** @brief 根据账号 ID 检查好友状态 */
51
+ /** @param accountIds 账号 ID 列表 */
52
+ /** @return void */
53
+ checkFriend(accountIds: Array<string>): Promise<Map<string, boolean>>;
54
+ /** @brief 获取申请添加好友信息列表 */
55
+ /** @param option 查询申请添加好友相关信息参数 */
56
+ /** @return void */
57
+ getAddApplicationList(option: V2NIMFriendAddApplicationQueryOption): Promise<V2NIMFriendAddApplicationResult>;
58
+ }
@@ -1,96 +1,80 @@
1
- import { V2NIMDataSyncDetail, V2NIMError, V2NIMKickedOfflineDetail, V2NIMLoginClient, V2NIMLoginOption } from 'ts/v2_def/v2_nim_struct_def';
2
- import { EventEmitter } from 'eventemitter3';
3
- import { V2NIMReconnectDelayProvider } from 'ts/v2_def/v2_nim_callback_def';
4
- export declare interface V2NIMLoginServiceEvents {
5
- /** 登录状态变更回调 */
6
- onLoginStatus: [V2NIMLoginStatus];
7
- /** 登录失败回调 */
8
- onLoginFailed: [V2NIMError];
9
- /** 被踢下线回调 */
10
- onKickedOffline: [V2NIMKickedOfflineDetail];
11
- /** 登录客户端变更回调 */
12
- onLoginClientChanged: [V2NIMLoginClientChange, V2NIMLoginClient[]];
13
- }
14
- export declare class V2NIMLoginService extends EventEmitter<V2NIMLoginServiceEvents> {
15
- instance: any;
16
- loginDetail: V2NIMLoginDetail;
17
- constructor();
18
- /**
19
- * 登录接口
20
- * @param account 账号
21
- * @param token 密码
22
- * @param option 登录选项
23
- * @returns Promise<void>
24
- */
25
- login(account: string, token: string, option: V2NIMLoginOption): Promise<void>;
26
- /**
27
- * 登出接口
28
- * @returns Promise<void>
29
- */
30
- logout(): Promise<void>;
31
- /**
32
- * 获取当前登录用户
33
- * @returns string 当前登录用户
34
- */
35
- getLoginUser(): string;
36
- /**
37
- * 获取登录状态
38
- * @returns V2NIMLoginStatus 登录状态
39
- */
40
- getLoginStatus(): V2NIMLoginStatus;
41
- /**
42
- * 获取登录客户端列表
43
- * @returns V2NIMLoginClient[] 登录客户端列表
44
- */
45
- getLoginClients(): V2NIMLoginClient[];
46
- /**
47
- * 踢掉登录客户端下线
48
- * @param client 登录客户端
49
- * @returns Promise<void>
50
- */
51
- kickOffline(client: V2NIMLoginClient): Promise<void>;
52
- /**
53
- * 获取被踢下线原因
54
- * @returns V2NIMKickedOfflineDetail 被踢下线原因
55
- */
56
- getKickedOfflineDetail(): V2NIMKickedOfflineDetail;
57
- /**
58
- * 获取登录详情信息
59
- * @returns V2NIMLoginDetail 登录详情信息
60
- */
61
- getLoginDetail(): V2NIMLoginDetail;
62
- }
63
- export declare interface V2NIMLoginDetailEvents {
64
- /** 连接状态变更回调 */
65
- onConnectStatus: [V2NIMConnectStatus];
66
- /** 连接断开回调 */
67
- onDisconnected: [V2NIMError | null];
68
- /** 连接成功回调 */
69
- onConnectSuccess: [];
70
- /** 连接失败回调 */
71
- onConnectFailed: [V2NIMError];
72
- /** 连接中回调 */
73
- onConnecting: [];
74
- /** 数据同步回调 */
75
- onDataSync: [V2NIMDataSyncType, V2NIMDataSyncState, V2NIMError | null];
76
- }
77
- export declare class V2NIMLoginDetail extends EventEmitter<V2NIMLoginDetailEvents> {
78
- instance: any;
79
- constructor();
80
- /**
81
- * 获取连接状态
82
- * @returns V2NIMConnectStatus 连接状态
83
- */
84
- getConnectStatus(): V2NIMConnectStatus;
85
- /**
86
- * 获取数据同步状态
87
- * @returns V2NIMDataSyncDetail[] 数据同步状态列表
88
- */
89
- getDataSync(): V2NIMDataSyncDetail[];
90
- /**
91
- * 设置获取重连延时回调
92
- * @param provider 获取重连延时回调
93
- * @returns void
94
- */
95
- setReconnectDelayProvider(provider: V2NIMReconnectDelayProvider): void;
96
- }
1
+ import { V2NIMDataSyncDetail, V2NIMError, V2NIMKickedOfflineDetail, V2NIMLoginClient, V2NIMLoginOption } from 'ts/v2_def/v2_nim_struct_def';
2
+ import { EventEmitter } from 'eventemitter3';
3
+ import { V2NIMReconnectDelayProvider } from 'ts/v2_def/v2_nim_callback_def';
4
+ export declare interface V2NIMLoginServiceEvents {
5
+ /** 登录状态变更回调 */
6
+ loginStatus: [V2NIMLoginStatus];
7
+ /** 登录失败回调 */
8
+ loginFailed: [V2NIMError];
9
+ /** 被踢下线回调 */
10
+ kickedOffline: [V2NIMKickedOfflineDetail];
11
+ /** 登录客户端变更回调 */
12
+ loginClientChanged: [V2NIMLoginClientChange, V2NIMLoginClient[]];
13
+ /** 连接状态变更回调 */
14
+ connectStatus: [V2NIMConnectStatus];
15
+ /** 连接断开回调 */
16
+ disconnected: [V2NIMError | null];
17
+ /** 连接失败回调 */
18
+ connectFailed: [V2NIMError];
19
+ /** 数据同步回调 */
20
+ dataSync: [V2NIMDataSyncType, V2NIMDataSyncState, V2NIMError | null];
21
+ }
22
+ export declare class V2NIMLoginService extends EventEmitter<V2NIMLoginServiceEvents> {
23
+ instance: any;
24
+ constructor();
25
+ /**
26
+ * 登录接口
27
+ * @param accountId 账号
28
+ * @param token 密码
29
+ * @param option 登录选项
30
+ * @returns Promise<void>
31
+ */
32
+ login(accountId: string, token: string, option: V2NIMLoginOption): Promise<void>;
33
+ /**
34
+ * 登出接口
35
+ * @returns Promise<void>
36
+ */
37
+ logout(): Promise<void>;
38
+ /**
39
+ * 获取当前登录用户
40
+ * @returns string 当前登录用户
41
+ */
42
+ getLoginUser(): string;
43
+ /**
44
+ * 获取登录状态
45
+ * @returns V2NIMLoginStatus 登录状态
46
+ */
47
+ getLoginStatus(): V2NIMLoginStatus;
48
+ /**
49
+ * 获取登录客户端列表
50
+ * @returns V2NIMLoginClient[] 登录客户端列表
51
+ */
52
+ getLoginClients(): V2NIMLoginClient[];
53
+ /**
54
+ * 踢掉登录客户端下线
55
+ * @param client 登录客户端
56
+ * @returns Promise<void>
57
+ */
58
+ kickOffline(client: V2NIMLoginClient): Promise<void>;
59
+ /**
60
+ * 获取被踢下线原因
61
+ * @returns V2NIMKickedOfflineDetail 被踢下线原因
62
+ */
63
+ getKickedOfflineDetail(): V2NIMKickedOfflineDetail;
64
+ getConnectStatus(): V2NIMConnectStatus;
65
+ /**
66
+ * 获取数据同步状态
67
+ * @returns V2NIMDataSyncDetail[] 数据同步状态列表
68
+ */
69
+ getDataSync(): V2NIMDataSyncDetail[];
70
+ /** @brief 获取聊天室 link 地址 */
71
+ /** @param roomId 聊天室 ID */
72
+ /** @return void */
73
+ getChatroomLinkAddress(roomId: string): Promise<Array<string>>;
74
+ /**
75
+ * 设置获取重连延时回调
76
+ * @param provider 获取重连延时回调
77
+ * @returns void
78
+ */
79
+ setReconnectDelayProvider(provider: V2NIMReconnectDelayProvider): void;
80
+ }
@@ -0,0 +1,143 @@
1
+ import { V2NIMMessage, V2NIMSendMessageParams, V2NIMSendMessageResult, V2NIMMessageRevokeParams, V2NIMMessageListOption, V2NIMMessageRefer, V2NIMClearHistoryMessageOption, V2NIMMessagePin, V2NIMMessageQuickCommentPushConfig, V2NIMMessageQuickComment, V2NIMAddCollectionParams, V2NIMCollection, V2NIMCollectionOption, V2NIMP2PMessageReadReceipt, V2NIMTeamMessageReadReceipt, V2NIMTeamMessageReadReceiptDetail, V2NIMVoiceToTextParams, V2NIMMessageSearchParams, V2NIMClearHistoryNotification, V2NIMMessageDeletedNotification, V2NIMMessagePinNotification, V2NIMMessageQuickCommentNotification, V2NIMMessageRevokeNotification } from 'ts/v2_def/v2_nim_struct_def';
2
+ import { EventEmitter } from 'eventemitter3';
3
+ import { V2NIMProgressCallback } from 'ts/v2_def/v2_nim_callback_def';
4
+ export declare interface V2NIMMessageServiceEvents {
5
+ /** 收到一条新消息 */
6
+ receiveMessages: [Array<V2NIMMessage>];
7
+ /** 点对点已读回执 */
8
+ receiveP2PMessageReadReceipts: [Array<V2NIMP2PMessageReadReceipt>];
9
+ /** 群已读回执 */
10
+ receiveTeamMessageReadReceipts: [Array<V2NIMTeamMessageReadReceipt>];
11
+ /** 消息撤回通知 */
12
+ messageRevokeNotifications: [Array<V2NIMMessageRevokeNotification>];
13
+ /** 消息 pin 状态通知 */
14
+ messagePinNotification: [V2NIMMessagePinNotification];
15
+ /** 消息快捷评论通知 */
16
+ messageQuickCommentNotification: [V2NIMMessageQuickCommentNotification];
17
+ /** 消息被删除通知 */
18
+ messageDeletedNotifications: [Array<V2NIMMessageDeletedNotification>];
19
+ /** 清空会话历史消息通知 */
20
+ clearHistoryNotifications: [Array<V2NIMClearHistoryNotification>];
21
+ }
22
+ /** @brief 消息服务 */
23
+ export declare class V2NIMMessageService extends EventEmitter<V2NIMMessageServiceEvents> {
24
+ instance: any;
25
+ constructor();
26
+ /** @brief 发送消息 */
27
+ /** @param message 要发送的消息 */
28
+ /** @param conversationId 发送目标会话 */
29
+ /** @param params 发送参数 */
30
+ sendMessage(message: V2NIMMessage, conversationId: string, params: V2NIMSendMessageParams, progressCallback: V2NIMProgressCallback): Promise<V2NIMSendMessageResult>;
31
+ /** @brief 回复消息 */
32
+ /** @param message 要发送的消息 */
33
+ /** @param replyMessage 被回复的消息 */
34
+ /** @param params 发送参数 */
35
+ replyMessage(message: V2NIMMessage, replyMessage: V2NIMMessage, params: V2NIMSendMessageParams, progressCallback: V2NIMProgressCallback): Promise<V2NIMSendMessageResult>;
36
+ /** @brief 撤回消息 */
37
+ /** @param message 要撤回的消息 */
38
+ revokeMessage(message: V2NIMMessage, params: V2NIMMessageRevokeParams): Promise<void>;
39
+ /** @brief 查询消息 */
40
+ /** @param option 查询消息配置选项 */
41
+ getMessageList(option: V2NIMMessageListOption): Promise<Array<V2NIMMessage>>;
42
+ /** @brief 根据 ID 列表查询消息 */
43
+ /** @param messageClientIds 消息客户端 ID 列表 */
44
+ getMessageListByIds(messageClientIds: Array<string>): Promise<Array<V2NIMMessage>>;
45
+ /** @brief 根据消息引用列表查询消息 */
46
+ /** @param messageRefers 消息引用列表 */
47
+ getMessageListByRefers(messageRefers: Array<V2NIMMessageRefer>): Promise<Array<V2NIMMessage>>;
48
+ /** @brief 删除消息 */
49
+ /** @param message 需要删除的消息 */
50
+ /** @param serverExtension 服务器扩展字段 */
51
+ /** @param onlyDeleteLocal 是否只删除本地消息 */
52
+ deleteMessage(message: V2NIMMessage, serverExtension: string, onlyDeleteLocal: boolean): Promise<void>;
53
+ /** @brief 批量删除消息 */
54
+ /** @param messages 需要删除的消息列表 */
55
+ /** @param serverExtension 服务器扩展字段 */
56
+ /** @param onlyDeleteLocal 是否只删除本地消息 */
57
+ deleteMessages(messages: Array<V2NIMMessage>, serverExtension: string, onlyDeleteLocal: boolean): Promise<void>;
58
+ /** @brief 清空历史消息 */
59
+ /** @param option 清空历史消息配置选项 */
60
+ clearHistoryMessage(option: V2NIMClearHistoryMessageOption): Promise<void>;
61
+ /** @brief 更新消息本地扩展 */
62
+ /** @param message 要更新的消息 */
63
+ /** @param localExtension 本地扩展字段 */
64
+ updateMessageLocalExtension(message: V2NIMMessage, localExtension: string): Promise<V2NIMMessage>;
65
+ /** @brief 插入本地消息 */
66
+ /** @param message 要插入的消息 */
67
+ /** @param conversationId 会话 ID */
68
+ /** @param senderId 发送者 ID, 传空表示当前用户 */
69
+ /** @param createTime 消息创建时间, 0 表示使用当前时间 */
70
+ insertMessageToLocal(message: V2NIMMessage, conversationId: string, senderId: string, createTime: number): Promise<V2NIMMessage>;
71
+ /** @brief pin 消息 */
72
+ /** @param message 要 pin 的消息 */
73
+ /** @param serverExtension 扩展字段 */
74
+ pinMessage(message: V2NIMMessage, serverExtension: string): Promise<void>;
75
+ /** @brief 取消 pin 消息 */
76
+ /** @param message 要 unpin 的消息引用 */
77
+ /** @param serverExtension 扩展字段 */
78
+ unpinMessage(messageRefer: V2NIMMessageRefer, serverExtension: string): Promise<void>;
79
+ /** @brief 更新 pin 消息 */
80
+ /** @param message 要更新的 pin 消息 */
81
+ /** @param serverExtension 扩展字段 */
82
+ updatePinMessage(message: V2NIMMessage, serverExtension: string): Promise<void>;
83
+ /** @brief 获取 pin 消息列表 */
84
+ /** @param conversationId 会话 ID */
85
+ getPinnedMessageList(conversationId: string): Promise<Array<V2NIMMessagePin>>;
86
+ /** @brief 添加快捷评论 */
87
+ /** @param message 要添加快捷评论的消息 */
88
+ /** @param index 快捷评论索引 */
89
+ /** @param serverExtension 服务器扩展字段 */
90
+ /** @param pushConfig 推送配置 */
91
+ addQuickComment(message: V2NIMMessage, index: string, serverExtension: string, pushConfig: V2NIMMessageQuickCommentPushConfig): Promise<void>;
92
+ /** @brief 移除快捷评论 */
93
+ /** @param messageRefer 要移除快捷评论的消息引用 */
94
+ /** @param index 快捷评论索引 */
95
+ /** @param serverExtension 服务器扩展字段 */
96
+ removeQuickComment(messageRefer: V2NIMMessageRefer, index: number, serverExtension: string): Promise<void>;
97
+ /** @brief 获取快捷评论列表 */
98
+ /** @param messages 要获取快捷评论的消息列表 */
99
+ /** @note return result, key: clientMessasgeId */
100
+ getQuickCommentList(messages: Array<V2NIMMessage>): Promise<Map<string, Array<V2NIMMessageQuickComment>>>;
101
+ /** @brief 添加收藏 */
102
+ /** @param params 添加收藏相关参数 */
103
+ addCollection(params: V2NIMAddCollectionParams): Promise<V2NIMCollection>;
104
+ /** @brief 移除收藏 */
105
+ /** @param collections 要移除的收藏列表 */
106
+ removeCollections(collections: Array<V2NIMCollection>): Promise<void>;
107
+ /** @brief 更新收藏扩展字段 */
108
+ /** @param collection 要更新的收藏 */
109
+ /** @param serverExtension 服务器扩展字段, 传空表示删除扩展字段 */
110
+ updateCollectionExtension(collection: V2NIMCollection, serverExtension: string): Promise<V2NIMCollection>;
111
+ /** @brief 分页获取收藏列表 */
112
+ /** @param option 获取收藏列表查询参数 */
113
+ getCollectionListByOption(option: V2NIMCollectionOption): Promise<Array<V2NIMCollection>>;
114
+ /** @brief 发送 P2P 消息已读回执 */
115
+ /** @param message 要发送已读回执的消息 */
116
+ sendP2PMessageReceipt(message: V2NIMMessage): Promise<void>;
117
+ /** @brief 查询 P2P 消息已读回执状态 */
118
+ /** @param conversationId 会话 ID */
119
+ getP2PMessageReceipt(conversationId: string): Promise<V2NIMP2PMessageReadReceipt>;
120
+ /** @brief 查询 P2P 消息对方是否已读 */
121
+ /** @param message 要查询的消息 */
122
+ /** @return boolean 是否已读 */
123
+ isPeerRead(message: V2NIMMessage): boolean;
124
+ /** @brief 发送群消息已读回执 */
125
+ /** @param messages 要发送已读回执的消息列表 */
126
+ sendTeamMessageReceipts(messages: Array<V2NIMMessage>): Promise<void>;
127
+ /** @brief 获取群消息已读回执状态 */
128
+ /** @param messages 要查询的消息列表 */
129
+ getTeamMessageReceipts(messages: Array<V2NIMMessage>): Promise<Array<V2NIMTeamMessageReadReceipt>>;
130
+ /** @brief 获取群消息已读回执详情 */
131
+ /** @param message 要查询的消息 */
132
+ /** @param memberAccountIds 指定的账号列表, 为空表示查询全部 */
133
+ getTeamMessageReceiptDetail(message: V2NIMMessage, memberAccountIds: Array<string>): Promise<V2NIMTeamMessageReadReceiptDetail>;
134
+ /** @brief 语音转文字 */
135
+ /** @param params 语音转文字参数 */
136
+ voiceToText(params: V2NIMVoiceToTextParams): Promise<string>;
137
+ /** @brief 取消文件消息附件上传 */
138
+ /** @param message 要取消上传的文件消息 */
139
+ cancelMessageAttachmentUpload(message: V2NIMMessage): Promise<void>;
140
+ /** @brief 搜索云端消息 */
141
+ /** @param params 消息检索参数 */
142
+ searchCloudMessages(params: V2NIMMessageSearchParams): Promise<Array<V2NIMMessage>>;
143
+ }
@@ -0,0 +1,18 @@
1
+ import { V2NIMBroadcastNotification, V2NIMCustomNotification, V2NIMSendCustomNotificationParams } from 'ts/v2_def/v2_nim_struct_def';
2
+ import { EventEmitter } from 'eventemitter3';
3
+ export declare interface V2NIMNotificationServiceEvents {
4
+ /** 收到自定义通知 */
5
+ receiveCustomNotifications: [Array<V2NIMCustomNotification>];
6
+ /** 收到广播通知 */
7
+ receiveBroadcastNotifications: [Array<V2NIMBroadcastNotification>];
8
+ }
9
+ /** @brief 通知服务 */
10
+ export declare class V2NIMNotificationService extends EventEmitter<V2NIMNotificationServiceEvents> {
11
+ instance: any;
12
+ constructor();
13
+ /** @brief 发送自定义通知 */
14
+ /** @param conversationId 会话 ID */
15
+ /** @param content 通知内容 */
16
+ /** @param params 发送通知相关配置参数 */
17
+ sendCustomNotification(conversationId: string, content: string, params: V2NIMSendCustomNotificationParams): Promise<void>;
18
+ }
@@ -0,0 +1,43 @@
1
+ import { EventEmitter } from 'eventemitter3';
2
+ export declare interface V2NIMSettingServiceEvents {
3
+ /** 群组消息免打扰回调 */
4
+ teamMessageMuteModeChanged: [string, V2NIMTeamType, V2NIMTeamMessageMuteMode];
5
+ /** 点对点消息免打扰回调 */
6
+ p2pMessageMuteModeChanged: [string, V2NIMP2PMessageMuteMode];
7
+ }
8
+ /** @brief 设置服务 */
9
+ export declare class V2NIMSettingService extends EventEmitter<V2NIMSettingServiceEvents> {
10
+ instance: any;
11
+ constructor();
12
+ /** @brief 获取会话消息免打扰状态 */
13
+ /** @param conversationId 会话 ID */
14
+ /** @return boolean 会话消息免打扰状态 */
15
+ getConversationMuteStatus(conversationId: string): boolean;
16
+ /** @brief 设置群消息免打扰模式 */
17
+ /** @param teamId 群组 ID */
18
+ /** @param teamType 群组类型 */
19
+ /** @param muteMode 免打扰模式 */
20
+ /** @return void */
21
+ setTeamMessageMuteMode(teamId: string, teamType: V2NIMTeamType, muteMode: V2NIMTeamMessageMuteMode): Promise<void>;
22
+ /** @brief 获取群消息免打扰模式 */
23
+ /** @param teamId 群组 ID */
24
+ /** @param teamType 群组类型 */
25
+ /** @return V2NIMTeamMessageMuteMode 群消息免打扰模式 */
26
+ getTeamMessageMuteMode(teamId: string, teamType: V2NIMTeamType): V2NIMTeamMessageMuteMode;
27
+ /** @brief 设置点对点消息免打扰模式 */
28
+ /** @param accountId 账号 */
29
+ /** @param muteMode 免打扰模式 */
30
+ /** @return void */
31
+ setP2PMessageMuteMode(accountId: string, muteMode: V2NIMP2PMessageMuteMode): Promise<void>;
32
+ /** @brief 获取点对点消息免打扰模式 */
33
+ /** @param accountId 账号 */
34
+ /** @return V2NIMP2PMessageMuteMode 点对点消息免打扰模式 */
35
+ getP2PMessageMuteMode(accountId: string): V2NIMP2PMessageMuteMode;
36
+ /** @brief 获取点对点消息免打扰列表 */
37
+ /** @return Array<string> 点对点消息免打扰列表 */
38
+ getP2PMessageMuteList(): Promise<Array<string>>;
39
+ /** @brief 设置当桌面端在线时, 移动端是否需要推送 */
40
+ /** @param need 是否需要推送 */
41
+ /** @return void */
42
+ setPushMobileOnDesktopOnline(need: boolean): Promise<void>;
43
+ }
@@ -0,0 +1,28 @@
1
+ import { V2NIMUploadFileParams, V2NIMUploadFileTask, V2NIMStorageScene } from 'ts/v2_def/v2_nim_struct_def';
2
+ import { EventEmitter } from 'eventemitter3';
3
+ export declare interface V2NIMStorageServiceEvents {
4
+ }
5
+ /** @brief 存储服务 */
6
+ export declare class V2NIMStorageService extends EventEmitter<V2NIMStorageServiceEvents> {
7
+ instance: any;
8
+ constructor(instanceId?: number);
9
+ /** @brief 添加自定义存储场景, 需在登录前调用 */
10
+ /** @param sceneName 自定义存储场景 */
11
+ /** @return void */
12
+ addCustomStorageScene(sceneName: string, expireTime: number): void;
13
+ /** @brief 创建文件上传任务 */
14
+ /** @param fileParams 文件上传的相关参数 */
15
+ /** @return V2NIMUploadFileTask */
16
+ createUploadFileTask(fileParams: V2NIMUploadFileParams): V2NIMUploadFileTask;
17
+ /** @brief 文件上传 */
18
+ /** @param fileParams 文件上传的相关参数 */
19
+ /** @return void */
20
+ uploadFile(fileTask: V2NIMUploadFileTask): Promise<string>;
21
+ /** @brief 取消文件上传 */
22
+ /** @param uploadId 文件上传任务 id */
23
+ /** @return void */
24
+ cancelUploadFile(fileTask: V2NIMUploadFileTask): Promise<void>;
25
+ /** @brief 查询存储场景列表 */
26
+ /** @return Array<V2NIMStorageScene> */
27
+ getStorageSceneList(): Array<V2NIMStorageScene>;
28
+ }