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.
- package/README.md +7 -1
- package/dist/loader.js +35 -35
- package/dist/nim/client.js +184 -184
- package/dist/nim/client.js.map +1 -1
- package/dist/nim/data_sync.js +19 -19
- package/dist/nim/friend.js +150 -150
- package/dist/nim/global.js +131 -131
- package/dist/nim/msglog.js +687 -687
- package/dist/nim/nos.js +216 -180
- package/dist/nim/nos.js.map +1 -1
- package/dist/nim/online_session.js +85 -85
- package/dist/nim/pass_through_proxy.js +39 -39
- package/dist/nim/plugin.js +65 -65
- package/dist/nim/session.js +392 -392
- package/dist/nim/subscribe_event.js +142 -142
- package/dist/nim/super_team.js +592 -592
- package/dist/nim/sysmsg.js +194 -194
- package/dist/nim/talk.js +209 -209
- package/dist/nim/talk.js.map +1 -1
- package/dist/nim/talkex.js +191 -191
- package/dist/nim/team.js +818 -818
- package/dist/nim/tool.js +119 -119
- package/dist/nim/user.js +201 -201
- package/dist/nim_def/client_def.js +245 -245
- package/dist/nim_def/client_def.js.map +1 -1
- package/dist/nim_def/data_sync_def.js +20 -20
- package/dist/nim_def/doc_trans_def.js +16 -16
- package/dist/nim_def/friend_def.js +37 -37
- package/dist/nim_def/global_def.js +39 -39
- package/dist/nim_def/msglog_def.js +148 -148
- package/dist/nim_def/nos_def.js +16 -16
- package/dist/nim_def/online_session_def.js +2 -2
- package/dist/nim_def/pass_through_proxy_def.js +10 -10
- package/dist/nim_def/plugin_def.js +2 -2
- package/dist/nim_def/session_def.js +26 -26
- package/dist/nim_def/subscribe_event_def.js +52 -52
- package/dist/nim_def/super_team_def.js +64 -64
- package/dist/nim_def/sysmsg_def.js +28 -28
- package/dist/nim_def/talk_def.js +2 -2
- package/dist/nim_def/talkex_def.js +2 -2
- package/dist/nim_def/team_def.js +69 -69
- package/dist/nim_def/tool_def.js +11 -11
- package/dist/nim_def/user_def.js +22 -22
- package/dist/node-nim.js +171 -171
- package/dist/node-nim.js.map +1 -1
- package/dist/qchat/attachment.js +63 -63
- package/dist/qchat/channel.js +314 -314
- package/dist/qchat/channel_category.js +187 -187
- package/dist/qchat/instance.js +77 -77
- package/dist/qchat/message.js +285 -285
- package/dist/qchat/role.js +423 -423
- package/dist/qchat/server.js +453 -453
- package/dist/qchat/system_notification.js +74 -74
- package/dist/qchat_def/attachment_def.js +2 -2
- package/dist/qchat_def/channel_def.js +2 -2
- package/dist/qchat_def/instance_def.js +2 -2
- package/dist/qchat_def/message_def.js +2 -2
- package/dist/qchat_def/public_def.js +649 -649
- package/dist/qchat_def/public_def.js.map +1 -1
- package/dist/qchat_def/role_def.js +2 -2
- package/dist/qchat_def/server_def.js +2 -2
- package/dist/qchat_def/system_notification_def.js +2 -2
- package/dist/v2/v2_nim_chatroom_client.js +135 -0
- package/dist/v2/v2_nim_chatroom_client.js.map +1 -0
- package/dist/v2/v2_nim_chatroom_service.js +244 -0
- package/dist/v2/v2_nim_chatroom_service.js.map +1 -0
- package/dist/v2/v2_nim_client.js +138 -0
- package/dist/v2/v2_nim_client.js.map +1 -0
- package/dist/v2/v2_nim_conversation_group_service.js +116 -0
- package/dist/v2/v2_nim_conversation_group_service.js.map +1 -0
- package/dist/v2/v2_nim_conversation_service.js +236 -0
- package/dist/v2/v2_nim_conversation_service.js.map +1 -0
- package/dist/v2/v2_nim_friend_service.js +128 -0
- package/dist/v2/v2_nim_friend_service.js.map +1 -0
- package/dist/v2/v2_nim_login_service.js +119 -123
- package/dist/v2/v2_nim_login_service.js.map +1 -1
- package/dist/v2/v2_nim_message_service.js +382 -0
- package/dist/v2/v2_nim_message_service.js.map +1 -0
- package/dist/v2/v2_nim_notification_service.js +30 -0
- package/dist/v2/v2_nim_notification_service.js.map +1 -0
- package/dist/v2/v2_nim_setting_service.js +86 -0
- package/dist/v2/v2_nim_setting_service.js.map +1 -0
- package/dist/v2/v2_nim_storage_service.js +58 -0
- package/dist/v2/v2_nim_storage_service.js.map +1 -0
- package/dist/v2/v2_nim_team_service.js +360 -0
- package/dist/v2/v2_nim_team_service.js.map +1 -0
- package/dist/v2/v2_nim_user_service.js +76 -0
- package/dist/v2/v2_nim_user_service.js.map +1 -0
- package/dist/v2/v2_nim_utilities.js +276 -0
- package/dist/v2/v2_nim_utilities.js.map +1 -0
- package/dist/v2_def/v2_nim_callback_def.js +2 -2
- package/dist/v2_def/v2_nim_enum_def.js +1087 -325
- package/dist/v2_def/v2_nim_enum_def.js.map +1 -1
- package/dist/v2_def/v2_nim_struct_def.js +2 -2
- package/package.json +74 -74
- package/script/download-sdk.js +78 -78
- package/script/exec-node-nim-tester.js +17 -17
- package/script/publish-to-netease-npm.js +3 -2
- package/types/loader.d.ts +2 -2
- package/types/nim/client.d.ts +123 -123
- package/types/nim/data_sync.d.ts +12 -12
- package/types/nim/friend.d.ts +82 -82
- package/types/nim/global.d.ts +69 -69
- package/types/nim/msglog.d.ts +392 -392
- package/types/nim/nos.d.ts +118 -118
- package/types/nim/online_session.d.ts +44 -44
- package/types/nim/pass_through_proxy.d.ts +24 -24
- package/types/nim/plugin.d.ts +39 -39
- package/types/nim/session.d.ts +212 -212
- package/types/nim/subscribe_event.d.ts +87 -87
- package/types/nim/super_team.d.ts +331 -331
- package/types/nim/sysmsg.d.ts +105 -105
- package/types/nim/talk.d.ts +94 -94
- package/types/nim/talkex.d.ts +95 -95
- package/types/nim/team.d.ts +461 -461
- package/types/nim/tool.d.ts +77 -77
- package/types/nim/user.d.ts +111 -111
- package/types/nim_def/client_def.d.ts +284 -284
- package/types/nim_def/data_sync_def.d.ts +19 -19
- package/types/nim_def/doc_trans_def.d.ts +11 -11
- package/types/nim_def/friend_def.d.ts +65 -65
- package/types/nim_def/global_def.d.ts +62 -62
- package/types/nim_def/msglog_def.d.ts +373 -373
- package/types/nim_def/nos_def.d.ts +72 -72
- package/types/nim_def/online_session_def.d.ts +34 -34
- package/types/nim_def/pass_through_proxy_def.d.ts +13 -13
- package/types/nim_def/plugin_def.d.ts +8 -8
- package/types/nim_def/session_def.d.ts +114 -114
- package/types/nim_def/subscribe_event_def.d.ts +83 -83
- package/types/nim_def/super_team_def.d.ts +144 -137
- package/types/nim_def/sysmsg_def.d.ts +70 -70
- package/types/nim_def/talk_def.d.ts +96 -96
- package/types/nim_def/talkex_def.d.ts +112 -112
- package/types/nim_def/team_def.d.ts +167 -167
- package/types/nim_def/tool_def.d.ts +28 -28
- package/types/nim_def/user_def.d.ts +59 -59
- package/types/node-nim.d.ts +90 -93
- package/types/qchat/attachment.d.ts +40 -40
- package/types/qchat/channel.d.ts +139 -139
- package/types/qchat/channel_category.d.ts +82 -82
- package/types/qchat/instance.d.ts +46 -46
- package/types/qchat/message.d.ts +128 -128
- package/types/qchat/role.d.ts +166 -166
- package/types/qchat/server.d.ts +198 -198
- package/types/qchat/system_notification.d.ts +39 -39
- package/types/qchat_def/attachment_def.d.ts +71 -71
- package/types/qchat_def/channel_def.d.ts +643 -643
- package/types/qchat_def/instance_def.d.ts +214 -214
- package/types/qchat_def/message_def.d.ts +565 -565
- package/types/qchat_def/public_def.d.ts +754 -754
- package/types/qchat_def/role_def.d.ts +413 -413
- package/types/qchat_def/server_def.d.ts +529 -529
- package/types/qchat_def/system_notification_def.d.ts +172 -172
- package/types/v2/v2_nim_chatroom_client.d.ts +73 -0
- package/types/v2/v2_nim_chatroom_service.d.ts +114 -0
- package/types/v2/v2_nim_client.d.ts +75 -0
- package/types/v2/v2_nim_conversation_group_service.d.ts +54 -0
- package/types/v2/v2_nim_conversation_service.d.ts +110 -0
- package/types/v2/v2_nim_friend_service.d.ts +58 -0
- package/types/v2/v2_nim_login_service.d.ts +80 -96
- package/types/v2/v2_nim_message_service.d.ts +143 -0
- package/types/v2/v2_nim_notification_service.d.ts +18 -0
- package/types/v2/v2_nim_setting_service.d.ts +43 -0
- package/types/v2/v2_nim_storage_service.d.ts +28 -0
- package/types/v2/v2_nim_team_service.d.ts +184 -0
- package/types/v2/v2_nim_user_service.d.ts +34 -0
- package/types/v2/v2_nim_utilities.d.ts +168 -0
- package/types/v2_def/v2_nim_callback_def.d.ts +7 -20
- package/types/v2_def/v2_nim_enum_def.d.ts +1009 -300
- package/types/v2_def/v2_nim_struct_def.d.ts +1539 -338
- package/dist/chatroom/chatroom.js +0 -263
- package/dist/chatroom/chatroom.js.map +0 -1
- package/dist/chatroom_def/chatroom_def.js +0 -120
- package/dist/chatroom_def/chatroom_def.js.map +0 -1
- package/dist/v2/v2_nim_instance.js +0 -44
- package/dist/v2/v2_nim_instance.js.map +0 -1
- package/types/chatroom/chatroom.d.ts +0 -55
- package/types/chatroom_def/chatroom_def.d.ts +0 -448
- package/types/v2/v2_nim_instance.d.ts +0 -25
|
@@ -1,83 +1,83 @@
|
|
|
1
|
-
import { NIMResCode } from './client_def';
|
|
2
|
-
/** @enum NIMEventBroadcastType 事件广播类型 */
|
|
3
|
-
export declare enum NIMEventBroadcastType {
|
|
4
|
-
kNIMEventBroadcastTypeOnline = 1 /** < 仅在线 */,
|
|
5
|
-
kNIMEventBroadcastTypeAll = 2 /** < 在线和离线 */
|
|
6
|
-
}
|
|
7
|
-
/** @enum NIMEventSyncType 事件同步类型 */
|
|
8
|
-
export declare enum NIMEventSyncType {
|
|
9
|
-
kNIMEventSyncTypeNoSelf = 0 /** < 事件不同步给自己其他端 */,
|
|
10
|
-
kNIMEventSyncTypeSelf = 1 /** < 事件同步给自己其他端 */
|
|
11
|
-
}
|
|
12
|
-
/** @enum NIMEventSubscribeSyncEventType 订阅的事件的同步类型 */
|
|
13
|
-
export declare enum NIMEventSubscribeSyncEventType {
|
|
14
|
-
kNIMEventSubscribeSyncTypeUnSync = 0 /** < 订阅后不同步最新事件 */,
|
|
15
|
-
kNIMEventSubscribeSyncTypeSync = 1 /** < 订阅后立即同步最新事件 */
|
|
16
|
-
}
|
|
17
|
-
/** @enum NIMEventType 服务器预定义的事件类型 */
|
|
18
|
-
export declare enum NIMEventType {
|
|
19
|
-
kNIMEventTypeOnlineState = 1 /** < 在线状态事件(客户端可发送) */,
|
|
20
|
-
kNIMEventTypeCustom = 100000 /** < 服务器保留1~99999的事件类型,客户端自定义事件类型需大于99999 */
|
|
21
|
-
}
|
|
22
|
-
/** @enum NIMEventOnlineStateValue 在线状态事件值 */
|
|
23
|
-
export declare enum NIMEventOnlineStateValue {
|
|
24
|
-
kNIMEventOnlineStateValueLogin = 1 /** < 登录 */,
|
|
25
|
-
kNIMEventOnlineStateValueLogout = 2 /** < 登出 */,
|
|
26
|
-
kNIMEventOnlineStateValueDisconnect = 3 /** < 断开连接 */,
|
|
27
|
-
kNIMEventOnlineStateValueCustom = 10000 /** < 在线状态事件服务器保留1~9999的事件值,客户端自定义事件值需大于9999 */,
|
|
28
|
-
kNIMEventOnlineStateValueUpdateConfig = 10001 /** < 自己的其他端更新了自己端的multi_config信息 */
|
|
29
|
-
}
|
|
30
|
-
export declare enum NIMOnlineState {
|
|
31
|
-
kOnlineStateOnline = 0,
|
|
32
|
-
kOnlineStateBusy = 1,
|
|
33
|
-
kOnlineStateLeave = 2
|
|
34
|
-
}
|
|
35
|
-
export declare enum NIMNetState {
|
|
36
|
-
kNetStateUnknow = 0,
|
|
37
|
-
kNetStateWifi = 1,
|
|
38
|
-
kNetStateWwan = 2,
|
|
39
|
-
kNetState2G = 3,
|
|
40
|
-
kNetState3G = 4,
|
|
41
|
-
kNetState4G = 5
|
|
42
|
-
}
|
|
43
|
-
export interface EventData {
|
|
44
|
-
event_type_?: number; /**< 事件类型,服务器保留1~99999的事件类型,客户端自定义事件类型需大于99999 */
|
|
45
|
-
event_value_?: number; /**< 事件状态,在线状态事件服务器保留1~9999的事件值,客户端自定义事件值需大于9999 */
|
|
46
|
-
client_msg_id_?: string; /**< 客户端生成的消息id */
|
|
47
|
-
config_?: string; /**< 用户自定义事件扩展属性,最长4K */
|
|
48
|
-
ttl_?: number; /**< 事件有效期,单位:秒,时间范围:60s到7天 */
|
|
49
|
-
broadcast_type_?: NIMEventBroadcastType; /**< 事件广播类型 */
|
|
50
|
-
sync_self_?: NIMEventSyncType; /**< 事件同步类型 */
|
|
51
|
-
readonly_ttl_type?: number; /**< TtlType枚举值 */
|
|
52
|
-
readonly_durable_?: number; /**< 是否需要持久化(可选字段),默认为需要持久化,0:不需要持久化,1:需要持久化 */
|
|
53
|
-
readonly_event_time_?: number; /**< 事件发布的时间戳,服务器补充 */
|
|
54
|
-
readonly_server_msg_id_?: string; /**< 服务端生成的消息id */
|
|
55
|
-
readonly_client_type_?: number; /**< 发送客户端类型 */
|
|
56
|
-
readonly_nim_config_?: string; /**< 预定义事件的扩展字段(在线状态事件:在线的客户端类型Json) */
|
|
57
|
-
readonly_multi_config_?: string; /**< 多端配置信息字段,JSON格式{"clent_type":"clent_config","1":"xxx","2":"xxx"} */
|
|
58
|
-
readonly_publisher_accid_?: string; /**< 事件发布者的accid */
|
|
59
|
-
readonly_consid_?: string; /**< 发送设备id */
|
|
60
|
-
}
|
|
61
|
-
export interface EventSubscribeData {
|
|
62
|
-
event_type_?: number; /**< 事件类型 */
|
|
63
|
-
ttl_?: number; /**< 订阅有效期,单位:秒,范围:60s到30天 */
|
|
64
|
-
sync_event_?: NIMEventSubscribeSyncEventType; /**< 订阅的事件的同步类型 */
|
|
65
|
-
publisher_accid_?: string; /**< 被订阅人(事件发布人)的accid */
|
|
66
|
-
subscribe_accid_?: string; /**< 订阅人的accid */
|
|
67
|
-
subscribe_time_?: number; /**< 订阅时间戳 */
|
|
68
|
-
}
|
|
69
|
-
export type PushEventCallback = (rescode: NIMResCode, result: EventData) => void;
|
|
70
|
-
export type BatchPushEventCallback = (rescode: NIMResCode, result: Array<EventData>) => void;
|
|
71
|
-
export type PublishEventCallback = (rescode: NIMResCode, eventType: number, result: EventData) => void;
|
|
72
|
-
export type SubscribeEventCallback = (rescode: NIMResCode, eventType: number, failedList: Array<string>) => void;
|
|
73
|
-
export type UnSubscribeEventCallback = (rescode: NIMResCode, eventType: number, failedList: Array<string>) => void;
|
|
74
|
-
export type BatchUnSubscribeEventCallback = (rescode: NIMResCode, eventType: number) => void;
|
|
75
|
-
export type QuerySubscribeEventCallback = (rescode: NIMResCode, eventType: number, result: Array<EventSubscribeData>) => void;
|
|
76
|
-
export interface NIMSubscribeEventAPI {
|
|
77
|
-
InitEventHandlers(): void;
|
|
78
|
-
Publish(data: EventData, cb: PublishEventCallback | null, jsonExtension: string): boolean;
|
|
79
|
-
Subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback | null, jsonExtension: string): boolean;
|
|
80
|
-
UnSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback | null, jsonExtension: string): boolean;
|
|
81
|
-
BatchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback | null, jsonExtension: string): boolean;
|
|
82
|
-
QuerySubscribe(eventType: NIMEventType, accids: Array<string>, cb: QuerySubscribeEventCallback | null, jsonExtension: string): void;
|
|
83
|
-
}
|
|
1
|
+
import { NIMResCode } from './client_def';
|
|
2
|
+
/** @enum NIMEventBroadcastType 事件广播类型 */
|
|
3
|
+
export declare enum NIMEventBroadcastType {
|
|
4
|
+
kNIMEventBroadcastTypeOnline = 1 /** < 仅在线 */,
|
|
5
|
+
kNIMEventBroadcastTypeAll = 2 /** < 在线和离线 */
|
|
6
|
+
}
|
|
7
|
+
/** @enum NIMEventSyncType 事件同步类型 */
|
|
8
|
+
export declare enum NIMEventSyncType {
|
|
9
|
+
kNIMEventSyncTypeNoSelf = 0 /** < 事件不同步给自己其他端 */,
|
|
10
|
+
kNIMEventSyncTypeSelf = 1 /** < 事件同步给自己其他端 */
|
|
11
|
+
}
|
|
12
|
+
/** @enum NIMEventSubscribeSyncEventType 订阅的事件的同步类型 */
|
|
13
|
+
export declare enum NIMEventSubscribeSyncEventType {
|
|
14
|
+
kNIMEventSubscribeSyncTypeUnSync = 0 /** < 订阅后不同步最新事件 */,
|
|
15
|
+
kNIMEventSubscribeSyncTypeSync = 1 /** < 订阅后立即同步最新事件 */
|
|
16
|
+
}
|
|
17
|
+
/** @enum NIMEventType 服务器预定义的事件类型 */
|
|
18
|
+
export declare enum NIMEventType {
|
|
19
|
+
kNIMEventTypeOnlineState = 1 /** < 在线状态事件(客户端可发送) */,
|
|
20
|
+
kNIMEventTypeCustom = 100000 /** < 服务器保留1~99999的事件类型,客户端自定义事件类型需大于99999 */
|
|
21
|
+
}
|
|
22
|
+
/** @enum NIMEventOnlineStateValue 在线状态事件值 */
|
|
23
|
+
export declare enum NIMEventOnlineStateValue {
|
|
24
|
+
kNIMEventOnlineStateValueLogin = 1 /** < 登录 */,
|
|
25
|
+
kNIMEventOnlineStateValueLogout = 2 /** < 登出 */,
|
|
26
|
+
kNIMEventOnlineStateValueDisconnect = 3 /** < 断开连接 */,
|
|
27
|
+
kNIMEventOnlineStateValueCustom = 10000 /** < 在线状态事件服务器保留1~9999的事件值,客户端自定义事件值需大于9999 */,
|
|
28
|
+
kNIMEventOnlineStateValueUpdateConfig = 10001 /** < 自己的其他端更新了自己端的multi_config信息 */
|
|
29
|
+
}
|
|
30
|
+
export declare enum NIMOnlineState {
|
|
31
|
+
kOnlineStateOnline = 0,
|
|
32
|
+
kOnlineStateBusy = 1,
|
|
33
|
+
kOnlineStateLeave = 2
|
|
34
|
+
}
|
|
35
|
+
export declare enum NIMNetState {
|
|
36
|
+
kNetStateUnknow = 0,
|
|
37
|
+
kNetStateWifi = 1,
|
|
38
|
+
kNetStateWwan = 2,
|
|
39
|
+
kNetState2G = 3,
|
|
40
|
+
kNetState3G = 4,
|
|
41
|
+
kNetState4G = 5
|
|
42
|
+
}
|
|
43
|
+
export interface EventData {
|
|
44
|
+
event_type_?: number; /**< 事件类型,服务器保留1~99999的事件类型,客户端自定义事件类型需大于99999 */
|
|
45
|
+
event_value_?: number; /**< 事件状态,在线状态事件服务器保留1~9999的事件值,客户端自定义事件值需大于9999 */
|
|
46
|
+
client_msg_id_?: string; /**< 客户端生成的消息id */
|
|
47
|
+
config_?: string; /**< 用户自定义事件扩展属性,最长4K */
|
|
48
|
+
ttl_?: number; /**< 事件有效期,单位:秒,时间范围:60s到7天 */
|
|
49
|
+
broadcast_type_?: NIMEventBroadcastType; /**< 事件广播类型 */
|
|
50
|
+
sync_self_?: NIMEventSyncType; /**< 事件同步类型 */
|
|
51
|
+
readonly_ttl_type?: number; /**< TtlType枚举值 */
|
|
52
|
+
readonly_durable_?: number; /**< 是否需要持久化(可选字段),默认为需要持久化,0:不需要持久化,1:需要持久化 */
|
|
53
|
+
readonly_event_time_?: number; /**< 事件发布的时间戳,服务器补充 */
|
|
54
|
+
readonly_server_msg_id_?: string; /**< 服务端生成的消息id */
|
|
55
|
+
readonly_client_type_?: number; /**< 发送客户端类型 */
|
|
56
|
+
readonly_nim_config_?: string; /**< 预定义事件的扩展字段(在线状态事件:在线的客户端类型Json) */
|
|
57
|
+
readonly_multi_config_?: string; /**< 多端配置信息字段,JSON格式{"clent_type":"clent_config","1":"xxx","2":"xxx"} */
|
|
58
|
+
readonly_publisher_accid_?: string; /**< 事件发布者的accid */
|
|
59
|
+
readonly_consid_?: string; /**< 发送设备id */
|
|
60
|
+
}
|
|
61
|
+
export interface EventSubscribeData {
|
|
62
|
+
event_type_?: number; /**< 事件类型 */
|
|
63
|
+
ttl_?: number; /**< 订阅有效期,单位:秒,范围:60s到30天 */
|
|
64
|
+
sync_event_?: NIMEventSubscribeSyncEventType; /**< 订阅的事件的同步类型 */
|
|
65
|
+
publisher_accid_?: string; /**< 被订阅人(事件发布人)的accid */
|
|
66
|
+
subscribe_accid_?: string; /**< 订阅人的accid */
|
|
67
|
+
subscribe_time_?: number; /**< 订阅时间戳 */
|
|
68
|
+
}
|
|
69
|
+
export type PushEventCallback = (rescode: NIMResCode, result: EventData) => void;
|
|
70
|
+
export type BatchPushEventCallback = (rescode: NIMResCode, result: Array<EventData>) => void;
|
|
71
|
+
export type PublishEventCallback = (rescode: NIMResCode, eventType: number, result: EventData) => void;
|
|
72
|
+
export type SubscribeEventCallback = (rescode: NIMResCode, eventType: number, failedList: Array<string>) => void;
|
|
73
|
+
export type UnSubscribeEventCallback = (rescode: NIMResCode, eventType: number, failedList: Array<string>) => void;
|
|
74
|
+
export type BatchUnSubscribeEventCallback = (rescode: NIMResCode, eventType: number) => void;
|
|
75
|
+
export type QuerySubscribeEventCallback = (rescode: NIMResCode, eventType: number, result: Array<EventSubscribeData>) => void;
|
|
76
|
+
export interface NIMSubscribeEventAPI {
|
|
77
|
+
InitEventHandlers(): void;
|
|
78
|
+
Publish(data: EventData, cb: PublishEventCallback | null, jsonExtension: string): boolean;
|
|
79
|
+
Subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback | null, jsonExtension: string): boolean;
|
|
80
|
+
UnSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback | null, jsonExtension: string): boolean;
|
|
81
|
+
BatchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback | null, jsonExtension: string): boolean;
|
|
82
|
+
QuerySubscribe(eventType: NIMEventType, accids: Array<string>, cb: QuerySubscribeEventCallback | null, jsonExtension: string): void;
|
|
83
|
+
}
|
|
@@ -1,137 +1,144 @@
|
|
|
1
|
-
import { NIMResCode } from './client_def';
|
|
2
|
-
import { NIMNotificationId } from './msglog_def';
|
|
3
|
-
import { UserNameCard } from './user_def';
|
|
4
|
-
/** @enum NIMSuperTeamBitsConfigMask 群组成员信息Bits属性kNIMSuperTeamUserKeyBits的配置定义 */
|
|
5
|
-
export declare enum NIMSuperTeamBitsConfigMask {
|
|
6
|
-
kNIMSuperTeamBitsConfigMaskMuteNone = 0 /** < 开启提醒 bits 0000b*/,
|
|
7
|
-
kNIMSuperTeamBitsConfigMaskMuteNotify = 1 /** < 关闭提醒 bits 0001b*/,
|
|
8
|
-
kNIMSuperTeamBitsConfigMaskOnlyAdmin = 2 /** < 只接收管理员消息 bits 0010b 超大群当前不支持该选项*/
|
|
9
|
-
}
|
|
10
|
-
/** @enum NIMSuperTeamUserType 群成员类型 */
|
|
11
|
-
export declare enum NIMSuperTeamUserType {
|
|
12
|
-
kNIMSuperTeamUserTypeNomal = 0 /** < 普通成员 */,
|
|
13
|
-
kNIMSuperTeamUserTypeCreator = 1 /** < 创建者 */,
|
|
14
|
-
kNIMSuperTeamUserTypeManager = 2 /** < 管理员 */,
|
|
15
|
-
kNIMSuperTeamUserTypeApply = 3 /** < 申请加入用户 */,
|
|
16
|
-
kNIMSuperTeamUserTypeLocalWaitAccept = 100 /** < 本地记录等待正在入群的用户 */
|
|
17
|
-
}
|
|
18
|
-
/** @enum NIMSuperTeamBeInviteMode 被邀请人同意方式 */
|
|
19
|
-
export declare enum NIMSuperTeamBeInviteMode {
|
|
20
|
-
kNIMSuperTeamBeInviteModeNeedAgree = 0 /** < 需要同意 */,
|
|
21
|
-
kNIMSuperTeamBeInviteModeNotNeedAgree = 1 /** < 不需要同意 */
|
|
22
|
-
}
|
|
23
|
-
/** @enum NIMSuperTeamInviteMode 谁可以邀请他人入群 */
|
|
24
|
-
export declare enum NIMSuperTeamInviteMode {
|
|
25
|
-
kNIMSuperTeamInviteModeManager = 0 /** < 管理员 */,
|
|
26
|
-
kNIMSuperTeamInviteModeEveryone = 1 /** < 所有人 */
|
|
27
|
-
}
|
|
28
|
-
/** @enum NIMSuperTeamUpdateInfoMode 谁可以修改群资料 */
|
|
29
|
-
export declare enum NIMSuperTeamUpdateInfoMode {
|
|
30
|
-
kNIMSuperTeamUpdateInfoModeManager = 0 /** < 管理员 */,
|
|
31
|
-
kNIMSuperTeamUpdateInfoModeEveryone = 1 /** < 所有人 */
|
|
32
|
-
}
|
|
33
|
-
/** @enum NIMSuperTeamUpdateCustomMode 谁可以更新群自定义属性 */
|
|
34
|
-
export declare enum NIMSuperTeamUpdateCustomMode {
|
|
35
|
-
kNIMSuperTeamUpdateCustomModeManager = 0 /** < 管理员 */,
|
|
36
|
-
kNIMSuperTeamUpdateCustomModeEveryone = 1 /** < 所有人 */
|
|
37
|
-
}
|
|
38
|
-
/** @enum NIMSuperTeamJoinMode 群允许加入类型 */
|
|
39
|
-
export declare enum NIMSuperTeamJoinMode {
|
|
40
|
-
kNIMSuperTeamJoinModeNoAuth = 0 /** < 不用验证 */,
|
|
41
|
-
kNIMSuperTeamJoinModeNeedAuth = 1 /** < 需要验证 */,
|
|
42
|
-
kNIMSuperTeamJoinModeRejectAll = 2 /** < 拒绝所有人入群 */
|
|
43
|
-
}
|
|
44
|
-
/** @enum NIMSuperTeamQueryType 根据关键字查询群组信息类型 */
|
|
45
|
-
export declare enum NIMSuperTeamQueryType {
|
|
46
|
-
kNIMQuerySuperTeamDefault = 1 /** 默认查询条件,群组 ID 和群名称任意匹配则返回 */,
|
|
47
|
-
kNIMQuerySuperTeamByTeamId = 2 /** 仅匹配群组 ID */,
|
|
48
|
-
kNIMQuerySuperTeamByTeamName = 3 /** 仅匹配群名称 */
|
|
49
|
-
}
|
|
50
|
-
/** @enum NIMSuperTeamMuteType 群信息kNIMSuperTeamInfoKeyMuteType的配置定义 */
|
|
51
|
-
export declare enum NIMSuperTeamMuteType {
|
|
52
|
-
kNIMSuperTeamMuteTypeNone = 0 /**< 不禁言 */,
|
|
53
|
-
kNIMSuperTeamMuteTypeNomalMute = 1 /**< 普通成员禁言 */,
|
|
54
|
-
kNIMSuperTeamMuteTypeAllMute = 3 /**< 全部禁言 */
|
|
55
|
-
}
|
|
56
|
-
export interface SuperTeamEvent {
|
|
57
|
-
res_code_?: NIMResCode; /**< 错误码 */
|
|
58
|
-
notification_id_?: NIMNotificationId; /**< 通知类型ID */
|
|
59
|
-
team_id_?: string; /**< 群组ID */
|
|
60
|
-
ids_?: Array<string>; /**< 通知可能涉及到的群成员ID */
|
|
61
|
-
invalid_ids_?: Array<string>; /**< 通知可能涉及到的失效的群成员ID,比如邀请入群的成员的群数量超限导致当次邀请失败 */
|
|
62
|
-
namecards_?: Array<UserNameCard>; /**< 通知可能涉及到的群成员的用户名片 */
|
|
63
|
-
team_info_?: SuperTeamInfo; /**< 通知可能涉及到的群信息 */
|
|
64
|
-
member_property_?: SuperTeamMemberProperty; /**< 群成员属性 */
|
|
65
|
-
opt_?: boolean; /**< 操作 */
|
|
66
|
-
attach_?: string; /**< 扩展字段,目前仅kick和invite事件可选 */
|
|
67
|
-
src_data_?: string; /**< 未解析过的原信息,目前仅支持群消息未读数相关事件 */
|
|
68
|
-
}
|
|
69
|
-
export interface SuperTeamInfoJsonValue {
|
|
70
|
-
tid?: string;
|
|
71
|
-
name?: string;
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
export
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
export type
|
|
111
|
-
export
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
1
|
+
import { NIMResCode } from './client_def';
|
|
2
|
+
import { NIMNotificationId } from './msglog_def';
|
|
3
|
+
import { UserNameCard } from './user_def';
|
|
4
|
+
/** @enum NIMSuperTeamBitsConfigMask 群组成员信息Bits属性kNIMSuperTeamUserKeyBits的配置定义 */
|
|
5
|
+
export declare enum NIMSuperTeamBitsConfigMask {
|
|
6
|
+
kNIMSuperTeamBitsConfigMaskMuteNone = 0 /** < 开启提醒 bits 0000b*/,
|
|
7
|
+
kNIMSuperTeamBitsConfigMaskMuteNotify = 1 /** < 关闭提醒 bits 0001b*/,
|
|
8
|
+
kNIMSuperTeamBitsConfigMaskOnlyAdmin = 2 /** < 只接收管理员消息 bits 0010b 超大群当前不支持该选项*/
|
|
9
|
+
}
|
|
10
|
+
/** @enum NIMSuperTeamUserType 群成员类型 */
|
|
11
|
+
export declare enum NIMSuperTeamUserType {
|
|
12
|
+
kNIMSuperTeamUserTypeNomal = 0 /** < 普通成员 */,
|
|
13
|
+
kNIMSuperTeamUserTypeCreator = 1 /** < 创建者 */,
|
|
14
|
+
kNIMSuperTeamUserTypeManager = 2 /** < 管理员 */,
|
|
15
|
+
kNIMSuperTeamUserTypeApply = 3 /** < 申请加入用户 */,
|
|
16
|
+
kNIMSuperTeamUserTypeLocalWaitAccept = 100 /** < 本地记录等待正在入群的用户 */
|
|
17
|
+
}
|
|
18
|
+
/** @enum NIMSuperTeamBeInviteMode 被邀请人同意方式 */
|
|
19
|
+
export declare enum NIMSuperTeamBeInviteMode {
|
|
20
|
+
kNIMSuperTeamBeInviteModeNeedAgree = 0 /** < 需要同意 */,
|
|
21
|
+
kNIMSuperTeamBeInviteModeNotNeedAgree = 1 /** < 不需要同意 */
|
|
22
|
+
}
|
|
23
|
+
/** @enum NIMSuperTeamInviteMode 谁可以邀请他人入群 */
|
|
24
|
+
export declare enum NIMSuperTeamInviteMode {
|
|
25
|
+
kNIMSuperTeamInviteModeManager = 0 /** < 管理员 */,
|
|
26
|
+
kNIMSuperTeamInviteModeEveryone = 1 /** < 所有人 */
|
|
27
|
+
}
|
|
28
|
+
/** @enum NIMSuperTeamUpdateInfoMode 谁可以修改群资料 */
|
|
29
|
+
export declare enum NIMSuperTeamUpdateInfoMode {
|
|
30
|
+
kNIMSuperTeamUpdateInfoModeManager = 0 /** < 管理员 */,
|
|
31
|
+
kNIMSuperTeamUpdateInfoModeEveryone = 1 /** < 所有人 */
|
|
32
|
+
}
|
|
33
|
+
/** @enum NIMSuperTeamUpdateCustomMode 谁可以更新群自定义属性 */
|
|
34
|
+
export declare enum NIMSuperTeamUpdateCustomMode {
|
|
35
|
+
kNIMSuperTeamUpdateCustomModeManager = 0 /** < 管理员 */,
|
|
36
|
+
kNIMSuperTeamUpdateCustomModeEveryone = 1 /** < 所有人 */
|
|
37
|
+
}
|
|
38
|
+
/** @enum NIMSuperTeamJoinMode 群允许加入类型 */
|
|
39
|
+
export declare enum NIMSuperTeamJoinMode {
|
|
40
|
+
kNIMSuperTeamJoinModeNoAuth = 0 /** < 不用验证 */,
|
|
41
|
+
kNIMSuperTeamJoinModeNeedAuth = 1 /** < 需要验证 */,
|
|
42
|
+
kNIMSuperTeamJoinModeRejectAll = 2 /** < 拒绝所有人入群 */
|
|
43
|
+
}
|
|
44
|
+
/** @enum NIMSuperTeamQueryType 根据关键字查询群组信息类型 */
|
|
45
|
+
export declare enum NIMSuperTeamQueryType {
|
|
46
|
+
kNIMQuerySuperTeamDefault = 1 /** 默认查询条件,群组 ID 和群名称任意匹配则返回 */,
|
|
47
|
+
kNIMQuerySuperTeamByTeamId = 2 /** 仅匹配群组 ID */,
|
|
48
|
+
kNIMQuerySuperTeamByTeamName = 3 /** 仅匹配群名称 */
|
|
49
|
+
}
|
|
50
|
+
/** @enum NIMSuperTeamMuteType 群信息kNIMSuperTeamInfoKeyMuteType的配置定义 */
|
|
51
|
+
export declare enum NIMSuperTeamMuteType {
|
|
52
|
+
kNIMSuperTeamMuteTypeNone = 0 /**< 不禁言 */,
|
|
53
|
+
kNIMSuperTeamMuteTypeNomalMute = 1 /**< 普通成员禁言 */,
|
|
54
|
+
kNIMSuperTeamMuteTypeAllMute = 3 /**< 全部禁言 */
|
|
55
|
+
}
|
|
56
|
+
export interface SuperTeamEvent {
|
|
57
|
+
res_code_?: NIMResCode; /**< 错误码 */
|
|
58
|
+
notification_id_?: NIMNotificationId; /**< 通知类型ID */
|
|
59
|
+
team_id_?: string; /**< 群组ID */
|
|
60
|
+
ids_?: Array<string>; /**< 通知可能涉及到的群成员ID */
|
|
61
|
+
invalid_ids_?: Array<string>; /**< 通知可能涉及到的失效的群成员ID,比如邀请入群的成员的群数量超限导致当次邀请失败 */
|
|
62
|
+
namecards_?: Array<UserNameCard>; /**< 通知可能涉及到的群成员的用户名片 */
|
|
63
|
+
team_info_?: SuperTeamInfo; /**< 通知可能涉及到的群信息 */
|
|
64
|
+
member_property_?: SuperTeamMemberProperty; /**< 群成员属性 */
|
|
65
|
+
opt_?: boolean; /**< 操作 */
|
|
66
|
+
attach_?: string; /**< 扩展字段,目前仅kick和invite事件可选 */
|
|
67
|
+
src_data_?: string; /**< 未解析过的原信息,目前仅支持群消息未读数相关事件 */
|
|
68
|
+
}
|
|
69
|
+
export interface SuperTeamInfoJsonValue {
|
|
70
|
+
tid?: string;
|
|
71
|
+
name?: string;
|
|
72
|
+
readonly creator: string;
|
|
73
|
+
member_max_count?: number;
|
|
74
|
+
prop?: string;
|
|
75
|
+
readonly valid: boolean;
|
|
76
|
+
readonly member_count: number;
|
|
77
|
+
readonly list_timetag: number;
|
|
78
|
+
readonly create_timetag: number;
|
|
79
|
+
readonly update_timetag: number;
|
|
80
|
+
member_valid?: number; /**< 1:有效,0:无效 */
|
|
81
|
+
intro?: string;
|
|
82
|
+
announcement?: string;
|
|
83
|
+
join_mode?: NIMSuperTeamJoinMode;
|
|
84
|
+
custom?: string;
|
|
85
|
+
icon?: string;
|
|
86
|
+
be_invite_mode?: NIMSuperTeamBeInviteMode;
|
|
87
|
+
invite_mode?: NIMSuperTeamInviteMode;
|
|
88
|
+
update_info_mode?: NIMSuperTeamUpdateInfoMode;
|
|
89
|
+
update_custom_mode?: NIMSuperTeamUpdateCustomMode;
|
|
90
|
+
mute_type?: NIMSuperTeamMuteType;
|
|
91
|
+
}
|
|
92
|
+
export interface SuperTeamInfo {
|
|
93
|
+
team_info_json_value_?: SuperTeamInfoJsonValue;
|
|
94
|
+
}
|
|
95
|
+
export interface SuperTeamMemberPropertyJsonValue {
|
|
96
|
+
tid?: string;
|
|
97
|
+
accid?: string;
|
|
98
|
+
type?: NIMSuperTeamUserType;
|
|
99
|
+
nick?: string;
|
|
100
|
+
bits?: number;
|
|
101
|
+
custom?: string;
|
|
102
|
+
readonly valid?: boolean;
|
|
103
|
+
readonly create_timetag?: number;
|
|
104
|
+
readonly update_timetag?: number;
|
|
105
|
+
readonly mute?: number;
|
|
106
|
+
}
|
|
107
|
+
export interface SuperTeamMemberProperty {
|
|
108
|
+
member_info_json_value_?: SuperTeamMemberPropertyJsonValue;
|
|
109
|
+
}
|
|
110
|
+
export type SuperTeamEventCallback = (result: SuperTeamEvent) => void;
|
|
111
|
+
export type QueryAllMySuperTeamsCallback = (count: number, result: Array<string>) => void;
|
|
112
|
+
export type QueryAllMySuperTeamsInfoCallback = (count: number, result: Array<SuperTeamInfo>) => void;
|
|
113
|
+
export type QuerySuperTeamMyAllMemberInfosCallback = (count: number, result: Array<SuperTeamMemberProperty>) => void;
|
|
114
|
+
export type QuerySuperTeamMembersCallback = (rescode: NIMResCode, tid: string, count: number, result: Array<SuperTeamMemberProperty>) => void;
|
|
115
|
+
export type QuerySuperTeamMemberCallback = (result: SuperTeamMemberProperty) => void;
|
|
116
|
+
export type QuerySuperTeamInfoCallback = (tid: string, result: SuperTeamInfo) => void;
|
|
117
|
+
export type QuerySuperTeamMembersOnlineCallback = (rescode: NIMResCode, count: number, result: Array<SuperTeamMemberProperty>) => void;
|
|
118
|
+
export interface NIMSuperTeamAPI {
|
|
119
|
+
InitEventHandlers(): void;
|
|
120
|
+
InviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
121
|
+
KickAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
122
|
+
LeaveAsync(tid: string, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
123
|
+
UpdateSuperTeamInfoAsync(tid: string, info: SuperTeamInfo, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
124
|
+
ApplyJoinAsync(tid: string, reason: string, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
125
|
+
PassJoinApplyAsync(tid: string, applicantId: string, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
126
|
+
RejectJoinApplyAsync(tid: string, applicantId: string, reason: string, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
127
|
+
AddManagersAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
128
|
+
RemoveManagersAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
129
|
+
TransferTeamAsync(tid: string, newOwnerId: string, isLeave: boolean, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
130
|
+
UpdateMyPropertyAsync(prop: SuperTeamMemberProperty, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
131
|
+
UpdateOtherNickAsync(prop: SuperTeamMemberProperty, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
132
|
+
AcceptInvitationAsync(tid: string, inviterId: string, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
133
|
+
RejectInvitationAsync(tid: string, inviterId: string, reason: string, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
134
|
+
QueryAllMySuperTeamsAsync(cb: QueryAllMySuperTeamsCallback | null, jsonExtension: string): void;
|
|
135
|
+
QueryAllMySuperTeamsInfoAsync(cb: QueryAllMySuperTeamsInfoCallback | null, jsonExtension: string): void;
|
|
136
|
+
QueryMyAllMemberInfosAsync(cb: QuerySuperTeamMyAllMemberInfosCallback | null, jsonExtension: string): void;
|
|
137
|
+
QuerySuperTeamMembersAsync(tid: string, cb: QuerySuperTeamMembersCallback | null, jsonExtension: string): boolean;
|
|
138
|
+
QuerySuperTeamMemberAsync(tid: string, id: string, cb: QuerySuperTeamMemberCallback | null, jsonExtension: string): void;
|
|
139
|
+
QuerySuperTeamInfoAsync(tid: string, cb: QuerySuperTeamInfoCallback | null, jsonExtension: string): boolean;
|
|
140
|
+
QuerySuperTeamInfoOnlineAsync(tid: string, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
141
|
+
MuteMemberAsync(tid: string, member_id: string, set_mute: boolean, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
142
|
+
MuteAsync(tid: string, set_mute: boolean, cb: SuperTeamEventCallback | null, jsonExtension: string): boolean;
|
|
143
|
+
QuerySuperTeamsInfoByKeywordAsync(keyword: string, cb: QueryAllMySuperTeamsInfoCallback | null, jsonExtension: string): void;
|
|
144
|
+
}
|
|
@@ -1,70 +1,70 @@
|
|
|
1
|
-
import { NIMResCode } from './client_def';
|
|
2
|
-
import { BoolStatus, NIMMessageFeature } from './msglog_def';
|
|
3
|
-
import { SendMessageArc } from './talk_def';
|
|
4
|
-
/** @enum NIMSysMsgStatus 系统消息状态 */
|
|
5
|
-
export declare enum NIMSysMsgStatus {
|
|
6
|
-
kNIMSysMsgStatusNone = 0 /** < 默认,未读 */,
|
|
7
|
-
kNIMSysMsgStatusPass = 1 /** < 收到消息,通过 */,
|
|
8
|
-
kNIMSysMsgStatusDecline = 2 /** < 收到消息,拒绝 */,
|
|
9
|
-
kNIMSysMsgStatusRead = 3 /** < 收到消息,已读 */,
|
|
10
|
-
kNIMSysMsgStatusDeleted = 4 /** < 已删 */,
|
|
11
|
-
kNIMSysMsgStatusInvalid = 5 /** < 已失效 */
|
|
12
|
-
}
|
|
13
|
-
/** @enum NIMSysMsgType 系统消息内容类型 */
|
|
14
|
-
export declare enum NIMSysMsgType {
|
|
15
|
-
kNIMSysMsgTypeTeamApply = 0 /** < 申请入群 */,
|
|
16
|
-
kNIMSysMsgTypeTeamReject = 1 /** < 拒绝入群申请 */,
|
|
17
|
-
kNIMSysMsgTypeTeamInvite = 2 /** < 邀请进群 kNIMSysMsgKeyAttach : {"team_info":team_info, "attach" : ""}
|
|
18
|
-
attach为可选字段,作为应用自定义扩展字段,解析前需要判断有没有这个字段*/,
|
|
19
|
-
kNIMSysMsgTypeTeamInviteReject = 3 /** < 拒绝邀请 */,
|
|
20
|
-
kNIMSysMsgTypeFriendAdd = 5 /** < 加好友, kNIMSysMsgKeyAttach: {"vt":verify_type} */,
|
|
21
|
-
kNIMSysMsgTypeFriendDel = 6 /** < 删除好友 */,
|
|
22
|
-
kNIMSysMsgTypeCustomP2PMsg = 100 /** < 点对点透传消息(透传消息的内容放到kNIMSysMsgKeyAttach),SDK对该类消息不计入未读数, 即使kNIMSysMsgKeyPushNeedBadge为1 */,
|
|
23
|
-
kNIMSysMsgTypeCustomTeamMsg = 101 /** < 群透传消息(透传消息的内容放到kNIMSysMsgKeyAttach),SDK对该类消息不计入未读数, 即使kNIMSysMsgKeyPushNeedBadge为1 */,
|
|
24
|
-
kNIMSysMsgTypeCustomSuperTeamMsg = 103 /** < 超大群透传消息(透传消息的内容放到kNIMSysMsgKeyAttach),SDK对该类消息不计入未读数, 即使kNIMSysMsgKeyPushNeedBadge为1 */,
|
|
25
|
-
kNIMSysMsgTypeUnknown = 1000 /** < 未知类型,本地使用,发送时勿使用,作为默认 */
|
|
26
|
-
}
|
|
27
|
-
export interface SysMessage {
|
|
28
|
-
timetag_?: number; /**< 通知时间戳(毫秒) */
|
|
29
|
-
type_?: NIMSysMsgType; /**< 通知类型 */
|
|
30
|
-
receiver_accid_?: string; /**< 接收者ID */
|
|
31
|
-
sender_accid_?: string; /**< 发送者ID */
|
|
32
|
-
content_?: string; /**< 只读,SDK不转发该字段 */
|
|
33
|
-
attach_?: string; /**< 通知附件 */
|
|
34
|
-
id_?: string; /**< 通知ID */
|
|
35
|
-
status_?: NIMSysMsgStatus; /**< 通知状态 */
|
|
36
|
-
msg_setting_?: SysMessageSetting; /**< 消息属性设置 */
|
|
37
|
-
rescode_?: NIMResCode; /**< 通知错误码 */
|
|
38
|
-
feature_?: NIMMessageFeature; /**< 通知属性 */
|
|
39
|
-
total_unread_count_?: number; /**< 总计的通知未读数 */
|
|
40
|
-
client_msg_id_?: string; /**< 通知ID(客户端) */
|
|
41
|
-
callbac_ext_?: string; /**< v8.2.0 第三方回调返回的自定义字段 */
|
|
42
|
-
}
|
|
43
|
-
export interface SysMessageSetting {
|
|
44
|
-
need_push_?: BoolStatus; /**< 是否需要推送 */
|
|
45
|
-
push_need_badge_?: BoolStatus; /**< 是否要做消息计数 */
|
|
46
|
-
push_need_prefix_?: BoolStatus; /**< 需要推送昵称 */
|
|
47
|
-
need_offline_?: BoolStatus; /**< 是否支持离线消息 */
|
|
48
|
-
push_payload_?: object; /**< 第三方自定义的推送属性,长度2048 */
|
|
49
|
-
push_content_?: string; /**< 自定义推送文案,长度限制200字节 */
|
|
50
|
-
anti_spam_enable_?: BoolStatus; /**< (功能暂时不开放)是否需要过易盾反垃圾 */
|
|
51
|
-
anti_spam_content_?: string; /**< (功能暂时不开放)(可选)开发者自定义的反垃圾字段 */
|
|
52
|
-
env_config_?: string; /**< (可选) 指向自定义抄送的配置 */
|
|
53
|
-
}
|
|
54
|
-
export type SysmsgCallback = (result: SysMessage) => void;
|
|
55
|
-
export type SendCustomSysmsgCallback = (result: SendMessageArc) => void;
|
|
56
|
-
export type NotifySingleSysmsgCallback = (res_code: NIMResCode, msg_id: number, unread_count: number) => void;
|
|
57
|
-
export type NotifySysmsgResCallback = (res_code: NIMResCode, unread_count: number) => void;
|
|
58
|
-
export type QuerySysmsgCallback = (count: number, unread_count: number, result: Array<SysMessage>) => void;
|
|
59
|
-
export interface NIMSysMsgAPI {
|
|
60
|
-
InitEventHandlers(): void;
|
|
61
|
-
SendCustomNotificationMsg(msg: SysMessage): void;
|
|
62
|
-
QueryMsgAsync(limit_count: number, last_time: number, cb: QuerySysmsgCallback | null, jsonExtension: string): boolean;
|
|
63
|
-
QueryUnreadCount(cb: NotifySysmsgResCallback | null, jsonExtension: string): void;
|
|
64
|
-
SetStatusAsync(msg_id: string, status: NIMSysMsgStatus, cb: NotifySingleSysmsgCallback | null, jsonExtension: string): boolean;
|
|
65
|
-
ReadAllAsync(cb: NotifySysmsgResCallback | null, jsonExtension: string): void;
|
|
66
|
-
DeleteAsync(msg_id: string, cb: NotifySingleSysmsgCallback | null, jsonExtension: string): boolean;
|
|
67
|
-
DeleteAllAsync(cb: NotifySysmsgResCallback | null, jsonExtension: string): boolean;
|
|
68
|
-
SetStatusByTypeAsync(type: NIMSysMsgType, status: NIMSysMsgStatus, cb: NotifySysmsgResCallback | null, jsonExtension: string): boolean;
|
|
69
|
-
DeleteByTypeAsync(type: NIMSysMsgType, cb: NotifySysmsgResCallback | null, jsonExtension: string): boolean;
|
|
70
|
-
}
|
|
1
|
+
import { NIMResCode } from './client_def';
|
|
2
|
+
import { BoolStatus, NIMMessageFeature } from './msglog_def';
|
|
3
|
+
import { SendMessageArc } from './talk_def';
|
|
4
|
+
/** @enum NIMSysMsgStatus 系统消息状态 */
|
|
5
|
+
export declare enum NIMSysMsgStatus {
|
|
6
|
+
kNIMSysMsgStatusNone = 0 /** < 默认,未读 */,
|
|
7
|
+
kNIMSysMsgStatusPass = 1 /** < 收到消息,通过 */,
|
|
8
|
+
kNIMSysMsgStatusDecline = 2 /** < 收到消息,拒绝 */,
|
|
9
|
+
kNIMSysMsgStatusRead = 3 /** < 收到消息,已读 */,
|
|
10
|
+
kNIMSysMsgStatusDeleted = 4 /** < 已删 */,
|
|
11
|
+
kNIMSysMsgStatusInvalid = 5 /** < 已失效 */
|
|
12
|
+
}
|
|
13
|
+
/** @enum NIMSysMsgType 系统消息内容类型 */
|
|
14
|
+
export declare enum NIMSysMsgType {
|
|
15
|
+
kNIMSysMsgTypeTeamApply = 0 /** < 申请入群 */,
|
|
16
|
+
kNIMSysMsgTypeTeamReject = 1 /** < 拒绝入群申请 */,
|
|
17
|
+
kNIMSysMsgTypeTeamInvite = 2 /** < 邀请进群 kNIMSysMsgKeyAttach : {"team_info":team_info, "attach" : ""}
|
|
18
|
+
attach为可选字段,作为应用自定义扩展字段,解析前需要判断有没有这个字段*/,
|
|
19
|
+
kNIMSysMsgTypeTeamInviteReject = 3 /** < 拒绝邀请 */,
|
|
20
|
+
kNIMSysMsgTypeFriendAdd = 5 /** < 加好友, kNIMSysMsgKeyAttach: {"vt":verify_type} */,
|
|
21
|
+
kNIMSysMsgTypeFriendDel = 6 /** < 删除好友 */,
|
|
22
|
+
kNIMSysMsgTypeCustomP2PMsg = 100 /** < 点对点透传消息(透传消息的内容放到kNIMSysMsgKeyAttach),SDK对该类消息不计入未读数, 即使kNIMSysMsgKeyPushNeedBadge为1 */,
|
|
23
|
+
kNIMSysMsgTypeCustomTeamMsg = 101 /** < 群透传消息(透传消息的内容放到kNIMSysMsgKeyAttach),SDK对该类消息不计入未读数, 即使kNIMSysMsgKeyPushNeedBadge为1 */,
|
|
24
|
+
kNIMSysMsgTypeCustomSuperTeamMsg = 103 /** < 超大群透传消息(透传消息的内容放到kNIMSysMsgKeyAttach),SDK对该类消息不计入未读数, 即使kNIMSysMsgKeyPushNeedBadge为1 */,
|
|
25
|
+
kNIMSysMsgTypeUnknown = 1000 /** < 未知类型,本地使用,发送时勿使用,作为默认 */
|
|
26
|
+
}
|
|
27
|
+
export interface SysMessage {
|
|
28
|
+
timetag_?: number; /**< 通知时间戳(毫秒) */
|
|
29
|
+
type_?: NIMSysMsgType; /**< 通知类型 */
|
|
30
|
+
receiver_accid_?: string; /**< 接收者ID */
|
|
31
|
+
sender_accid_?: string; /**< 发送者ID */
|
|
32
|
+
content_?: string; /**< 只读,SDK不转发该字段 */
|
|
33
|
+
attach_?: string; /**< 通知附件 */
|
|
34
|
+
id_?: string; /**< 通知ID */
|
|
35
|
+
status_?: NIMSysMsgStatus; /**< 通知状态 */
|
|
36
|
+
msg_setting_?: SysMessageSetting; /**< 消息属性设置 */
|
|
37
|
+
rescode_?: NIMResCode; /**< 通知错误码 */
|
|
38
|
+
feature_?: NIMMessageFeature; /**< 通知属性 */
|
|
39
|
+
total_unread_count_?: number; /**< 总计的通知未读数 */
|
|
40
|
+
client_msg_id_?: string; /**< 通知ID(客户端) */
|
|
41
|
+
callbac_ext_?: string; /**< v8.2.0 第三方回调返回的自定义字段 */
|
|
42
|
+
}
|
|
43
|
+
export interface SysMessageSetting {
|
|
44
|
+
need_push_?: BoolStatus; /**< 是否需要推送 */
|
|
45
|
+
push_need_badge_?: BoolStatus; /**< 是否要做消息计数 */
|
|
46
|
+
push_need_prefix_?: BoolStatus; /**< 需要推送昵称 */
|
|
47
|
+
need_offline_?: BoolStatus; /**< 是否支持离线消息 */
|
|
48
|
+
push_payload_?: object; /**< 第三方自定义的推送属性,长度2048 */
|
|
49
|
+
push_content_?: string; /**< 自定义推送文案,长度限制200字节 */
|
|
50
|
+
anti_spam_enable_?: BoolStatus; /**< (功能暂时不开放)是否需要过易盾反垃圾 */
|
|
51
|
+
anti_spam_content_?: string; /**< (功能暂时不开放)(可选)开发者自定义的反垃圾字段 */
|
|
52
|
+
env_config_?: string; /**< (可选) 指向自定义抄送的配置 */
|
|
53
|
+
}
|
|
54
|
+
export type SysmsgCallback = (result: SysMessage) => void;
|
|
55
|
+
export type SendCustomSysmsgCallback = (result: SendMessageArc) => void;
|
|
56
|
+
export type NotifySingleSysmsgCallback = (res_code: NIMResCode, msg_id: number, unread_count: number) => void;
|
|
57
|
+
export type NotifySysmsgResCallback = (res_code: NIMResCode, unread_count: number) => void;
|
|
58
|
+
export type QuerySysmsgCallback = (count: number, unread_count: number, result: Array<SysMessage>) => void;
|
|
59
|
+
export interface NIMSysMsgAPI {
|
|
60
|
+
InitEventHandlers(): void;
|
|
61
|
+
SendCustomNotificationMsg(msg: SysMessage): void;
|
|
62
|
+
QueryMsgAsync(limit_count: number, last_time: number, cb: QuerySysmsgCallback | null, jsonExtension: string): boolean;
|
|
63
|
+
QueryUnreadCount(cb: NotifySysmsgResCallback | null, jsonExtension: string): void;
|
|
64
|
+
SetStatusAsync(msg_id: string, status: NIMSysMsgStatus, cb: NotifySingleSysmsgCallback | null, jsonExtension: string): boolean;
|
|
65
|
+
ReadAllAsync(cb: NotifySysmsgResCallback | null, jsonExtension: string): void;
|
|
66
|
+
DeleteAsync(msg_id: string, cb: NotifySingleSysmsgCallback | null, jsonExtension: string): boolean;
|
|
67
|
+
DeleteAllAsync(cb: NotifySysmsgResCallback | null, jsonExtension: string): boolean;
|
|
68
|
+
SetStatusByTypeAsync(type: NIMSysMsgType, status: NIMSysMsgStatus, cb: NotifySysmsgResCallback | null, jsonExtension: string): boolean;
|
|
69
|
+
DeleteByTypeAsync(type: NIMSysMsgType, cb: NotifySysmsgResCallback | null, jsonExtension: string): boolean;
|
|
70
|
+
}
|