node-nim 9.14.3 → 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 (182) 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 -615
  17. package/dist/nim/super_team.js.map +1 -1
  18. package/dist/nim/sysmsg.js +194 -194
  19. package/dist/nim/talk.js +209 -209
  20. package/dist/nim/talk.js.map +1 -1
  21. package/dist/nim/talkex.js +191 -191
  22. package/dist/nim/team.js +818 -830
  23. package/dist/nim/team.js.map +1 -1
  24. package/dist/nim/tool.js +119 -119
  25. package/dist/nim/user.js +201 -201
  26. package/dist/nim_def/client_def.js +245 -245
  27. package/dist/nim_def/client_def.js.map +1 -1
  28. package/dist/nim_def/data_sync_def.js +20 -20
  29. package/dist/nim_def/doc_trans_def.js +16 -16
  30. package/dist/nim_def/friend_def.js +37 -37
  31. package/dist/nim_def/global_def.js +39 -39
  32. package/dist/nim_def/msglog_def.js +148 -148
  33. package/dist/nim_def/nos_def.js +16 -16
  34. package/dist/nim_def/online_session_def.js +2 -2
  35. package/dist/nim_def/pass_through_proxy_def.js +10 -10
  36. package/dist/nim_def/plugin_def.js +2 -2
  37. package/dist/nim_def/session_def.js +26 -26
  38. package/dist/nim_def/subscribe_event_def.js +52 -52
  39. package/dist/nim_def/super_team_def.js +64 -71
  40. package/dist/nim_def/super_team_def.js.map +1 -1
  41. package/dist/nim_def/sysmsg_def.js +28 -28
  42. package/dist/nim_def/talk_def.js +2 -2
  43. package/dist/nim_def/talkex_def.js +2 -2
  44. package/dist/nim_def/team_def.js +69 -76
  45. package/dist/nim_def/team_def.js.map +1 -1
  46. package/dist/nim_def/tool_def.js +11 -11
  47. package/dist/nim_def/user_def.js +22 -22
  48. package/dist/node-nim.js +171 -171
  49. package/dist/node-nim.js.map +1 -1
  50. package/dist/qchat/attachment.js +63 -63
  51. package/dist/qchat/channel.js +314 -314
  52. package/dist/qchat/channel_category.js +187 -187
  53. package/dist/qchat/instance.js +77 -77
  54. package/dist/qchat/message.js +285 -285
  55. package/dist/qchat/role.js +423 -423
  56. package/dist/qchat/server.js +453 -453
  57. package/dist/qchat/system_notification.js +74 -74
  58. package/dist/qchat_def/attachment_def.js +2 -2
  59. package/dist/qchat_def/channel_def.js +2 -2
  60. package/dist/qchat_def/instance_def.js +2 -2
  61. package/dist/qchat_def/message_def.js +2 -2
  62. package/dist/qchat_def/public_def.js +649 -649
  63. package/dist/qchat_def/public_def.js.map +1 -1
  64. package/dist/qchat_def/role_def.js +2 -2
  65. package/dist/qchat_def/server_def.js +2 -2
  66. package/dist/qchat_def/system_notification_def.js +2 -2
  67. package/dist/v2/v2_nim_chatroom_client.js +135 -0
  68. package/dist/v2/v2_nim_chatroom_client.js.map +1 -0
  69. package/dist/v2/v2_nim_chatroom_service.js +244 -0
  70. package/dist/v2/v2_nim_chatroom_service.js.map +1 -0
  71. package/dist/v2/v2_nim_client.js +138 -0
  72. package/dist/v2/v2_nim_client.js.map +1 -0
  73. package/dist/v2/v2_nim_conversation_group_service.js +116 -0
  74. package/dist/v2/v2_nim_conversation_group_service.js.map +1 -0
  75. package/dist/v2/v2_nim_conversation_service.js +236 -0
  76. package/dist/v2/v2_nim_conversation_service.js.map +1 -0
  77. package/dist/v2/v2_nim_friend_service.js +128 -0
  78. package/dist/v2/v2_nim_friend_service.js.map +1 -0
  79. package/dist/v2/v2_nim_login_service.js +119 -123
  80. package/dist/v2/v2_nim_login_service.js.map +1 -1
  81. package/dist/v2/v2_nim_message_service.js +382 -0
  82. package/dist/v2/v2_nim_message_service.js.map +1 -0
  83. package/dist/v2/v2_nim_notification_service.js +30 -0
  84. package/dist/v2/v2_nim_notification_service.js.map +1 -0
  85. package/dist/v2/v2_nim_setting_service.js +86 -0
  86. package/dist/v2/v2_nim_setting_service.js.map +1 -0
  87. package/dist/v2/v2_nim_storage_service.js +58 -0
  88. package/dist/v2/v2_nim_storage_service.js.map +1 -0
  89. package/dist/v2/v2_nim_team_service.js +360 -0
  90. package/dist/v2/v2_nim_team_service.js.map +1 -0
  91. package/dist/v2/v2_nim_user_service.js +76 -0
  92. package/dist/v2/v2_nim_user_service.js.map +1 -0
  93. package/dist/v2/v2_nim_utilities.js +276 -0
  94. package/dist/v2/v2_nim_utilities.js.map +1 -0
  95. package/dist/v2_def/v2_nim_callback_def.js +2 -2
  96. package/dist/v2_def/v2_nim_enum_def.js +1087 -325
  97. package/dist/v2_def/v2_nim_enum_def.js.map +1 -1
  98. package/dist/v2_def/v2_nim_struct_def.js +2 -2
  99. package/package.json +1 -1
  100. package/script/download-sdk.js +2 -2
  101. package/script/publish-to-netease-npm.js +3 -2
  102. package/types/loader.d.ts +2 -2
  103. package/types/nim/client.d.ts +123 -123
  104. package/types/nim/data_sync.d.ts +12 -12
  105. package/types/nim/friend.d.ts +82 -82
  106. package/types/nim/global.d.ts +69 -69
  107. package/types/nim/msglog.d.ts +392 -392
  108. package/types/nim/nos.d.ts +118 -118
  109. package/types/nim/online_session.d.ts +44 -44
  110. package/types/nim/pass_through_proxy.d.ts +24 -24
  111. package/types/nim/plugin.d.ts +39 -39
  112. package/types/nim/session.d.ts +212 -212
  113. package/types/nim/subscribe_event.d.ts +87 -87
  114. package/types/nim/super_team.d.ts +331 -342
  115. package/types/nim/sysmsg.d.ts +105 -105
  116. package/types/nim/talk.d.ts +94 -94
  117. package/types/nim/talkex.d.ts +95 -95
  118. package/types/nim/team.d.ts +461 -467
  119. package/types/nim/tool.d.ts +77 -77
  120. package/types/nim/user.d.ts +111 -111
  121. package/types/nim_def/client_def.d.ts +284 -284
  122. package/types/nim_def/data_sync_def.d.ts +19 -19
  123. package/types/nim_def/doc_trans_def.d.ts +11 -11
  124. package/types/nim_def/friend_def.d.ts +65 -65
  125. package/types/nim_def/global_def.d.ts +62 -62
  126. package/types/nim_def/msglog_def.d.ts +373 -373
  127. package/types/nim_def/nos_def.d.ts +72 -72
  128. package/types/nim_def/online_session_def.d.ts +34 -34
  129. package/types/nim_def/pass_through_proxy_def.d.ts +13 -13
  130. package/types/nim_def/plugin_def.d.ts +8 -8
  131. package/types/nim_def/session_def.d.ts +114 -114
  132. package/types/nim_def/subscribe_event_def.d.ts +83 -83
  133. package/types/nim_def/super_team_def.d.ts +144 -163
  134. package/types/nim_def/sysmsg_def.d.ts +70 -70
  135. package/types/nim_def/talk_def.d.ts +96 -96
  136. package/types/nim_def/talkex_def.d.ts +112 -112
  137. package/types/nim_def/team_def.d.ts +167 -184
  138. package/types/nim_def/tool_def.d.ts +28 -28
  139. package/types/nim_def/user_def.d.ts +59 -59
  140. package/types/node-nim.d.ts +90 -93
  141. package/types/qchat/attachment.d.ts +40 -40
  142. package/types/qchat/channel.d.ts +139 -139
  143. package/types/qchat/channel_category.d.ts +82 -82
  144. package/types/qchat/instance.d.ts +46 -46
  145. package/types/qchat/message.d.ts +128 -128
  146. package/types/qchat/role.d.ts +166 -166
  147. package/types/qchat/server.d.ts +198 -198
  148. package/types/qchat/system_notification.d.ts +39 -39
  149. package/types/qchat_def/attachment_def.d.ts +71 -71
  150. package/types/qchat_def/channel_def.d.ts +643 -643
  151. package/types/qchat_def/instance_def.d.ts +214 -214
  152. package/types/qchat_def/message_def.d.ts +565 -565
  153. package/types/qchat_def/public_def.d.ts +754 -754
  154. package/types/qchat_def/role_def.d.ts +413 -413
  155. package/types/qchat_def/server_def.d.ts +529 -529
  156. package/types/qchat_def/system_notification_def.d.ts +172 -172
  157. package/types/v2/v2_nim_chatroom_client.d.ts +73 -0
  158. package/types/v2/v2_nim_chatroom_service.d.ts +114 -0
  159. package/types/v2/v2_nim_client.d.ts +75 -0
  160. package/types/v2/v2_nim_conversation_group_service.d.ts +54 -0
  161. package/types/v2/v2_nim_conversation_service.d.ts +110 -0
  162. package/types/v2/v2_nim_friend_service.d.ts +58 -0
  163. package/types/v2/v2_nim_login_service.d.ts +80 -96
  164. package/types/v2/v2_nim_message_service.d.ts +143 -0
  165. package/types/v2/v2_nim_notification_service.d.ts +18 -0
  166. package/types/v2/v2_nim_setting_service.d.ts +43 -0
  167. package/types/v2/v2_nim_storage_service.d.ts +28 -0
  168. package/types/v2/v2_nim_team_service.d.ts +184 -0
  169. package/types/v2/v2_nim_user_service.d.ts +34 -0
  170. package/types/v2/v2_nim_utilities.d.ts +168 -0
  171. package/types/v2_def/v2_nim_callback_def.d.ts +7 -20
  172. package/types/v2_def/v2_nim_enum_def.d.ts +1009 -300
  173. package/types/v2_def/v2_nim_struct_def.d.ts +1539 -338
  174. package/dist/chatroom/chatroom.js +0 -263
  175. package/dist/chatroom/chatroom.js.map +0 -1
  176. package/dist/chatroom_def/chatroom_def.js +0 -120
  177. package/dist/chatroom_def/chatroom_def.js.map +0 -1
  178. package/dist/v2/v2_nim_instance.js +0 -44
  179. package/dist/v2/v2_nim_instance.js.map +0 -1
  180. package/types/chatroom/chatroom.d.ts +0 -55
  181. package/types/chatroom_def/chatroom_def.d.ts +0 -448
  182. package/types/v2/v2_nim_instance.d.ts +0 -25
@@ -1,448 +0,0 @@
1
- import { NIMResCode } from '../nim_def/client_def';
2
- export declare enum NIMChatRoomLoginState {
3
- kNIMChatRoomLoginStateLogin = 1 /**< 登录状态 */,
4
- kNIMChatRoomLoginStateUnLogin = 2 /**< 未登录状态 */
5
- }
6
- export declare enum NIMChatRoomEnterStep {
7
- kNIMChatRoomEnterStepInit = 1 /**< 本地服务初始化 */,
8
- kNIMChatRoomEnterStepServerConnecting = 2 /**< 服务器连接中 */,
9
- kNIMChatRoomEnterStepServerConnectOver = 3 /**< 服务器连接结束,连接结果见error_code */,
10
- kNIMChatRoomEnterStepRoomAuthing = 4 /**< 聊天室鉴权中 */,
11
- kNIMChatRoomEnterStepRoomAuthOver = 5 /**< 聊天室鉴权结束,鉴权结果见error_code, error_code非408则需要开发者重新请求聊天室进入信息 */
12
- }
13
- export declare enum NIMChatRoomExitReason {
14
- kNIMChatRoomExitReasonExit = 0 /**< 自行退出,重登前需要重新请求进入 */,
15
- kNIMChatRoomExitReasonRoomInvalid = 1 /**< 聊天室已经被解散,重登前需要重新请求进入 */,
16
- kNIMChatRoomExitReasonKickByManager = 2 /**< 被管理员踢出,重登前需要重新请求进入 */,
17
- kNIMChatRoomExitReasonKickByMultiSpot = 3 /**< 多端被踢 */,
18
- kNIMChatRoomExitReasonIllegalState = 4 /**< 当前链接状态异常 */,
19
- kNIMChatRoomExitReasonBeBlacklisted = 5 /**< 被加黑了 */
20
- }
21
- export declare enum NIMChatRoomLinkCondition {
22
- kNIMChatRoomLinkConditionAlive = 0 /**< 链接正常 */,
23
- kNIMChatRoomLinkConditionDeadAndRetry = 1 /**< 链接失败,sdk尝试重链 */,
24
- kNIMChatRoomLinkConditionDead = 2 /**< 链接失败,开发者需要重新申请聊天室进入信息 */
25
- }
26
- export declare enum NIMChatRoomMsgType {
27
- kNIMChatRoomMsgTypeText = 0 /**< 文本类型消息 */,
28
- kNIMChatRoomMsgTypeImage = 1 /**< 图片类型消息 */,
29
- kNIMChatRoomMsgTypeAudio = 2 /**< 声音类型消息 */,
30
- kNIMChatRoomMsgTypeVideo = 3 /**< 视频类型消息 */,
31
- kNIMChatRoomMsgTypeLocation = 4 /**< 位置类型消息 */,
32
- kNIMChatRoomMsgTypeNotification = 5 /**< 活动室通知 */,
33
- kNIMChatRoomMsgTypeFile = 6 /**< 文件类型消息 */,
34
- kNIMChatRoomMsgTypeRobot = 11 /**< 波特机器人消息 */,
35
- kNIMChatRoomMsgTypeTips = 10 /**< 提醒类型消息 */,
36
- kNIMChatRoomMsgTypeCustom = 100 /**< 自定义消息 */,
37
- kNIMChatRoomMsgTypeUnknown = 1000 /**< 未知类型消息,作为默认值 */
38
- }
39
- export declare enum NIMChatRoomClientType {
40
- kNIMChatRoomClientTypeDefault = 0 /**< default,unset */,
41
- kNIMChatRoomClientTypeAndroid = 1 /**< android */,
42
- kNIMChatRoomClientTypeiOS = 2 /**< iOS */,
43
- kNIMChatRoomClientTypePCWindows = 4 /**< PC */,
44
- kNIMChatRoomClientTypeWindowsPhone = 8 /**< WindowsPhone */,
45
- kNIMChatRoomClientTypeWeb = 16 /**< Web */,
46
- kNIMChatRoomClientTypeRestAPI = 32 /**< RestAPI */,
47
- kNIMChatRoomClientTypeMacOS = 64 /**< Mac */
48
- }
49
- export declare enum NIMChatRoomProxyType {
50
- kNIMChatRoomProxyNone = 0 /**< 不使用代理 */,
51
- kNIMChatRoomProxyHttp11 = 1 /**< HTTP 1.1 Proxy(暂不支持) */,
52
- kNIMChatRoomProxySocks4 = 4 /**< Socks4 Proxy */,
53
- kNIMChatRoomProxySocks4a = 5 /**< Socks4a Proxy */,
54
- kNIMChatRoomProxySocks5 = 6 /**< Socks5 Proxy */
55
- }
56
- export declare enum NIMChatRoomGetMemberType {
57
- /** 固定成员,固定成员,包括创建者,管理员,普通等级用户,受限用户(禁言+黑名单)即使非在线也可以在列表中看到,有数量限制,查询时时间戳使用"updatetime" */
58
- kNIMChatRoomGetMemberTypeSolid = 0,
59
- /** 非固定成员,非固定成员,又称临时成员,只有在线时才能在列表中看到,数量无上限,查询时时间戳使用"进入聊天室时间" */
60
- kNIMChatRoomGetMemberTypeTemp = 1,
61
- /** 在线固定成员 查询时时间戳使用"updatetime" */
62
- kNIMChatRoomGetMemberTypeSolidOL = 2,
63
- /** 非固定成员(反向查询) 查询时时间戳使用"进入聊天室时间" */
64
- kNIMChatRoomGetMemberTypeTempOL = 3
65
- }
66
- export declare enum NIMChatRoomMemberAttribute {
67
- kNIMChatRoomMemberAttributeAdminister = 1 /**< 管理员,operator必须是创建者 */,
68
- kNIMChatRoomMemberAttributeNomalMember = 2 /**< 普通成员,operator必须是创建者或管理员 */,
69
- kNIMChatRoomMemberAttributeBlackList = -1 /**< 黑名单,operator必须是创建者或管理员 */,
70
- kNIMChatRoomMemberAttributeMuteList = -2 /**< 禁言,operator必须是创建者或管理员 */
71
- }
72
- export declare enum NIMChatRoomOnlineState {
73
- kNIMChatRoomOnlineStateOffline = 0 /**<不在线 */,
74
- kNIMChatRoomOnlineStateOnline = 1 /**<在线 */
75
- }
76
- export declare enum NIMChatRoomGuestFlag {
77
- kNIMChatRoomGuestFlagNoGuest = 0 /**< 非游客 */,
78
- kNIMChatRoomGuestFlagGuest = 1 /**< 游客 */
79
- }
80
- export declare enum NIMChatRoomNotificationId {
81
- kNIMChatRoomNotificationIdMemberIn = 301 /**< 成员进入聊天室 */,
82
- kNIMChatRoomNotificationIdMemberExit = 302 /**< 成员离开聊天室 */,
83
- kNIMChatRoomNotificationIdAddBlack = 303 /**< 成员被加黑 */,
84
- kNIMChatRoomNotificationIdRemoveBlack = 304 /**< 成员被取消黑名单 */,
85
- kNIMChatRoomNotificationIdAddMute = 305 /**< 成员被设置禁言 */,
86
- kNIMChatRoomNotificationIdRemoveMute = 306 /**< 成员被取消禁言 */,
87
- kNIMChatRoomNotificationIdAddManager = 307 /**< 设置为管理员 */,
88
- kNIMChatRoomNotificationIdRemoveManager = 308 /**< 取消管理员 */,
89
- kNIMChatRoomNotificationIdAddFixed = 309 /**< 成员设定为固定成员 */,
90
- kNIMChatRoomNotificationIdRemoveFixed = 310 /**< 成员取消固定成员 */,
91
- kNIMChatRoomNotificationIdClosed = 311 /**< 聊天室被关闭了 */,
92
- kNIMChatRoomNotificationIdInfoUpdated = 312 /**< 聊天室信息被更新了 */,
93
- kNIMChatRoomNotificationIdMemberKicked = 313 /**< 成员被踢了 */,
94
- kNIMChatRoomNotificationIdMemberTempMute = 314 /**< 临时禁言 */,
95
- kNIMChatRoomNotificationIdMemberTempUnMute = 315 /**< 主动解除临时禁言 */,
96
- kNIMChatRoomNotificationIdMyRoleUpdated = 316 /**< 成员主动更新了聊天室内的角色信息(仅指nick/avator/ext) */,
97
- kNIMChatRoomNotificationIdQueueChanged = 317 /**< 麦序队列中有变更 "ext" : {"_e":"OFFER", "key":"element_key", "content":"element_value"} */,
98
- kNIMChatRoomNotificationIdRoomMuted = 318 /**< 聊天室被禁言了,只有管理员可以发言,其他人都处于禁言状态 */,
99
- kNIMChatRoomNotificationIdRoomDeMuted = 319 /**< 聊天室解除全体禁言状态 */,
100
- kNIMChatRoomNotificationIdQueueBatchChanged = 320 /**< 麦序队列中有批量变更,发生在元素提交者离开聊天室或者从聊天室异常掉线时 */,
101
- kNIMChatRoomNotificationIdTagTempMuteAdd = 321 /**< 聊天室新增标签禁言,包括的字段是muteDuration、targetTag、operator、opeNick字段 */,
102
- kNIMChatRoomNotificationIdTagTempMuteRemove = 322 /**< 聊天室移除标签禁言,包括的字段是muteDuration、targetTag、operator、opeNick字段 */,
103
- kNIMChatRoomNotificationIdRecallMessage = 323 /**< 聊天室消息撤回,包括的字段是operator、target、msgTime、msgId、ext字段 */,
104
- kNIMChatRoomNotificationIdQueueBatchOffer = 324 /** 聊天室麦序队列中有批量增加通知消息*/
105
- }
106
- export interface NIMChatRoomLocation {
107
- /** 位置信息 x 坐标 */
108
- x_?: number;
109
- /** 位置信息 y 坐标 */
110
- y_?: number;
111
- /** 位置信息 z 坐标 */
112
- z_?: number;
113
- /** 距离信息,仅在更新位置信息时会用到,发送消息、加入房间不需要填写 */
114
- distance_?: number;
115
- }
116
- export interface ChatRoomIndependentEnterInfo {
117
- /** 聊天室地址,地址通过应用服务器接口获取 */
118
- address_?: Array<string>;
119
- /** 应用数据目录 */
120
- app_data_file_?: string;
121
- /** 匿名登录时选填,定义见NIMSDKLogLevel(选填,SDK默认的内置级别为kNIMSDKLogLevelPro) */
122
- sdk_log_level_?: number;
123
- /** 应用appkey,匿名登录时必填 */
124
- app_key_?: string;
125
- /** 登录聊天室的账号 */
126
- accid_?: string;
127
- /** 登录聊天室的密码 */
128
- token_?: string;
129
- /** 登录标签,可以设置多个 */
130
- login_tags_?: Array<string>;
131
- /** 登录登出通知的目标标签 */
132
- notify_tags_?: string;
133
- /** 位置坐标描述 */
134
- location_?: NIMChatRoomLocation;
135
- /** 是否启用空间消息能力,true 为启用,false 为关闭,SDK 不解析 location 相关信息 */
136
- enable_location_?: boolean;
137
- /** 鉴权方式,0表示最初的loginToken的校验方式,1表示基于appSecret计算的token鉴权方式,2表示基于第三方回调的token鉴权方式,默认0 */
138
- auth_type_?: number;
139
- /** 登录自定义字段 */
140
- login_ext_?: string;
141
- /** 反垃圾相关业务id */
142
- anti_spam_business_id_?: string;
143
- }
144
- export interface ChatRoomAnoymityEnterInfo {
145
- /** 聊天室地址,地址通过应用服务器接口获取 */
146
- address_?: Array<string>;
147
- /** 应用数据目录,匿名登录时必填,使用默认路径时只需传入单个目录名(不以反斜杠结尾),使用自定义路径时需传入完整路径(以反斜杠结尾,并确保有正确的读写权限!) */
148
- app_data_file_?: string;
149
- /** 匿名登录时选填,定义见NIMSDKLogLevel(选填,SDK默认的内置级别为kNIMSDKLogLevelPro) */
150
- sdk_log_level_?: number;
151
- /** 应用appkey,匿名登录时必填 */
152
- app_key_?: string;
153
- /** 是否开启随机ID模式,默认为关闭(false),建议默认值 */
154
- random_id_?: boolean;
155
- /** 使用自定义用户 ID,一旦指定,SDK 不会自动生成随机 ID,random 参数将无效 */
156
- accid_?: string;
157
- /** 登录聊天室的密码 */
158
- token_?: string;
159
- }
160
- export interface ChatRoomConfig {
161
- public_config: {
162
- nego_key_neca: number;
163
- comm_enca: number;
164
- hand_shake_type: number;
165
- };
166
- private_config: {
167
- nego_key_enca_key_parta: string;
168
- nego_key_enca_key_partb: string;
169
- nego_key_enca_key_version: number;
170
- };
171
- }
172
- export interface ChatRoomEnterInfoValue {
173
- /** 设置进入聊天室后展示的昵称 */
174
- nick?: string;
175
- /** 设置进入聊天室后展示的头像 */
176
- avatar?: string;
177
- /** 设置聊天室可用的扩展字段 */
178
- ext?: string;
179
- /** 设置进入聊天室通知开发者扩展字段 */
180
- notify_ext?: string;
181
- /** 设置登录携带的 tag 列表 */
182
- login_tags?: Array<string>;
183
- /** 登录时携带的 notify tag 表达式 */
184
- notify_tags?: string;
185
- /** 设置鉴权方式 0表示最初的loginToken的校验方式,1表示基于appSecret计算的token鉴权方式,2表示基于第三方回调的token鉴权方式 */
186
- auth_type?: number;
187
- /** 登录自定义字段 */
188
- login_ext?: string;
189
- /** 配置反垃圾相关业务id */
190
- anti_spam_business_id?: string;
191
- /** 是否启用聊天室空间位置信息功能,启用后 SetLocation 功能才生效,否则 SDK 不解析 Location 信息 */
192
- enable_location?: boolean;
193
- /** 登录聊天室时传递的位置信息 */
194
- location_x?: number;
195
- location_y?: number;
196
- location_z?: number;
197
- location_distance?: number;
198
- }
199
- export interface ChatRoomEnterInfo {
200
- values_?: ChatRoomEnterInfoValue;
201
- }
202
- export interface ChatRoomMessageSetting {
203
- /** 消息重发标记位 */
204
- resend_flag_?: boolean;
205
- /** 第三方扩展字段, 必须为可以解析为json的非格式化的字符串,长度限制4096 */
206
- ext_?: string;
207
- /** 是否需要过易盾反垃圾 */
208
- anti_spam_enable_?: boolean;
209
- /** (可选)开发者自定义的反垃圾字段,长度限制2048 */
210
- anti_spam_content_?: string;
211
- /** (可选)是否存云端消息历史,默认存 */
212
- history_save_?: boolean;
213
- /** (可选)用户配置的对某些单条消息另外的反垃圾的业务ID */
214
- anti_spam_bizid_?: string;
215
- /** (可选) 单条消息是否使用易盾反垃圾 0:(在开通易盾的情况下)不过易盾反垃圾 */
216
- anti_spam_using_yidun_?: number;
217
- /** 高优先级消息标记,1:是; 非高优先级消息不带该字段,服务器填写,发送方不需要填写 */
218
- high_priority_?: number;
219
- /** (可选)String, 易盾反垃圾增强反作弊专属字段, 限制json,长度限制1024 */
220
- yidun_anti_cheating_?: string;
221
- /** (可选) 自定义抄送配置 */
222
- env_config_?: string;
223
- /** (可选)String, 易盾反垃圾扩展字段,限制json,长度限制1024 */
224
- anti_spam_ext_?: string;
225
- /** (可选)发送消息时附加的位置信息 */
226
- location_?: NIMChatRoomLocation;
227
- /** (可选)消息接受者,如果设置了本字段,且不为空,则本消息为聊天室定向消息(聊天室定向消息不会存历史) */
228
- to_accids?: Array<string>;
229
- }
230
- export interface ChatRoomMessage {
231
- /** 消息所属的聊天室id,服务器填写,发送方不需要填写 */
232
- room_id_?: number;
233
- /** 消息发送者的账号,服务器填写,发送方不需要填写 */
234
- from_id_?: string;
235
- /** 消息发送的时间戳(毫秒),服务器填写,发送方不需要填写 */
236
- timetag_?: number;
237
- /** 消息发送方客户端类型,服务器填写,发送方不需要填写 */
238
- from_client_type_?: NIMChatRoomClientType;
239
- /** 发送方昵称,服务器填写,发送方不需要填写 */
240
- from_nick_?: string;
241
- /** 发送方头像,服务器填写,发送方不需要填写 */
242
- from_avatar_?: string;
243
- /** 发送方身份扩展字段,服务器填写,发送方不需要填写 */
244
- from_ext_?: string;
245
- /** 第三方回调回来的自定义扩展字段 */
246
- third_party_callback_ext_?: string;
247
- /** 对端发送消息或通知时携带的 notify tags 信息 */
248
- notify_tags_?: string;
249
- /** String, 易盾反垃圾返回的结果字段 */
250
- anti_spam_res_?: string;
251
- /** 消息类型 */
252
- msg_type_?: NIMChatRoomMsgType;
253
- /** 消息内容,长度限制2048,json结构, 文本消息和其他消息保持一致 */
254
- msg_attach_?: string;
255
- /** 客户端消息id */
256
- client_msg_id_?: string;
257
- /** 文本消息内容(聊天室机器人文本消息) */
258
- msg_body_?: string;
259
- /** 消息属性设置 */
260
- msg_setting_?: ChatRoomMessageSetting;
261
- /** 消息的子类型,客户端定义,服务器透传 */
262
- sub_type_?: number;
263
- /** 媒体文件本地绝对路径(客户端) */
264
- local_res_path_?: string;
265
- /** 媒体文件ID(客户端) */
266
- local_res_id_?: string;
267
- }
268
- export interface ChatRoomNotification {
269
- /** 通知类型 */
270
- id_?: NIMChatRoomNotificationId;
271
- /** 上层开发自定义的事件通知扩展字段, 必须为可以解析为json的非格式化的字符串 */
272
- ext_?: string;
273
- /** 操作者的账号accid */
274
- operator_id_?: string;
275
- /** 操作者的账号nick */
276
- operator_nick_?: string;
277
- /** 被操作者的账号nick列表 */
278
- target_nick_?: Array<string>;
279
- /** 被操作者的accid列表 */
280
- target_ids_?: Array<string>;
281
- /** 当通知为临时禁言相关时有该值,禁言时代表本次禁言的时长(秒),解禁时代表本次禁言剩余时长(秒) */
282
- /** 当通知为聊天室进入事件,代表临时禁言时长(秒)其他通知事件不带该数据 */
283
- temp_mute_duration_?: number;
284
- /** 当通知为聊天室进入事件才有,代表是否禁言状态 */
285
- muted_?: boolean;
286
- /** 当通知为聊天室进入事件才有,代表是否临时禁言状态 */
287
- temp_muted_?: boolean;
288
- /** 当通知为聊天室队列变更事件才有,代表变更的内容 */
289
- queue_change_?: string;
290
- /** 当通知为聊天室按标签禁言/解禁事件才有,代表当前被禁言的 tag */
291
- target_tag_?: string;
292
- /** 当通知为聊天室撤回消息事件时才有,代表当前被撤回的消息 ID */
293
- msg_id_?: string;
294
- /** 当通知为聊天室撤回消息事件时才有,代表当前被撤回消息的时间戳 */
295
- msg_timetag_?: number;
296
- }
297
- export interface ChatRoomGetMembersParameters {
298
- /** 成员类型 */
299
- type_?: NIMChatRoomGetMemberType;
300
- /** 成员时间戳偏移量 */
301
- timestamp_offset_?: number;
302
- /** 数量 */
303
- limit_?: number;
304
- }
305
- export interface ChatRoomGetMembersByTagParameters {
306
- /** 成员 tag */
307
- tag_?: string;
308
- /** 成员时间戳偏移量 */
309
- timestamp_offset_?: number;
310
- /** 数量 */
311
- limit_?: number;
312
- }
313
- export interface ChatRoomGetMsgHistoryParameters {
314
- /** 开始时间,单位毫秒 */
315
- start_timetag_?: number;
316
- /** 本次返回的消息数量 */
317
- limit_?: number;
318
- /** 是否反向查询 */
319
- reverse_?: boolean;
320
- /** 类型 */
321
- msg_types_?: Array<NIMChatRoomMsgType>;
322
- }
323
- export interface ChatRoomGetMsgHistoryByTagsParameters {
324
- /** 开始时间,单位毫秒 */
325
- start_timetag_?: number;
326
- /** 结束时间,单位毫秒 */
327
- end_timetag_?: number;
328
- /** 本次返回的消息数量 */
329
- limit_?: number;
330
- /** 是否反向查询 */
331
- reverse_?: boolean;
332
- /** 标签 */
333
- tags_?: Array<string>;
334
- /** 类型 */
335
- msg_types_?: Array<NIMChatRoomMsgType>;
336
- }
337
- export interface ChatRoomSetMemberAttributeParameters {
338
- /** 成员ID */
339
- account_id_?: string;
340
- /** 身份标识 */
341
- attribute_?: NIMChatRoomMemberAttribute;
342
- /** true:是,false:否 */
343
- opt_?: boolean;
344
- /** 通知的扩展字段, 必须为可以解析为Json的非格式化的字符串 */
345
- notify_ext_?: string;
346
- }
347
- export interface ChatRoomMemberInfo {
348
- /** 聊天室id */
349
- room_id_?: number;
350
- /** 成员账号 */
351
- account_id_?: string;
352
- /** 聊天室成员登录时指定的 tag 信息 */
353
- tags_?: string;
354
- /** 成员类型, 0:普通;1:创建者;2:管理员;3:临时用户,非固定成员:-2:未设置;-1:受限用户;4:匿名非注册用户,非云信注册用户 */
355
- type_?: number;
356
- /** 成员级别: >=0表示用户开发者可以自定义的级别 */
357
- level_?: number;
358
- /** 聊天室内的昵称字段,预留字段, 可从Uinfo中取 */
359
- nick_?: string;
360
- /** 聊天室内的头像,预留字段, 可从Uinfo中取icon */
361
- avatar_?: string;
362
- /** 开发者扩展字段, 长度限制2k, 必须为可以解析为json的非格式化的字符串 */
363
- ext_?: string;
364
- /** 聊天室成员登录时指定的 notify_tags 信息 */
365
- notify_tags_?: string;
366
- /** 成员是否处于在线状态, 仅特殊成员才可能离线, 对游客/匿名用户而言只能是在线 */
367
- state_?: NIMChatRoomOnlineState;
368
- /** 是否是普通游客类型,0:不是游客,1:是游客; 游客身份在聊天室中没有持久化, 只有在线时才会有内存状态 */
369
- guest_flag_?: NIMChatRoomGuestFlag;
370
- /** 进入聊天室的时间点,对于离线成员该字段为空 */
371
- enter_timetag_?: number;
372
- /** 是黑名单 */
373
- is_blacklist_?: boolean;
374
- /** 是禁言用户 */
375
- is_muted_?: boolean;
376
- /** 记录有效标记位 */
377
- is_valid_?: boolean;
378
- /** 固定成员的记录更新时间,用于固定成员列表的排列查询 */
379
- update_timetag_?: number;
380
- /** 临时禁言 */
381
- temp_muted_?: boolean;
382
- /** 临时禁言的解除时长,单位秒 */
383
- temp_muted_duration_?: number;
384
- }
385
- export interface ChatRoomQueueElement {
386
- /** 元素的UniqKey,长度限制128字节 */
387
- key_?: string;
388
- /** 元素的内容,长度限制4096字节 */
389
- value_?: string;
390
- }
391
- export interface ChatRoomBatchMembers {
392
- members_values_?: Map<string, string>;
393
- }
394
- export interface ChatRoomQueueOfferOption {
395
- /** true 表示当提交这个新元素的用户从聊天室掉线或退出的时候,需要删除这个元素;默认 false 表示不删除 */
396
- transient_?: boolean;
397
- /** 队列元素所属账号,默认不传表示队列元素属于当前操作人,管理员可以指定队列元素归属于其他合法账号 */
398
- element_accid_?: string;
399
- }
400
- export interface ChatRoomUpdateTagsInfo {
401
- /** 标签 */
402
- tags_?: Array<string>;
403
- /** 更新标签的通知的目标标签,是一个标签表达式 */
404
- notify_target_tags_?: string;
405
- /** 1表示需要通知,如果需要通知,则会产生一条通知 */
406
- need_notify_?: number;
407
- /** 通知扩展字段 */
408
- ext_?: string;
409
- }
410
- export interface ChatRoomInfo {
411
- /** 聊天室ID */
412
- id_?: number;
413
- /** 聊天室名称 */
414
- name_?: string;
415
- /** 聊天室公告 */
416
- announcement_?: string;
417
- /** 视频直播拉流地址 */
418
- broadcast_url_?: string;
419
- /** 聊天室创建者账号 */
420
- creator_id_?: string;
421
- /** 聊天室有效标记, 1:有效,0:无效 */
422
- valid_flag_?: number;
423
- /** 第三方扩展字段, 必须为可以解析为json的非格式化的字符串, 长度4k */
424
- ext_?: string;
425
- /** 在线人数 */
426
- online_count_?: number;
427
- /** 聊天室禁言标志 1:禁言,0:非禁言 */
428
- mute_all_?: number;
429
- /** number, 队列管理权限:0:所有人都有权限变更队列,1:只有主播管理员才能操作变更 */
430
- queuelevel?: number;
431
- }
432
- export type GetMembersCallback = (room_id: number, rescode: NIMResCode, infos: Array<ChatRoomMemberInfo>) => void;
433
- export type GetMembersCountByTagCallback = (room_id: number, rescode: NIMResCode, count: number) => void;
434
- export type GetMsgHistoryCallback = (room_id: number, rescode: NIMResCode, msgs: Array<ChatRoomMessage>) => void;
435
- export type SetMemberAttributeCallback = (room_id: number, rescode: NIMResCode, info: ChatRoomMemberInfo) => void;
436
- export type GetChatRoomInfoCallback = (room_id: number, rescode: NIMResCode, info: ChatRoomInfo) => void;
437
- export type KickMemberCallback = (room_id: number, rescode: NIMResCode) => void;
438
- export type TempMuteMemberCallback = (room_id: number, rescode: NIMResCode, info: ChatRoomMemberInfo) => void;
439
- export type UpdateRoomInfoCallback = (room_id: number, rescode: NIMResCode) => void;
440
- export type UpdateMyRoomRoleCallback = (room_id: number, rescode: NIMResCode) => void;
441
- export type UpdateLocationCallback = (room_id: number, rescode: NIMResCode) => void;
442
- export type UpdateTagsCallback = (room_id: number, rescode: NIMResCode) => void;
443
- export type QueueOfferCallback = (room_id: number, rescode: NIMResCode, element: ChatRoomQueueElement) => void;
444
- export type QueuePollCallback = (room_id: number, rescode: NIMResCode, element: ChatRoomQueueElement) => void;
445
- export type QueueListCallback = (room_id: number, rescode: NIMResCode, queue: Array<ChatRoomQueueElement>) => void;
446
- export type QueueDropCallback = (room_id: number, rescode: NIMResCode) => void;
447
- export type QueueHeaderCallback = (room_id: number, rescode: NIMResCode, element: ChatRoomQueueElement) => void;
448
- export type QueueBatchUpdateCallback = (room_id: number, rescode: NIMResCode, not_in_queue: Array<string>) => void;
@@ -1,25 +0,0 @@
1
- import { V2NIMInitOption, V2NIMError } from 'ts/v2_def/v2_nim_struct_def';
2
- import { EventEmitter } from 'eventemitter3';
3
- import { V2NIMLoginService } from './v2_nim_login_service';
4
- export declare interface V2NIMInstanceEvents {
5
- }
6
- export declare class V2NIMInstance extends EventEmitter<V2NIMInstanceEvents> {
7
- instance: any;
8
- loginService: V2NIMLoginService | null;
9
- constructor();
10
- /**
11
- * 初始化
12
- * @param option - 初始化选项
13
- * @returns V2NIMError | null
14
- * @example
15
- */
16
- init(option: V2NIMInitOption): V2NIMError | null;
17
- /** @brief 反初始化
18
- * @return V2NIMError | null
19
- */
20
- uninit(): V2NIMError | null;
21
- /** @brief 获取登录服务
22
- * @return V2NIMLoginService
23
- */
24
- getLoginService(): V2NIMLoginService | null;
25
- }