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,123 +1,123 @@
1
- import { NIMClientAPI, GetCurrentServerTimeCallback, LoginCallback, LogoutCallback, MultiportPushConfigCallback, NIMLoginState, NIMLogoutType, SDKConfig, MultiSpotLoginRes, KickOtherRes, KickoutRes, LoginRes, NIMResCode } from '../nim_def/client_def';
2
- import { EventEmitter } from 'eventemitter3';
3
- export declare interface NIMClientEvents {
4
- /** NIM客户端掉线 */
5
- disconnect: [];
6
- /** NIM客户端多点登录通知 */
7
- multispotLogin: [MultiSpotLoginRes];
8
- /** 多端推送开关同步 */
9
- syncMultiportPushConfig: [number, boolean];
10
- /** NIM客户端被踢 */
11
- kickOtherClient: [KickOtherRes];
12
- /** NIM客户端将本帐号的其他端踢下线结果 */
13
- kickout: [KickoutRes];
14
- /** NIM客户端自动重连 */
15
- relogin: [LoginRes];
16
- }
17
- export declare class NIMClient extends EventEmitter<NIMClientEvents> {
18
- client: NIMClientAPI;
19
- constructor();
20
- /** 注册全局回调 */
21
- initEventHandlers(): void;
22
- /** NIM SDK初始化
23
- * @param appKey 应用注册的APP KEY
24
- * @param appDataDir 推荐用户目录放置在系统目录AppData\Local,默认只需要传入目录名,SDK会默认在系统目录下创建该级用户目录。如果要使用其他自定义路径,需传入绝对路径路径,并确保该目录有正确的读写权限。
25
- * @param appInstallDir Deprecated
26
- * @param config 初始化参数
27
- * @return bool 返回值true: 成功, false: 失败
28
- */
29
- init(appKey: string, appDataDir: string, appInstallDir: string, config: SDKConfig): boolean;
30
- /** NIM客户端登录
31
- * @param appKey
32
- * @param account 帐号
33
- * @param password 密码
34
- * @param cb 登录流程的回调函数
35
- * @param jsonExtension json扩展参数(v5.7.0 项目增加自定义参数字段)
36
- * @return bool 检查参数如果不符合要求则返回失败
37
- * @note
38
- * <pre>
39
- * 200:成功
40
- * 302:账号或密码错误
41
- * 403:禁止操作
42
- * 408:请求超时
43
- * 414:参数错误
44
- * 415:网络连接出现错误
45
- * 416:频率超限
46
- * 422:账号被禁用
47
- * </pre>
48
- */
49
- login(appKey: string, account: string, password: string, cb: LoginCallback | null, jsonExtension: string): Promise<[LoginRes]>;
50
- /** NIM客户端注销/退出
51
- * @param logoutType Logout操作类型,其定义见nim_client_def.h
52
- * @param cb 注销/退出的回调函数
53
- * @param jsonExtension json扩展参数(备用,目前不需要)
54
- * @return void 无返回值
55
- * @note
56
- * <pre>
57
- * 200:成功
58
- * 500:未知错误
59
- * </pre>
60
- */
61
- logout(logoutType: NIMLogoutType, cb: LogoutCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
62
- /** NIM SDK清理
63
- * @param jsonExtension json扩展参数(备用,目前不需要)
64
- * @return void 无返回值
65
- */
66
- cleanup(jsonExtension: string): void;
67
- /** 获取SDK配置
68
- * @return SDKConfig 返回值SDKConfig的引用 const类型,不可试图修改
69
- */
70
- getSDKConfig(): SDKConfig;
71
- /** 获取客户端登录状态
72
- * @param jsonExtension json扩展参数(备用,目前不需要)
73
- * @return NIMLoginState 登录状态
74
- */
75
- getLoginState(jsonExtension: string): NIMLoginState;
76
- /** NIM客户端手动重连(注意 APP需要统一处理自动重连/手动重连的回调,因为如果处于某次自动重连的过程中调用手动重连接口,不起作用!)
77
- * @param jsonExtension json扩展参数(备用,目前不需要)
78
- * @return void 无返回值
79
- */
80
- relogin(jsonExtension: string): void;
81
- /** 将本帐号的其他端踢下线
82
- * @param clients 设备标识
83
- * @return bool 检查参数如果不符合要求则返回失败, 接口调用成功后的结果通过注册RegKickOtherClientCb回调得到
84
- */
85
- kickOtherClient(clients: Array<string>): void;
86
- /** (全局回调)设置多端推送
87
- * @param switch_on 开关
88
- * @param cb 回调函数
89
- * @param jsonExtension json扩展参数(备用,目前不需要)
90
- * @return void
91
- * @note
92
- * <pre>
93
- * 200:成功
94
- * </pre>
95
- */
96
- setMultiportPushConfigAsync(switch_on: boolean, cb: MultiportPushConfigCallback | null, jsonExtension: string): Promise<[NIMResCode, boolean]>;
97
- /** 获得多端推送设置
98
- * @param cb 回调函数
99
- * @param jsonExtension json扩展参数(备用,目前不需要)
100
- * @return void
101
- */
102
- getMultiportPushConfigAsync(cb: MultiportPushConfigCallback | null, jsonExtension: string): Promise<[NIMResCode, boolean]>;
103
- /** 获取SDK版本号
104
- * @return string 版本号
105
- */
106
- getSDKVersion(): string;
107
- /** 获取当前服务器时间
108
- * @param cb 操作结果的回调函数
109
- * @param calc_local 是否在本地计算,false:直接到服务端查询 ,true:根据上次查询到的服务端时间与本地系统启动时间来计算,不会到服务端查询
110
- * @return void
111
- * @note
112
- * <pre>
113
- * 由于网络上/下行的原因,返回的时间会存在一定误差,
114
- * 当 calc_local == false 时,如果跟上次调用该方法的时间间隔小于1000ms,SDK会采用 calc_local == true
115
- * 时的方案以减少服务端的压力,并会在回调中指明返回的时间是由本地计算的。 如果返回 code != 200,同样会返回一个本地计算结果
116
- * </pre>
117
- */
118
- getServerCurrentTime(cb: GetCurrentServerTimeCallback | null, calcLocal: boolean): Promise<[number, boolean, number]>;
119
- /** 获取当前登录的用户账号(accid)
120
- * @return string 当前登录的用户账号(accid)
121
- * @note 没有登录时将返回空字符串 */
122
- getCurrentUserAccount(): string;
123
- }
1
+ import { NIMClientAPI, GetCurrentServerTimeCallback, LoginCallback, LogoutCallback, MultiportPushConfigCallback, NIMLoginState, NIMLogoutType, SDKConfig, MultiSpotLoginRes, KickOtherRes, KickoutRes, LoginRes, NIMResCode } from '../nim_def/client_def';
2
+ import { EventEmitter } from 'eventemitter3';
3
+ export declare interface NIMClientEvents {
4
+ /** NIM客户端掉线 */
5
+ disconnect: [];
6
+ /** NIM客户端多点登录通知 */
7
+ multispotLogin: [MultiSpotLoginRes];
8
+ /** 多端推送开关同步 */
9
+ syncMultiportPushConfig: [number, boolean];
10
+ /** NIM客户端被踢 */
11
+ kickOtherClient: [KickOtherRes];
12
+ /** NIM客户端将本帐号的其他端踢下线结果 */
13
+ kickout: [KickoutRes];
14
+ /** NIM客户端自动重连 */
15
+ relogin: [LoginRes];
16
+ }
17
+ export declare class NIMClient extends EventEmitter<NIMClientEvents> {
18
+ client: NIMClientAPI;
19
+ constructor();
20
+ /** 注册全局回调 */
21
+ initEventHandlers(): void;
22
+ /** NIM SDK初始化
23
+ * @param appKey 应用注册的APP KEY
24
+ * @param appDataDir 推荐用户目录放置在系统目录AppData\Local,默认只需要传入目录名,SDK会默认在系统目录下创建该级用户目录。如果要使用其他自定义路径,需传入绝对路径路径,并确保该目录有正确的读写权限。
25
+ * @param appInstallDir Deprecated
26
+ * @param config 初始化参数
27
+ * @return bool 返回值true: 成功, false: 失败
28
+ */
29
+ init(appKey: string, appDataDir: string, appInstallDir: string, config: SDKConfig): boolean;
30
+ /** NIM客户端登录
31
+ * @param appKey
32
+ * @param accountId 帐号
33
+ * @param password 密码
34
+ * @param cb 登录流程的回调函数
35
+ * @param jsonExtension json扩展参数(v5.7.0 项目增加自定义参数字段)
36
+ * @return bool 检查参数如果不符合要求则返回失败
37
+ * @note
38
+ * <pre>
39
+ * 200:成功
40
+ * 302:账号或密码错误
41
+ * 403:禁止操作
42
+ * 408:请求超时
43
+ * 414:参数错误
44
+ * 415:网络连接出现错误
45
+ * 416:频率超限
46
+ * 422:账号被禁用
47
+ * </pre>
48
+ */
49
+ login(appKey: string, accountId: string, password: string, cb: LoginCallback | null, jsonExtension: string): Promise<[LoginRes]>;
50
+ /** NIM客户端注销/退出
51
+ * @param logoutType Logout操作类型,其定义见nim_client_def.h
52
+ * @param cb 注销/退出的回调函数
53
+ * @param jsonExtension json扩展参数(备用,目前不需要)
54
+ * @return void 无返回值
55
+ * @note
56
+ * <pre>
57
+ * 200:成功
58
+ * 500:未知错误
59
+ * </pre>
60
+ */
61
+ logout(logoutType: NIMLogoutType, cb: LogoutCallback | null, jsonExtension: string): Promise<[NIMResCode]>;
62
+ /** NIM SDK清理
63
+ * @param jsonExtension json扩展参数(备用,目前不需要)
64
+ * @return void 无返回值
65
+ */
66
+ cleanup(jsonExtension: string): void;
67
+ /** 获取SDK配置
68
+ * @return SDKConfig 返回值SDKConfig的引用 const类型,不可试图修改
69
+ */
70
+ getSDKConfig(): SDKConfig;
71
+ /** 获取客户端登录状态
72
+ * @param jsonExtension json扩展参数(备用,目前不需要)
73
+ * @return NIMLoginState 登录状态
74
+ */
75
+ getLoginState(jsonExtension: string): NIMLoginState;
76
+ /** NIM客户端手动重连(注意 APP需要统一处理自动重连/手动重连的回调,因为如果处于某次自动重连的过程中调用手动重连接口,不起作用!)
77
+ * @param jsonExtension json扩展参数(备用,目前不需要)
78
+ * @return void 无返回值
79
+ */
80
+ relogin(jsonExtension: string): void;
81
+ /** 将本帐号的其他端踢下线
82
+ * @param clients 设备标识
83
+ * @return bool 检查参数如果不符合要求则返回失败, 接口调用成功后的结果通过注册RegKickOtherClientCb回调得到
84
+ */
85
+ kickOtherClient(clients: Array<string>): void;
86
+ /** (全局回调)设置多端推送
87
+ * @param switch_on 开关
88
+ * @param cb 回调函数
89
+ * @param jsonExtension json扩展参数(备用,目前不需要)
90
+ * @return void
91
+ * @note
92
+ * <pre>
93
+ * 200:成功
94
+ * </pre>
95
+ */
96
+ setMultiportPushConfigAsync(switch_on: boolean, cb: MultiportPushConfigCallback | null, jsonExtension: string): Promise<[NIMResCode, boolean]>;
97
+ /** 获得多端推送设置
98
+ * @param cb 回调函数
99
+ * @param jsonExtension json扩展参数(备用,目前不需要)
100
+ * @return void
101
+ */
102
+ getMultiportPushConfigAsync(cb: MultiportPushConfigCallback | null, jsonExtension: string): Promise<[NIMResCode, boolean]>;
103
+ /** 获取SDK版本号
104
+ * @return string 版本号
105
+ */
106
+ getSDKVersion(): string;
107
+ /** 获取当前服务器时间
108
+ * @param cb 操作结果的回调函数
109
+ * @param calc_local 是否在本地计算,false:直接到服务端查询 ,true:根据上次查询到的服务端时间与本地系统启动时间来计算,不会到服务端查询
110
+ * @return void
111
+ * @note
112
+ * <pre>
113
+ * 由于网络上/下行的原因,返回的时间会存在一定误差,
114
+ * 当 calc_local == false 时,如果跟上次调用该方法的时间间隔小于1000ms,SDK会采用 calc_local == true
115
+ * 时的方案以减少服务端的压力,并会在回调中指明返回的时间是由本地计算的。 如果返回 code != 200,同样会返回一个本地计算结果
116
+ * </pre>
117
+ */
118
+ getServerCurrentTime(cb: GetCurrentServerTimeCallback | null, calcLocal: boolean): Promise<[number, boolean, number]>;
119
+ /** 获取当前登录的用户账号(accid)
120
+ * @return string 当前登录的用户账号(accid)
121
+ * @note 没有登录时将返回空字符串 */
122
+ getCurrentUserAccount(): string;
123
+ }
@@ -1,12 +1,12 @@
1
- import { EventEmitter } from 'eventemitter3';
2
- import { NIMDataSyncAPI, NIMDataSyncStatus, NIMDataSyncType } from '../nim_def/data_sync_def';
3
- export declare interface NIMDataSyncEvents {
4
- /** 数据同步完成 */
5
- complete: [NIMDataSyncType, NIMDataSyncStatus, string];
6
- }
7
- export declare class NIMDataSync extends EventEmitter<NIMDataSyncEvents> {
8
- dataSync: NIMDataSyncAPI;
9
- constructor();
10
- /** 注册全局回调 */
11
- initEventHandlers(): void;
12
- }
1
+ import { EventEmitter } from 'eventemitter3';
2
+ import { NIMDataSyncAPI, NIMDataSyncStatus, NIMDataSyncType } from '../nim_def/data_sync_def';
3
+ export declare interface NIMDataSyncEvents {
4
+ /** 数据同步完成 */
5
+ complete: [NIMDataSyncType, NIMDataSyncStatus, string];
6
+ }
7
+ export declare class NIMDataSync extends EventEmitter<NIMDataSyncEvents> {
8
+ dataSync: NIMDataSyncAPI;
9
+ constructor();
10
+ /** 注册全局回调 */
11
+ initEventHandlers(): void;
12
+ }
@@ -1,82 +1,82 @@
1
- import { EventEmitter } from 'eventemitter3';
2
- import { DeleteFriendOption, FriendProfile, NIMFriendAPI, FriendOptCallback, GetFriendProfileCallback, GetFriendsListCallback, NIMVerifyType, FriendChangeEvent } from '../nim_def/friend_def';
3
- import { NIMResCode } from '../nim_def/client_def';
4
- export declare interface NIMFriendEvents {
5
- /** 好友变更通知 */
6
- change: [FriendChangeEvent];
7
- }
8
- export declare class NIMFriend extends EventEmitter<NIMFriendEvents> {
9
- friend: NIMFriendAPI;
10
- constructor();
11
- /** 注册全局回调 */
12
- initEventHandlers(): void;
13
- /** 添加、验证好友
14
- * @param accid 对方帐号
15
- * @param verify_type 好友验证类型
16
- * @param msg 接口扩展字段
17
- * @param cb 好友请求回调函数
18
- * @param jsonExtension json扩展参数(备用,目前不需要)
19
- * @return boolean 检查参数如果不符合要求则返回失败
20
- * @note
21
- * <pre>
22
- * 200:成功
23
- * 404:用户不存在
24
- * 500:未知错误
25
- * </pre>
26
- */
27
- request(accid: string, verify_type: NIMVerifyType, msg: string, cb: FriendOptCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
28
- /** 删除好友
29
- * @param accid 对方帐号
30
- * @param option 删除好友选项,目前仅有是否删除备注信息选项
31
- * @param cb 删除好友回调函数
32
- * @return boolean 检查参数如果不符合要求则返回失败
33
- * @note
34
- * <pre>
35
- * 200:成功
36
- * 404:用户不存在
37
- * 500:未知错误
38
- * </pre>
39
- */
40
- delete(accid: string, option: DeleteFriendOption, cb: FriendOptCallback | null): Promise<[NIMResCode] | null>;
41
- /** 更新好友资料
42
- * @param profile 好友资料
43
- * @param cb 更新好友资料回调函数
44
- * @param jsonExtension json扩展参数(备用,目前不需要)
45
- * @return boolean 检查参数如果不符合要求则返回失败
46
- * @note
47
- * <pre>
48
- * 200:成功
49
- * 404:用户不存在
50
- * 500:未知错误
51
- * </pre>
52
- */
53
- update(profile: FriendProfile, cb: FriendOptCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
54
- /** 增量获取好友列表
55
- * @param cb 获取好友列表回调函数
56
- * @param jsonExtension json扩展参数(备用,目前不需要)
57
- * @return void 无返回值
58
- * @note
59
- * <pre>
60
- * 200:成功
61
- * </pre>
62
- */
63
- getList(cb: GetFriendsListCallback | null, jsonExtension: string): Promise<[NIMResCode, Array<FriendProfile>]>;
64
- /** 获取好友信息
65
- * @param accid 对方帐号
66
- * @param cb 获取好友信息回调函数
67
- * @param jsonExtension json扩展参数(备用,目前不需要)
68
- * @return void 无返回值
69
- */
70
- getFriendProfile(accid: string, cb: GetFriendProfileCallback | null, jsonExtension: string): Promise<[string, FriendProfile]>;
71
- /** 增量获取好友列表
72
- * @param keyword 要查询的关键字
73
- * @param cb 获取好友列表回调函数
74
- * @param jsonExtension json扩展参数(备用,目前不需要)
75
- * @return boolean 返回 true 表示发送查询请求成功,返回 false 表示关键字为空
76
- * @note
77
- * <pre>
78
- * 200:成功
79
- * </pre>
80
- */
81
- queryFriendListByKeyword(keyword: string, cb: GetFriendsListCallback | null, jsonExtension: string): Promise<[NIMResCode, Array<FriendProfile>] | null>;
82
- }
1
+ import { EventEmitter } from 'eventemitter3';
2
+ import { DeleteFriendOption, FriendProfile, NIMFriendAPI, FriendOptCallback, GetFriendProfileCallback, GetFriendsListCallback, NIMVerifyType, FriendChangeEvent } from '../nim_def/friend_def';
3
+ import { NIMResCode } from '../nim_def/client_def';
4
+ export declare interface NIMFriendEvents {
5
+ /** 好友变更通知 */
6
+ change: [FriendChangeEvent];
7
+ }
8
+ export declare class NIMFriend extends EventEmitter<NIMFriendEvents> {
9
+ friend: NIMFriendAPI;
10
+ constructor();
11
+ /** 注册全局回调 */
12
+ initEventHandlers(): void;
13
+ /** 添加、验证好友
14
+ * @param accid 对方帐号
15
+ * @param verify_type 好友验证类型
16
+ * @param msg 接口扩展字段
17
+ * @param cb 好友请求回调函数
18
+ * @param jsonExtension json扩展参数(备用,目前不需要)
19
+ * @return boolean 检查参数如果不符合要求则返回失败
20
+ * @note
21
+ * <pre>
22
+ * 200:成功
23
+ * 404:用户不存在
24
+ * 500:未知错误
25
+ * </pre>
26
+ */
27
+ request(accid: string, verify_type: NIMVerifyType, msg: string, cb: FriendOptCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
28
+ /** 删除好友
29
+ * @param accid 对方帐号
30
+ * @param option 删除好友选项,目前仅有是否删除备注信息选项
31
+ * @param cb 删除好友回调函数
32
+ * @return boolean 检查参数如果不符合要求则返回失败
33
+ * @note
34
+ * <pre>
35
+ * 200:成功
36
+ * 404:用户不存在
37
+ * 500:未知错误
38
+ * </pre>
39
+ */
40
+ delete(accid: string, option: DeleteFriendOption, cb: FriendOptCallback | null): Promise<[NIMResCode] | null>;
41
+ /** 更新好友资料
42
+ * @param profile 好友资料
43
+ * @param cb 更新好友资料回调函数
44
+ * @param jsonExtension json扩展参数(备用,目前不需要)
45
+ * @return boolean 检查参数如果不符合要求则返回失败
46
+ * @note
47
+ * <pre>
48
+ * 200:成功
49
+ * 404:用户不存在
50
+ * 500:未知错误
51
+ * </pre>
52
+ */
53
+ update(profile: FriendProfile, cb: FriendOptCallback | null, jsonExtension: string): Promise<[NIMResCode] | null>;
54
+ /** 增量获取好友列表
55
+ * @param cb 获取好友列表回调函数
56
+ * @param jsonExtension json扩展参数(备用,目前不需要)
57
+ * @return void 无返回值
58
+ * @note
59
+ * <pre>
60
+ * 200:成功
61
+ * </pre>
62
+ */
63
+ getList(cb: GetFriendsListCallback | null, jsonExtension: string): Promise<[NIMResCode, Array<FriendProfile>]>;
64
+ /** 获取好友信息
65
+ * @param accid 对方帐号
66
+ * @param cb 获取好友信息回调函数
67
+ * @param jsonExtension json扩展参数(备用,目前不需要)
68
+ * @return void 无返回值
69
+ */
70
+ getFriendProfile(accid: string, cb: GetFriendProfileCallback | null, jsonExtension: string): Promise<[string, FriendProfile]>;
71
+ /** 增量获取好友列表
72
+ * @param keyword 要查询的关键字
73
+ * @param cb 获取好友列表回调函数
74
+ * @param jsonExtension json扩展参数(备用,目前不需要)
75
+ * @return boolean 返回 true 表示发送查询请求成功,返回 false 表示关键字为空
76
+ * @note
77
+ * <pre>
78
+ * 200:成功
79
+ * </pre>
80
+ */
81
+ queryFriendListByKeyword(keyword: string, cb: GetFriendsListCallback | null, jsonExtension: string): Promise<[NIMResCode, Array<FriendProfile>] | null>;
82
+ }
@@ -1,69 +1,69 @@
1
- import { EventEmitter } from 'eventemitter3';
2
- import { CachedFileInfo, DeleteCachedFileCallback, DetectProxyCallback, ExceptionCallback, GetCachedFileInfoCallback, NIMCachedFileType, NIMGlobalAPI, NIMProxyDetectStep, NIMProxyType, NIMSDKException, SDKDBErrorInfo, SDKFeedbackCallback, UploadSDKLogCallback } from '../nim_def/global_def';
3
- import { NIMResCode } from '../nim_def/client_def';
4
- export declare interface NIMGlobalEvents {
5
- /** SDK DB操作出错 */
6
- dbError: [SDKDBErrorInfo];
7
- }
8
- export declare class NIMGlobal extends EventEmitter<NIMGlobalEvents> {
9
- global: NIMGlobalAPI;
10
- constructor();
11
- /** 注册全局回调 */
12
- initEventHandlers(): void;
13
- /** 注册输出系统环境异常的回调
14
- * @param jsonExtension json扩展参数(备用,目前不需要)
15
- * @param cb
16
- * @return void 无返回值
17
- */
18
- setExceptionReportCallback(jsonExtension: string, cb: ExceptionCallback | null): Promise<[NIMSDKException, string]>;
19
- /** 设置SDK统一的网络代理。不需要代理时,type设置为kNIMProxyNone,其余参数都传空字符串(端口设为0)。有些代理不需要用户名和密码,相应参数也传空字符串。
20
- * @param type 代理类型,见NIMProxyType定义
21
- * @param host 代理地址
22
- * @param port 代理端口
23
- * @param user 代理用户名
24
- * @param password 代理密码
25
- * @return void 无返回值
26
- */
27
- setProxy(type: NIMProxyType, host: string, port: number, user: string, password: string): void;
28
- /** 测试代理
29
- * @param type 代理类型,见NIMProxyType定义
30
- * @param host 代理地址
31
- * @param port 代理端口
32
- * @param user 代理用户名
33
- * @param password 代理密码
34
- * @param cb 回调函数
35
- * @return void 无返回值
36
- */
37
- detectProxy(type: NIMProxyType, host: string, port: number, user: string, password: string, cb: DetectProxyCallback | null): Promise<[boolean, NIMProxyDetectStep, string]>;
38
- /** 获取sdk缓存文件信息
39
- * @param loginId 查询的账号ID
40
- * @param fileType 文件类型,常量定义见NIMCachedFileType
41
- * @param endTimestamp 查询时间截止点(查询全部填0)
42
- * @param jsonExtension json扩展参数(备用,目前不需要)
43
- * @param cb
44
- * @return void 无返回值
45
- */
46
- getSDKCachedFileInfoAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: GetCachedFileInfoCallback | null): Promise<[NIMResCode, CachedFileInfo]>;
47
- /** 删除sdk缓存文件
48
- * @param loginId 查询的账号ID
49
- * @param fileType 文件类型,常量定义见NIMCachedFileType
50
- * @param endTimestamp 删除时间截止点(查询全部填0)
51
- * @param jsonExtension json扩展参数(备用,目前不需要)
52
- * @param cb
53
- * @return void 无返回值
54
- */
55
- deleteSDKCachedFileAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: DeleteCachedFileCallback | null): Promise<[NIMResCode]>;
56
- /** SDK 反馈
57
- * @param url 开发者需将所需要反馈的文件(dump,应用日志等)上传至nos。
58
- * @param jsonExtension json扩展参数(备用,目前不需要)
59
- * @param cb
60
- * @return void 无返回值
61
- */
62
- sdkFeedbackAsync(url: string, jsonExtension: string, cb: SDKFeedbackCallback | null): Promise<[NIMResCode]>;
63
- /** 上传SDK日志到服务器
64
- * @param feedbackStr 反馈信息
65
- * @param cb 操作结果的回调函数
66
- * @return void
67
- */
68
- uploadSDKLog(feedbackStr: string, cb: UploadSDKLogCallback | null): Promise<[NIMResCode]>;
69
- }
1
+ import { EventEmitter } from 'eventemitter3';
2
+ import { CachedFileInfo, DeleteCachedFileCallback, DetectProxyCallback, ExceptionCallback, GetCachedFileInfoCallback, NIMCachedFileType, NIMGlobalAPI, NIMProxyDetectStep, NIMProxyType, NIMSDKException, SDKDBErrorInfo, SDKFeedbackCallback, UploadSDKLogCallback } from '../nim_def/global_def';
3
+ import { NIMResCode } from '../nim_def/client_def';
4
+ export declare interface NIMGlobalEvents {
5
+ /** SDK DB操作出错 */
6
+ dbError: [SDKDBErrorInfo];
7
+ }
8
+ export declare class NIMGlobal extends EventEmitter<NIMGlobalEvents> {
9
+ global: NIMGlobalAPI;
10
+ constructor();
11
+ /** 注册全局回调 */
12
+ initEventHandlers(): void;
13
+ /** 注册输出系统环境异常的回调
14
+ * @param jsonExtension json扩展参数(备用,目前不需要)
15
+ * @param cb
16
+ * @return void 无返回值
17
+ */
18
+ setExceptionReportCallback(jsonExtension: string, cb: ExceptionCallback | null): Promise<[NIMSDKException, string]>;
19
+ /** 设置SDK统一的网络代理。不需要代理时,type设置为kNIMProxyNone,其余参数都传空字符串(端口设为0)。有些代理不需要用户名和密码,相应参数也传空字符串。
20
+ * @param type 代理类型,见NIMProxyType定义
21
+ * @param host 代理地址
22
+ * @param port 代理端口
23
+ * @param user 代理用户名
24
+ * @param password 代理密码
25
+ * @return void 无返回值
26
+ */
27
+ setProxy(type: NIMProxyType, host: string, port: number, user: string, password: string): void;
28
+ /** 测试代理
29
+ * @param type 代理类型,见NIMProxyType定义
30
+ * @param host 代理地址
31
+ * @param port 代理端口
32
+ * @param user 代理用户名
33
+ * @param password 代理密码
34
+ * @param cb 回调函数
35
+ * @return void 无返回值
36
+ */
37
+ detectProxy(type: NIMProxyType, host: string, port: number, user: string, password: string, cb: DetectProxyCallback | null): Promise<[boolean, NIMProxyDetectStep, string]>;
38
+ /** 获取sdk缓存文件信息
39
+ * @param loginId 查询的账号ID
40
+ * @param fileType 文件类型,常量定义见NIMCachedFileType
41
+ * @param endTimestamp 查询时间截止点(查询全部填0)
42
+ * @param jsonExtension json扩展参数(备用,目前不需要)
43
+ * @param cb
44
+ * @return void 无返回值
45
+ */
46
+ getSDKCachedFileInfoAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: GetCachedFileInfoCallback | null): Promise<[NIMResCode, CachedFileInfo]>;
47
+ /** 删除sdk缓存文件
48
+ * @param loginId 查询的账号ID
49
+ * @param fileType 文件类型,常量定义见NIMCachedFileType
50
+ * @param endTimestamp 删除时间截止点(查询全部填0)
51
+ * @param jsonExtension json扩展参数(备用,目前不需要)
52
+ * @param cb
53
+ * @return void 无返回值
54
+ */
55
+ deleteSDKCachedFileAsync(loginId: string, fileType: NIMCachedFileType, endTimestamp: number, jsonExtension: string, cb: DeleteCachedFileCallback | null): Promise<[NIMResCode]>;
56
+ /** SDK 反馈
57
+ * @param url 开发者需将所需要反馈的文件(dump,应用日志等)上传至nos。
58
+ * @param jsonExtension json扩展参数(备用,目前不需要)
59
+ * @param cb
60
+ * @return void 无返回值
61
+ */
62
+ sdkFeedbackAsync(url: string, jsonExtension: string, cb: SDKFeedbackCallback | null): Promise<[NIMResCode]>;
63
+ /** 上传SDK日志到服务器
64
+ * @param feedbackStr 反馈信息
65
+ * @param cb 操作结果的回调函数
66
+ * @return void
67
+ */
68
+ uploadSDKLog(feedbackStr: string, cb: UploadSDKLogCallback | null): Promise<[NIMResCode]>;
69
+ }