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,643 +1,643 @@
|
|
|
1
|
-
import { NIMQChatChannelType, NIMQChatChannelViewMode, NIMQChatChannelSyncMode, NIMQChatChannelIDInfo, NIMQChatSubscribeType, NIMQChatSubscribeOpeType, NIMQChatChannelWhiteBlackType, NIMQChatChannelWhiteBlackOpeType, NIMQChatSearchOrder, NIMQChatChannelSearchSort, QChatBaseResp, QChatBusinessAntiSpamInfo, QChatPageInfo, QChatMemberInfo, QChatServerRoleInfo, NIMQChatUnreadInfo, NIMResCode, NIMQChatChannelVisitorMode } from './public_def';
|
|
2
|
-
import { QChatServerGetMembersPageResp, QChatServerGetMembersResp, ServerGetMembersCallback } from './server_def';
|
|
3
|
-
export interface QChatChannelInfo {
|
|
4
|
-
/** server id */
|
|
5
|
-
server_id?: string;
|
|
6
|
-
/** channel id */
|
|
7
|
-
channel_id?: string;
|
|
8
|
-
/** 名称 */
|
|
9
|
-
name?: string;
|
|
10
|
-
/** 主题 */
|
|
11
|
-
topic?: string;
|
|
12
|
-
/** 自定义字段 */
|
|
13
|
-
custom?: string;
|
|
14
|
-
/** 频道类型,0:消息频道 */
|
|
15
|
-
type?: NIMQChatChannelType;
|
|
16
|
-
/** 拥有者 */
|
|
17
|
-
owner?: string;
|
|
18
|
-
/** 查看模式,只有在category_id为0或sync_mode为kNIMQChatChannelSyncModeNoSync时有效 */
|
|
19
|
-
view_mode?: NIMQChatChannelViewMode;
|
|
20
|
-
/** 圈组频道游客访问模式 */
|
|
21
|
-
visitor_mode?: NIMQChatChannelVisitorMode;
|
|
22
|
-
/** 有效标记,false:无效 true:有效 */
|
|
23
|
-
valid_flag?: boolean;
|
|
24
|
-
/** 创建时间 */
|
|
25
|
-
create_time?: number;
|
|
26
|
-
/** 更新时间 */
|
|
27
|
-
update_time?: number;
|
|
28
|
-
/** 频道分组ID */
|
|
29
|
-
category_id?: string;
|
|
30
|
-
/** 频道分组同步模式 */
|
|
31
|
-
sync_mode?: NIMQChatChannelSyncMode;
|
|
32
|
-
/** 自定义排序权重值 */
|
|
33
|
-
reorder_weight?: number;
|
|
34
|
-
}
|
|
35
|
-
export interface QChatChannelRTCAudioInfo {
|
|
36
|
-
/** 音频属性 ["HIGH_QUALITY_STEREO","HIGH_QUALITY","STANDARD_EXTEND"] */
|
|
37
|
-
profile?: string;
|
|
38
|
-
/** 音频应用场景 ["DEFAULT","SPEECH","MUSIC", "CHATROOM"] */
|
|
39
|
-
scenario?: string;
|
|
40
|
-
}
|
|
41
|
-
export interface QChatChannelRTCVideoInfo {
|
|
42
|
-
/** 分辨率宽 */
|
|
43
|
-
width?: number;
|
|
44
|
-
/** 分辨率高 */
|
|
45
|
-
height?: number;
|
|
46
|
-
/** 帧率 */
|
|
47
|
-
fps?: number;
|
|
48
|
-
}
|
|
49
|
-
export interface QChatChannelRTCInfo {
|
|
50
|
-
/** 在线人数限制 */
|
|
51
|
-
limit?: number;
|
|
52
|
-
/** 音频配置 */
|
|
53
|
-
audio?: QChatChannelRTCAudioInfo;
|
|
54
|
-
/** 视频配置 */
|
|
55
|
-
video?: QChatChannelRTCVideoInfo;
|
|
56
|
-
}
|
|
57
|
-
export interface QChatChannelCategoryInfo {
|
|
58
|
-
/** server id */
|
|
59
|
-
server_id?: string;
|
|
60
|
-
/** category id */
|
|
61
|
-
category_id?: string;
|
|
62
|
-
/** 名称 */
|
|
63
|
-
name?: string;
|
|
64
|
-
/** 自定义字段 */
|
|
65
|
-
custom?: string;
|
|
66
|
-
/** 拥有者 */
|
|
67
|
-
owner?: string;
|
|
68
|
-
/** 查看模式 */
|
|
69
|
-
view_mode?: NIMQChatChannelViewMode;
|
|
70
|
-
/** 有效标记,false:无效 true:有效 */
|
|
71
|
-
valid_flag?: boolean;
|
|
72
|
-
/** 创建时间 */
|
|
73
|
-
create_time?: number;
|
|
74
|
-
/** 更新时间 */
|
|
75
|
-
update_time?: number;
|
|
76
|
-
/** 频道数量 */
|
|
77
|
-
channel_number?: number;
|
|
78
|
-
}
|
|
79
|
-
export interface QChatChannelSubscribeResp {
|
|
80
|
-
/** 操作结果, 参考NIMResCode */
|
|
81
|
-
res_code?: NIMResCode;
|
|
82
|
-
/** 失败列表 */
|
|
83
|
-
failed_channels?: Array<NIMQChatChannelIDInfo>;
|
|
84
|
-
}
|
|
85
|
-
export interface QChatChannelSubscribeAsVisitorResp {
|
|
86
|
-
/** 操作结果, 参考NIMResCode */
|
|
87
|
-
res_code?: NIMResCode;
|
|
88
|
-
/** 失败列表 */
|
|
89
|
-
failed_channels?: Array<NIMQChatChannelIDInfo>;
|
|
90
|
-
}
|
|
91
|
-
export interface QChatChannelQueryUnreadInfoResp {
|
|
92
|
-
/** 操作结果, 参考NIMResCode */
|
|
93
|
-
res_code?: NIMResCode;
|
|
94
|
-
/** 未读信息列表 */
|
|
95
|
-
unread_infos?: Array<NIMQChatUnreadInfo>;
|
|
96
|
-
}
|
|
97
|
-
export interface QChatChannelCreateResp {
|
|
98
|
-
/** 操作结果, 参考NIMResCode */
|
|
99
|
-
res_code?: NIMResCode;
|
|
100
|
-
/** 频道信息 */
|
|
101
|
-
channel_info?: QChatChannelInfo;
|
|
102
|
-
}
|
|
103
|
-
export type QChatChannelDeleteResp = QChatBaseResp;
|
|
104
|
-
export type QChatChannelUpdateResp = QChatChannelCreateResp;
|
|
105
|
-
export type QChatChannelUpdateCategoryInfoResp = QChatChannelCreateResp;
|
|
106
|
-
export interface QChatChannelGetChannelsResp {
|
|
107
|
-
/** 操作结果, 参考NIMResCode */
|
|
108
|
-
res_code?: NIMResCode;
|
|
109
|
-
/** 频道列表 */
|
|
110
|
-
channel_list?: Array<QChatChannelInfo>;
|
|
111
|
-
}
|
|
112
|
-
export interface QChatChannelGetChannelsPageResp {
|
|
113
|
-
/** 操作结果, 参考NIMResCode */
|
|
114
|
-
res_code?: NIMResCode;
|
|
115
|
-
/** 分页信息 */
|
|
116
|
-
page_info?: QChatPageInfo;
|
|
117
|
-
/** 频道列表 */
|
|
118
|
-
channel_list?: Array<QChatChannelInfo>;
|
|
119
|
-
}
|
|
120
|
-
export interface QChatChannelUnreadResp {
|
|
121
|
-
/** 未读数信息 */
|
|
122
|
-
unread_infos?: Array<NIMQChatUnreadInfo>;
|
|
123
|
-
}
|
|
124
|
-
export type QChatChannelUpdateWhiteBlackRoleResp = QChatBaseResp;
|
|
125
|
-
export type QChatChannelUpdateWhiteBlackMembersResp = QChatBaseResp;
|
|
126
|
-
export interface QChatChannelGetWhiteBlackRolesPageResp {
|
|
127
|
-
/** 操作结果, 参考NIMResCode */
|
|
128
|
-
res_code?: NIMResCode;
|
|
129
|
-
/** 分页信息 */
|
|
130
|
-
page_info?: QChatPageInfo;
|
|
131
|
-
/** 身份组列表 */
|
|
132
|
-
roles?: Array<QChatServerRoleInfo>;
|
|
133
|
-
}
|
|
134
|
-
export interface QChatChannelGetWhiteBlackMembersPageResp {
|
|
135
|
-
/** 操作结果, 参考NIMResCode */
|
|
136
|
-
res_code?: NIMResCode;
|
|
137
|
-
/** 分页信息 */
|
|
138
|
-
page_info?: QChatPageInfo;
|
|
139
|
-
/** 身份组列表 */
|
|
140
|
-
members?: Array<QChatMemberInfo>;
|
|
141
|
-
}
|
|
142
|
-
export interface QChatChannelGetExistingWhiteBlackRolesResp {
|
|
143
|
-
/** 操作结果, 参考NIMResCode */
|
|
144
|
-
res_code?: NIMResCode;
|
|
145
|
-
/** 身份组列表 */
|
|
146
|
-
roles?: Array<QChatServerRoleInfo>;
|
|
147
|
-
}
|
|
148
|
-
export interface QChatChannelGetExistingWhiteBlackMembersResp {
|
|
149
|
-
/** 操作结果, 参考NIMResCode */
|
|
150
|
-
res_code?: NIMResCode;
|
|
151
|
-
/** 身份组列表,结果中不包含成员有效属性 vaild_flag */
|
|
152
|
-
members?: Array<QChatMemberInfo>;
|
|
153
|
-
}
|
|
154
|
-
export type QChatChannelGetMembersPageResp = QChatServerGetMembersPageResp;
|
|
155
|
-
export type QChatChannelSearchPageResp = QChatChannelGetChannelsPageResp;
|
|
156
|
-
export type QChatChannelMemberSearchResp = QChatServerGetMembersResp;
|
|
157
|
-
export interface QChatChannelCategoryCreateResp {
|
|
158
|
-
/** 操作结果, 参考NIMResCode */
|
|
159
|
-
res_code?: NIMResCode;
|
|
160
|
-
/** 分类信息 */
|
|
161
|
-
category_info?: QChatChannelCategoryInfo;
|
|
162
|
-
}
|
|
163
|
-
export type QChatChannelCategoryRemoveResp = QChatBaseResp;
|
|
164
|
-
export type QChatChannelCategoryUpdateResp = QChatChannelCategoryCreateResp;
|
|
165
|
-
export interface QChatChannelGetCategoriesByIDResp {
|
|
166
|
-
/** 操作结果, 参考NIMResCode */
|
|
167
|
-
res_code?: NIMResCode;
|
|
168
|
-
/** 频道分组信息列表 */
|
|
169
|
-
categories?: Array<QChatChannelCategoryInfo>;
|
|
170
|
-
}
|
|
171
|
-
export interface QChatChannelGetCategoriesPageResp {
|
|
172
|
-
/** 操作结果, 参考NIMResCode */
|
|
173
|
-
res_code?: NIMResCode;
|
|
174
|
-
/** 分页信息 */
|
|
175
|
-
page_info?: QChatPageInfo;
|
|
176
|
-
/** 分类信息 */
|
|
177
|
-
categories?: Array<QChatChannelCategoryInfo>;
|
|
178
|
-
}
|
|
179
|
-
export type QChatChannelGetCategoryChannelsPageResp = QChatChannelGetChannelsPageResp;
|
|
180
|
-
export type QChatChannelCategoryUpdateWhiteBlackRoleResp = QChatBaseResp;
|
|
181
|
-
export interface QChatChannelCategoryGetWhiteBlackRolesPageResp {
|
|
182
|
-
/** 操作结果, 参考NIMResCode */
|
|
183
|
-
res_code?: NIMResCode;
|
|
184
|
-
/** 分页信息 */
|
|
185
|
-
page_info?: QChatPageInfo;
|
|
186
|
-
/** 身份组列表 */
|
|
187
|
-
roles?: Array<QChatServerRoleInfo>;
|
|
188
|
-
}
|
|
189
|
-
export interface QChatChannelCategoryGetExistingWhiteBlackRolesResp {
|
|
190
|
-
/** 操作结果, 参考NIMResCode */
|
|
191
|
-
res_code?: NIMResCode;
|
|
192
|
-
/** 身份组列表 */
|
|
193
|
-
roles?: Array<QChatServerRoleInfo>;
|
|
194
|
-
}
|
|
195
|
-
export type QChatChannelCategoryUpdateWhiteBlackMembersResp = QChatBaseResp;
|
|
196
|
-
export interface QChatChannelCategoryGetWhiteBlackMembersPageResp {
|
|
197
|
-
/** 操作结果, 参考NIMResCode */
|
|
198
|
-
res_code?: NIMResCode;
|
|
199
|
-
/** 分页信息 */
|
|
200
|
-
page_info?: QChatPageInfo;
|
|
201
|
-
/** 成员列表 */
|
|
202
|
-
members?: Array<QChatMemberInfo>;
|
|
203
|
-
}
|
|
204
|
-
export interface QChatChannelCategoryGetExistingWhiteBlackMembersResp {
|
|
205
|
-
/** 操作结果, 参考NIMResCode */
|
|
206
|
-
res_code?: NIMResCode;
|
|
207
|
-
/** 成员列表 */
|
|
208
|
-
members?: Array<QChatMemberInfo>;
|
|
209
|
-
}
|
|
210
|
-
export type QChatChannelUpdateRTCInfoResp = QChatBaseResp;
|
|
211
|
-
export interface QChatChannelGetRTCInfoResp {
|
|
212
|
-
/** 操作结果, 参考NIMResCode */
|
|
213
|
-
res_code?: NIMResCode;
|
|
214
|
-
/** RTC信息 */
|
|
215
|
-
rtc_info?: QChatChannelRTCInfo;
|
|
216
|
-
}
|
|
217
|
-
export interface QChatChannelGetRTCOnlineMembersResp {
|
|
218
|
-
/** 操作结果, 参考NIMResCode */
|
|
219
|
-
res_code?: NIMResCode;
|
|
220
|
-
/** 成员列表 */
|
|
221
|
-
members?: Array<QChatMemberInfo>;
|
|
222
|
-
}
|
|
223
|
-
/** 未读信息回调 */
|
|
224
|
-
export type ChannelUnreadCallback = (resp: QChatChannelUnreadResp) => void;
|
|
225
|
-
/** 创建频道回调 */
|
|
226
|
-
export type ChannelCreateCallback = (resp: QChatChannelCreateResp) => void;
|
|
227
|
-
/** 删除频道回调 */
|
|
228
|
-
export type ChannelDeleteCallback = (resp: QChatChannelDeleteResp) => void;
|
|
229
|
-
/** 更新频道回调 */
|
|
230
|
-
export type ChannelUpdateCallback = (resp: QChatChannelUpdateResp) => void;
|
|
231
|
-
/** 更新频道的分组信息回调 */
|
|
232
|
-
export type ChannelUpdateCategoryInfoCallback = (resp: QChatChannelUpdateCategoryInfoResp) => void;
|
|
233
|
-
/** 查询频道列表回调 */
|
|
234
|
-
export type GetChannelsCallback = (resp: QChatChannelGetChannelsResp) => void;
|
|
235
|
-
/** 分页查询频道列表回调 */
|
|
236
|
-
export type GetChannelsPageCallback = (resp: QChatChannelGetChannelsPageResp) => void;
|
|
237
|
-
/** 分页查询成员列表回调 */
|
|
238
|
-
export type ChannelGetMembersPageCallback = (resp: QChatChannelGetMembersPageResp) => void;
|
|
239
|
-
/** 查询未读消息数回调 */
|
|
240
|
-
export type ChannelQueryUnreadInfoCallback = (resp: QChatChannelQueryUnreadInfoResp) => void;
|
|
241
|
-
/** 订阅回调 */
|
|
242
|
-
export type ChannelSubscribeCallback = (resp: QChatChannelSubscribeResp) => void;
|
|
243
|
-
/** 订阅回调 */
|
|
244
|
-
export type ChannelSubscribeAsVisitorCallback = (resp: QChatChannelSubscribeAsVisitorResp) => void;
|
|
245
|
-
/** 更新白/黑名单身份组回调 */
|
|
246
|
-
export type UpdateWhiteBlackRoleCallback = (resp: QChatChannelUpdateWhiteBlackRoleResp) => void;
|
|
247
|
-
/** 更新白/黑名单成员回调 */
|
|
248
|
-
export type UpdateWhiteBlackMembersCallback = (resp: QChatChannelUpdateWhiteBlackMembersResp) => void;
|
|
249
|
-
/** 分页查询白/黑名单身份组回调 */
|
|
250
|
-
export type GetWhiteBlackRolesPageCallback = (resp: QChatChannelGetWhiteBlackRolesPageResp) => void;
|
|
251
|
-
/** 分页查询白/黑名单成员回调 */
|
|
252
|
-
export type GetWhiteBlackMembersPageCallback = (resp: QChatChannelGetWhiteBlackMembersPageResp) => void;
|
|
253
|
-
/** 查询已存在白/黑名单身份组回调 */
|
|
254
|
-
export type GetExistingWhiteBlackRolesCallback = (resp: QChatChannelGetExistingWhiteBlackRolesResp) => void;
|
|
255
|
-
/** 查询已存在白/黑名单成员回调 */
|
|
256
|
-
export type GetExistingWhiteBlackMembersCallback = (resp: QChatChannelGetExistingWhiteBlackMembersResp) => void;
|
|
257
|
-
/** 搜索频道分页回调 */
|
|
258
|
-
export type ChannelSearchPageCallback = GetChannelsPageCallback;
|
|
259
|
-
/** 搜索频道成员回调 */
|
|
260
|
-
export type ChannelMemberSearchCallback = ServerGetMembersCallback;
|
|
261
|
-
/** 创建频道分组回调 */
|
|
262
|
-
export type ChannelCategoryCreateCallback = (resp: QChatChannelCategoryCreateResp) => void;
|
|
263
|
-
/** 删除频道分组回调 */
|
|
264
|
-
export type ChannelCategoryRemoveCallback = (resp: QChatChannelCategoryRemoveResp) => void;
|
|
265
|
-
/** 更新频道分组回调 */
|
|
266
|
-
export type ChannelCategoryUpdateCallback = (resp: QChatChannelCategoryUpdateResp) => void;
|
|
267
|
-
/** 根据频道分组ID查询频道分组列表回调 */
|
|
268
|
-
export type ChannelGetCategoriesByIDCallback = (resp: QChatChannelGetCategoriesByIDResp) => void;
|
|
269
|
-
/** 分页查询频道分组回调 */
|
|
270
|
-
export type ChannelGetCategoriesPageCallback = (resp: QChatChannelGetCategoriesPageResp) => void;
|
|
271
|
-
/** 分页查询指定频道分组中的频道 */
|
|
272
|
-
export type ChannelGetCategoryChannelsPageCallback = (resp: QChatChannelGetCategoryChannelsPageResp) => void;
|
|
273
|
-
/** 更新频道分组白/黑名单身份组 */
|
|
274
|
-
export type ChannelCategoryUpdateWhiteBlackRoleCallback = (resp: QChatChannelCategoryUpdateWhiteBlackRoleResp) => void;
|
|
275
|
-
/** 分页查询频道分组白/黑名单身份组 */
|
|
276
|
-
export type ChannelCategoryGetWhiteBlackRolesPageCallback = (resp: QChatChannelCategoryGetWhiteBlackRolesPageResp) => void;
|
|
277
|
-
/** 批量查询频道分组白/黑名单身份组 */
|
|
278
|
-
export type ChannelCategoryGetExistingWhiteBlackRolesCallback = (resp: QChatChannelCategoryGetExistingWhiteBlackRolesResp) => void;
|
|
279
|
-
/** 更新频道分组白/黑名单成员 */
|
|
280
|
-
export type ChannelCategoryUpdateWhiteBlackMembersCallback = (resp: QChatChannelCategoryUpdateWhiteBlackMembersResp) => void;
|
|
281
|
-
/** 分页查询频道分组白/黑名单成员 */
|
|
282
|
-
export type ChannelCategoryGetWhiteBlackMembersPageCallback = (resp: QChatChannelCategoryGetWhiteBlackMembersPageResp) => void;
|
|
283
|
-
/** 批量查询频道分组白/黑名单成员 */
|
|
284
|
-
export type ChannelCategoryGetExistingWhiteBlackMembersCallback = (resp: QChatChannelCategoryGetExistingWhiteBlackMembersResp) => void;
|
|
285
|
-
/** 修改RTC频道参数回调 */
|
|
286
|
-
export type ChannelUpdateRTCInfoCallback = (resp: QChatChannelUpdateRTCInfoResp) => void;
|
|
287
|
-
/** 查询RTC频道参数回调 */
|
|
288
|
-
export type ChannelGetRTCInfoCallback = (resp: QChatChannelGetRTCInfoResp) => void;
|
|
289
|
-
/** 查询RTC频道在线成员回调 */
|
|
290
|
-
export type ChannelGetRTCOnlineMembersCallback = (resp: QChatChannelGetRTCOnlineMembersResp) => void;
|
|
291
|
-
/** @interface QChatChannelSubscribeParam */
|
|
292
|
-
export interface QChatChannelSubscribeParam {
|
|
293
|
-
/** 操作类型 */
|
|
294
|
-
ope_type?: NIMQChatSubscribeOpeType;
|
|
295
|
-
/** 订阅类型 */
|
|
296
|
-
sub_type?: NIMQChatSubscribeType;
|
|
297
|
-
/** ID 列表 */
|
|
298
|
-
id_infos?: Array<NIMQChatChannelIDInfo>;
|
|
299
|
-
}
|
|
300
|
-
/** @interface QChatChannelSubscribeAsVisitorParam */
|
|
301
|
-
export interface QChatChannelSubscribeAsVisitorParam {
|
|
302
|
-
/** 操作类型 */
|
|
303
|
-
ope_type?: NIMQChatSubscribeOpeType;
|
|
304
|
-
/** ID 列表 */
|
|
305
|
-
id_infos?: Array<NIMQChatChannelIDInfo>;
|
|
306
|
-
}
|
|
307
|
-
/** @interface QChatChannelQueryUnreadInfoParam */
|
|
308
|
-
export interface QChatChannelQueryUnreadInfoParam {
|
|
309
|
-
/** 待查询的ID列表 */
|
|
310
|
-
id_infos?: Array<NIMQChatChannelIDInfo>;
|
|
311
|
-
}
|
|
312
|
-
/** @interface QChatChannelCreateParam */
|
|
313
|
-
export interface QChatChannelCreateParam {
|
|
314
|
-
/** 频道信息 */
|
|
315
|
-
channel_info?: QChatChannelInfo;
|
|
316
|
-
/** 反垃圾信息 */
|
|
317
|
-
anti_spam_info?: QChatBusinessAntiSpamInfo;
|
|
318
|
-
}
|
|
319
|
-
/** @interface QChatChannelDeleteParam */
|
|
320
|
-
export interface QChatChannelDeleteParam {
|
|
321
|
-
/** 频道ID */
|
|
322
|
-
channel_id?: string;
|
|
323
|
-
}
|
|
324
|
-
/** @interface QChatChannelUpdateParam */
|
|
325
|
-
export interface QChatChannelUpdateParam {
|
|
326
|
-
/** 频道ID */
|
|
327
|
-
channel_id?: string;
|
|
328
|
-
/** 名称 */
|
|
329
|
-
name?: string;
|
|
330
|
-
/** 主题 */
|
|
331
|
-
topic?: string;
|
|
332
|
-
/** 自定义字段 */
|
|
333
|
-
custom?: string;
|
|
334
|
-
/** 查看模式 */
|
|
335
|
-
view_mode?: NIMQChatChannelViewMode;
|
|
336
|
-
/** 圈组频道游客访问模式 */
|
|
337
|
-
visitor_mode?: NIMQChatChannelVisitorMode;
|
|
338
|
-
/** 反垃圾信息 */
|
|
339
|
-
anti_spam_info?: QChatBusinessAntiSpamInfo;
|
|
340
|
-
}
|
|
341
|
-
/** @interface QChatChannelUpdateCategoryInfoParam */
|
|
342
|
-
export interface QChatChannelUpdateCategoryInfoParam {
|
|
343
|
-
/** 频道ID */
|
|
344
|
-
channel_id?: string;
|
|
345
|
-
/** 频道分组ID */
|
|
346
|
-
category_id?: string;
|
|
347
|
-
/** 频道分组同步模式 */
|
|
348
|
-
sync_mode?: NIMQChatChannelSyncMode;
|
|
349
|
-
}
|
|
350
|
-
/** @interface QChatChannelGetChannelsParam */
|
|
351
|
-
export interface QChatChannelGetChannelsParam {
|
|
352
|
-
/** 频道id列表 */
|
|
353
|
-
channel_ids?: Array<string>;
|
|
354
|
-
}
|
|
355
|
-
/** @interface QChatChannelGetChannelsPageParam */
|
|
356
|
-
export interface QChatChannelGetChannelsPageParam {
|
|
357
|
-
/** 服务器ID */
|
|
358
|
-
server_id?: string;
|
|
359
|
-
/** 时间戳 */
|
|
360
|
-
timestamp?: number;
|
|
361
|
-
/** 查询条数 */
|
|
362
|
-
limit?: number;
|
|
363
|
-
}
|
|
364
|
-
/** @interface QChatChannelGetMembersPageParam */
|
|
365
|
-
export interface QChatChannelGetMembersPageParam {
|
|
366
|
-
/** 服务器ID */
|
|
367
|
-
server_id?: string;
|
|
368
|
-
/** 频道ID */
|
|
369
|
-
channel_id?: string;
|
|
370
|
-
/** 时间戳 */
|
|
371
|
-
timestamp?: number;
|
|
372
|
-
/** 查询条数 */
|
|
373
|
-
limit?: number;
|
|
374
|
-
}
|
|
375
|
-
/** @interface QChatChannelUpdateWhiteBlackRoleParam */
|
|
376
|
-
export interface QChatChannelUpdateWhiteBlackRoleParam {
|
|
377
|
-
/** 服务器ID */
|
|
378
|
-
server_id?: string;
|
|
379
|
-
/** 频道ID */
|
|
380
|
-
channel_id?: string;
|
|
381
|
-
/** 身份组id */
|
|
382
|
-
role_id?: string;
|
|
383
|
-
/** 白/黑名单类型 */
|
|
384
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
385
|
-
/** 操作类型 */
|
|
386
|
-
ope_type?: NIMQChatChannelWhiteBlackOpeType;
|
|
387
|
-
}
|
|
388
|
-
/** @interface QChatChannelUpdateWhiteBlackMembersParam */
|
|
389
|
-
export interface QChatChannelUpdateWhiteBlackMembersParam {
|
|
390
|
-
/** 服务器ID */
|
|
391
|
-
server_id?: string;
|
|
392
|
-
/** 频道ID */
|
|
393
|
-
channel_id?: string;
|
|
394
|
-
/** 用户accid列表 */
|
|
395
|
-
accids?: Array<string>;
|
|
396
|
-
/** 白/黑名单类型 */
|
|
397
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
398
|
-
/** 操作类型 */
|
|
399
|
-
ope_type?: NIMQChatChannelWhiteBlackOpeType;
|
|
400
|
-
}
|
|
401
|
-
/** @interface QChatChannelGetWhiteBlackRolesPageParam */
|
|
402
|
-
export interface QChatChannelGetWhiteBlackRolesPageParam {
|
|
403
|
-
/** 服务器ID */
|
|
404
|
-
server_id?: string;
|
|
405
|
-
/** 频道ID */
|
|
406
|
-
channel_id?: string;
|
|
407
|
-
/** 白/黑名单类型 */
|
|
408
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
409
|
-
/** 时间戳 */
|
|
410
|
-
timestamp?: number;
|
|
411
|
-
/** 查询条数 */
|
|
412
|
-
limit?: number;
|
|
413
|
-
}
|
|
414
|
-
/** @interface QChatChannelGetWhiteBlackMembersPageParam */
|
|
415
|
-
export interface QChatChannelGetWhiteBlackMembersPageParam {
|
|
416
|
-
/** 服务器ID */
|
|
417
|
-
server_id?: string;
|
|
418
|
-
/** 频道ID */
|
|
419
|
-
channel_id?: string;
|
|
420
|
-
/** 白/黑名单类型 */
|
|
421
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
422
|
-
/** 时间戳 */
|
|
423
|
-
timestamp?: number;
|
|
424
|
-
/** 查询条数 */
|
|
425
|
-
limit?: number;
|
|
426
|
-
}
|
|
427
|
-
/** @interface QChatChannelGetExistingWhiteBlackRolesParam */
|
|
428
|
-
export interface QChatChannelGetExistingWhiteBlackRolesParam {
|
|
429
|
-
/** 服务器ID */
|
|
430
|
-
server_id?: string;
|
|
431
|
-
/** 频道ID */
|
|
432
|
-
channel_id?: string;
|
|
433
|
-
/** 白/黑名单类型 */
|
|
434
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
435
|
-
/** 身份组id列表 */
|
|
436
|
-
role_ids?: Array<string>;
|
|
437
|
-
}
|
|
438
|
-
/** @interface QChatChannelGetExistingWhiteBlackMembersParam */
|
|
439
|
-
export interface QChatChannelGetExistingWhiteBlackMembersParam {
|
|
440
|
-
/** 服务器ID */
|
|
441
|
-
server_id?: string;
|
|
442
|
-
/** 频道ID */
|
|
443
|
-
channel_id?: string;
|
|
444
|
-
/** 白/黑名单类型 */
|
|
445
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
446
|
-
/** 用户accid列表 */
|
|
447
|
-
accids?: Array<string>;
|
|
448
|
-
}
|
|
449
|
-
/** @interface QChatChannelSearchPageParam */
|
|
450
|
-
export interface QChatChannelSearchPageParam {
|
|
451
|
-
/** 服务器 id, 若为空则表示在所有服务器下可见频道中搜索 */
|
|
452
|
-
server_id?: string;
|
|
453
|
-
/** 搜索内容 */
|
|
454
|
-
keyword?: string;
|
|
455
|
-
/** 起始时间 */
|
|
456
|
-
start_time?: number;
|
|
457
|
-
/** 结束时间 */
|
|
458
|
-
end_time?: number;
|
|
459
|
-
/** 排序规则 */
|
|
460
|
-
order?: NIMQChatSearchOrder;
|
|
461
|
-
/** 排序条件 */
|
|
462
|
-
sort?: NIMQChatChannelSearchSort;
|
|
463
|
-
/** 查询条数 */
|
|
464
|
-
limit?: number;
|
|
465
|
-
/** 查询游标, 查询的起始位置 */
|
|
466
|
-
cursor?: string;
|
|
467
|
-
}
|
|
468
|
-
/** @interface QChatChannelMemberSearchParam */
|
|
469
|
-
export interface QChatChannelMemberSearchParam {
|
|
470
|
-
/** 服务器 id */
|
|
471
|
-
server_id?: string;
|
|
472
|
-
/** 频道 id */
|
|
473
|
-
channel_id?: string;
|
|
474
|
-
/** 搜索内容 */
|
|
475
|
-
keyword?: string;
|
|
476
|
-
/** 查询条数 */
|
|
477
|
-
limit?: number;
|
|
478
|
-
}
|
|
479
|
-
/** @interface QChatChannelCategoryCreateParam */
|
|
480
|
-
export interface QChatChannelCategoryCreateParam {
|
|
481
|
-
/** 服务器 id */
|
|
482
|
-
server_id?: string;
|
|
483
|
-
/** 名称 */
|
|
484
|
-
name?: string;
|
|
485
|
-
/** 自定义字段 */
|
|
486
|
-
custom?: string;
|
|
487
|
-
/** 查看模式 */
|
|
488
|
-
view_mode?: NIMQChatChannelViewMode;
|
|
489
|
-
}
|
|
490
|
-
/** @interface QChatChannelCategoryRemoveParam */
|
|
491
|
-
export interface QChatChannelCategoryRemoveParam {
|
|
492
|
-
/** 频道分组 ID */
|
|
493
|
-
category_id?: string;
|
|
494
|
-
}
|
|
495
|
-
/** @interface QChatChannelCategoryUpdateParam */
|
|
496
|
-
export interface QChatChannelCategoryUpdateParam {
|
|
497
|
-
/** 分组 id */
|
|
498
|
-
category_id?: string;
|
|
499
|
-
/** 名称 */
|
|
500
|
-
name?: string;
|
|
501
|
-
/** 自定义字段 */
|
|
502
|
-
custom?: string;
|
|
503
|
-
/** 查看模式 */
|
|
504
|
-
view_mode?: NIMQChatChannelViewMode;
|
|
505
|
-
}
|
|
506
|
-
/** @interface QChatChannelGetCategoriesByIDParam */
|
|
507
|
-
export interface QChatChannelGetCategoriesByIDParam {
|
|
508
|
-
/** 分组ID列表 */
|
|
509
|
-
category_ids?: Array<string>;
|
|
510
|
-
}
|
|
511
|
-
/** @interface QChatChannelGetCategoriesPageParam */
|
|
512
|
-
export interface QChatChannelGetCategoriesPageParam {
|
|
513
|
-
/** 服务器 id */
|
|
514
|
-
server_id?: string;
|
|
515
|
-
/** 时间戳 */
|
|
516
|
-
timestamp?: number;
|
|
517
|
-
/** 查询条数 */
|
|
518
|
-
limit?: number;
|
|
519
|
-
}
|
|
520
|
-
/** @interface QChatChannelGetCategoryChannelsPageParam */
|
|
521
|
-
export interface QChatChannelGetCategoryChannelsPageParam {
|
|
522
|
-
/** 服务器 id */
|
|
523
|
-
server_id?: string;
|
|
524
|
-
/** 分组 id */
|
|
525
|
-
category_id?: string;
|
|
526
|
-
/** 时间戳 */
|
|
527
|
-
timestamp?: number;
|
|
528
|
-
/** 查询条数 */
|
|
529
|
-
limit?: number;
|
|
530
|
-
}
|
|
531
|
-
/** @interface QChatChannelCategoryUpdateWhiteBlackRoleParam */
|
|
532
|
-
export interface QChatChannelCategoryUpdateWhiteBlackRoleParam {
|
|
533
|
-
/** 服务器 id */
|
|
534
|
-
server_id?: string;
|
|
535
|
-
/** 分组 id */
|
|
536
|
-
category_id?: string;
|
|
537
|
-
/** 身份组 id */
|
|
538
|
-
role_id?: string;
|
|
539
|
-
/** 白/黑名单类型 */
|
|
540
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
541
|
-
/** 操作类型 */
|
|
542
|
-
ope_type?: NIMQChatChannelWhiteBlackOpeType;
|
|
543
|
-
}
|
|
544
|
-
/** @interface QChatChannelCategoryGetWhiteBlackRolesPageParam */
|
|
545
|
-
export interface QChatChannelCategoryGetWhiteBlackRolesPageParam {
|
|
546
|
-
/** 获取频道分组白/黑名单身份组回调 */
|
|
547
|
-
cb?: ChannelCategoryGetWhiteBlackRolesPageCallback;
|
|
548
|
-
/** 服务器 ID */
|
|
549
|
-
server_id?: string;
|
|
550
|
-
/** 分组ID */
|
|
551
|
-
category_id?: string;
|
|
552
|
-
/** 白/黑名单类型 */
|
|
553
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
554
|
-
/** 时间戳 */
|
|
555
|
-
timestamp?: number;
|
|
556
|
-
/** 查询条数 */
|
|
557
|
-
limit?: number;
|
|
558
|
-
}
|
|
559
|
-
/** @interface QChatChannelCategoryGetExistingWhiteBlackRolesParam */
|
|
560
|
-
export interface QChatChannelCategoryGetExistingWhiteBlackRolesParam {
|
|
561
|
-
/** 获取频道分组白/黑名单身份组回调 */
|
|
562
|
-
cb?: ChannelCategoryGetExistingWhiteBlackRolesCallback;
|
|
563
|
-
/** 服务器 ID */
|
|
564
|
-
server_id?: string;
|
|
565
|
-
/** 分组ID */
|
|
566
|
-
category_id?: string;
|
|
567
|
-
/** 白/黑名单类型 */
|
|
568
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
569
|
-
/** 身份组ID列表 */
|
|
570
|
-
role_ids?: Array<string>;
|
|
571
|
-
}
|
|
572
|
-
/** @interface QChatChannelCategoryUpdateWhiteBlackMembersParam */
|
|
573
|
-
export interface QChatChannelCategoryUpdateWhiteBlackMembersParam {
|
|
574
|
-
/** 更新频道分组白/黑名单成员回调 */
|
|
575
|
-
cb?: ChannelCategoryUpdateWhiteBlackMembersCallback;
|
|
576
|
-
/** 服务器 ID */
|
|
577
|
-
server_id?: string;
|
|
578
|
-
/** 分组ID */
|
|
579
|
-
category_id?: string;
|
|
580
|
-
/** 成员ID列表 */
|
|
581
|
-
accids?: Array<string>;
|
|
582
|
-
/** 白/黑名单类型 */
|
|
583
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
584
|
-
/** 操作类型 */
|
|
585
|
-
ope_type?: NIMQChatChannelWhiteBlackOpeType;
|
|
586
|
-
}
|
|
587
|
-
/** @interface QChatChannelCategoryGetWhiteBlackMembersPageParam */
|
|
588
|
-
export interface QChatChannelCategoryGetWhiteBlackMembersPageParam {
|
|
589
|
-
/** 获取频道分组白/黑名单成员回调 */
|
|
590
|
-
cb?: ChannelCategoryGetWhiteBlackMembersPageCallback;
|
|
591
|
-
/** 服务器 ID */
|
|
592
|
-
server_id?: string;
|
|
593
|
-
/** 分组ID */
|
|
594
|
-
category_id?: string;
|
|
595
|
-
/** 白/黑名单类型 */
|
|
596
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
597
|
-
/** 时间戳 */
|
|
598
|
-
timestamp?: number;
|
|
599
|
-
/** 查询条数 */
|
|
600
|
-
limit?: number;
|
|
601
|
-
}
|
|
602
|
-
/** @interface QChatChannelCategoryGetExistingWhiteBlackMembersParam */
|
|
603
|
-
export interface QChatChannelCategoryGetExistingWhiteBlackMembersParam {
|
|
604
|
-
/** 获取频道分组白/黑名单成员回调 */
|
|
605
|
-
cb?: ChannelCategoryGetExistingWhiteBlackMembersCallback;
|
|
606
|
-
/** 服务器 ID */
|
|
607
|
-
server_id?: string;
|
|
608
|
-
/** 分组ID */
|
|
609
|
-
category_id?: string;
|
|
610
|
-
/** 白/黑名单类型 */
|
|
611
|
-
type?: NIMQChatChannelWhiteBlackType;
|
|
612
|
-
/** 成员ID列表 */
|
|
613
|
-
accids?: Array<string>;
|
|
614
|
-
}
|
|
615
|
-
/** @interface QChatChannelUpdateRTCInfoParam */
|
|
616
|
-
export interface QChatChannelUpdateRTCInfoParam {
|
|
617
|
-
/** 修改RTC频道参数回调 */
|
|
618
|
-
cb?: ChannelUpdateRTCInfoCallback;
|
|
619
|
-
/** 服务器 ID */
|
|
620
|
-
server_id?: string;
|
|
621
|
-
/** 频道 ID */
|
|
622
|
-
channel_id?: string;
|
|
623
|
-
/** RTC频道参数 */
|
|
624
|
-
rtc_info?: QChatChannelRTCInfo;
|
|
625
|
-
}
|
|
626
|
-
/** @interface QChatChannelGetRTCInfoParam */
|
|
627
|
-
export interface QChatChannelGetRTCInfoParam {
|
|
628
|
-
/** 查询RTC频道参数回调 */
|
|
629
|
-
cb?: ChannelGetRTCInfoCallback;
|
|
630
|
-
/** 服务器 ID */
|
|
631
|
-
server_id?: string;
|
|
632
|
-
/** 频道 ID */
|
|
633
|
-
channel_id?: string;
|
|
634
|
-
}
|
|
635
|
-
/** @interface QChatChannelGetRTCOnlineMembersParam */
|
|
636
|
-
export interface QChatChannelGetRTCOnlineMembersParam {
|
|
637
|
-
/** 获取RTC在线成员列表回调 */
|
|
638
|
-
cb?: ChannelGetRTCOnlineMembersCallback;
|
|
639
|
-
/** 服务器 ID */
|
|
640
|
-
server_id?: string;
|
|
641
|
-
/** 频道 ID */
|
|
642
|
-
channel_id?: string;
|
|
643
|
-
}
|
|
1
|
+
import { NIMQChatChannelType, NIMQChatChannelViewMode, NIMQChatChannelSyncMode, NIMQChatChannelIDInfo, NIMQChatSubscribeType, NIMQChatSubscribeOpeType, NIMQChatChannelWhiteBlackType, NIMQChatChannelWhiteBlackOpeType, NIMQChatSearchOrder, NIMQChatChannelSearchSort, QChatBaseResp, QChatBusinessAntiSpamInfo, QChatPageInfo, QChatMemberInfo, QChatServerRoleInfo, NIMQChatUnreadInfo, NIMResCode, NIMQChatChannelVisitorMode } from './public_def';
|
|
2
|
+
import { QChatServerGetMembersPageResp, QChatServerGetMembersResp, ServerGetMembersCallback } from './server_def';
|
|
3
|
+
export interface QChatChannelInfo {
|
|
4
|
+
/** server id */
|
|
5
|
+
server_id?: string;
|
|
6
|
+
/** channel id */
|
|
7
|
+
channel_id?: string;
|
|
8
|
+
/** 名称 */
|
|
9
|
+
name?: string;
|
|
10
|
+
/** 主题 */
|
|
11
|
+
topic?: string;
|
|
12
|
+
/** 自定义字段 */
|
|
13
|
+
custom?: string;
|
|
14
|
+
/** 频道类型,0:消息频道 */
|
|
15
|
+
type?: NIMQChatChannelType;
|
|
16
|
+
/** 拥有者 */
|
|
17
|
+
owner?: string;
|
|
18
|
+
/** 查看模式,只有在category_id为0或sync_mode为kNIMQChatChannelSyncModeNoSync时有效 */
|
|
19
|
+
view_mode?: NIMQChatChannelViewMode;
|
|
20
|
+
/** 圈组频道游客访问模式 */
|
|
21
|
+
visitor_mode?: NIMQChatChannelVisitorMode;
|
|
22
|
+
/** 有效标记,false:无效 true:有效 */
|
|
23
|
+
valid_flag?: boolean;
|
|
24
|
+
/** 创建时间 */
|
|
25
|
+
create_time?: number;
|
|
26
|
+
/** 更新时间 */
|
|
27
|
+
update_time?: number;
|
|
28
|
+
/** 频道分组ID */
|
|
29
|
+
category_id?: string;
|
|
30
|
+
/** 频道分组同步模式 */
|
|
31
|
+
sync_mode?: NIMQChatChannelSyncMode;
|
|
32
|
+
/** 自定义排序权重值 */
|
|
33
|
+
reorder_weight?: number;
|
|
34
|
+
}
|
|
35
|
+
export interface QChatChannelRTCAudioInfo {
|
|
36
|
+
/** 音频属性 ["HIGH_QUALITY_STEREO","HIGH_QUALITY","STANDARD_EXTEND"] */
|
|
37
|
+
profile?: string;
|
|
38
|
+
/** 音频应用场景 ["DEFAULT","SPEECH","MUSIC", "CHATROOM"] */
|
|
39
|
+
scenario?: string;
|
|
40
|
+
}
|
|
41
|
+
export interface QChatChannelRTCVideoInfo {
|
|
42
|
+
/** 分辨率宽 */
|
|
43
|
+
width?: number;
|
|
44
|
+
/** 分辨率高 */
|
|
45
|
+
height?: number;
|
|
46
|
+
/** 帧率 */
|
|
47
|
+
fps?: number;
|
|
48
|
+
}
|
|
49
|
+
export interface QChatChannelRTCInfo {
|
|
50
|
+
/** 在线人数限制 */
|
|
51
|
+
limit?: number;
|
|
52
|
+
/** 音频配置 */
|
|
53
|
+
audio?: QChatChannelRTCAudioInfo;
|
|
54
|
+
/** 视频配置 */
|
|
55
|
+
video?: QChatChannelRTCVideoInfo;
|
|
56
|
+
}
|
|
57
|
+
export interface QChatChannelCategoryInfo {
|
|
58
|
+
/** server id */
|
|
59
|
+
server_id?: string;
|
|
60
|
+
/** category id */
|
|
61
|
+
category_id?: string;
|
|
62
|
+
/** 名称 */
|
|
63
|
+
name?: string;
|
|
64
|
+
/** 自定义字段 */
|
|
65
|
+
custom?: string;
|
|
66
|
+
/** 拥有者 */
|
|
67
|
+
owner?: string;
|
|
68
|
+
/** 查看模式 */
|
|
69
|
+
view_mode?: NIMQChatChannelViewMode;
|
|
70
|
+
/** 有效标记,false:无效 true:有效 */
|
|
71
|
+
valid_flag?: boolean;
|
|
72
|
+
/** 创建时间 */
|
|
73
|
+
create_time?: number;
|
|
74
|
+
/** 更新时间 */
|
|
75
|
+
update_time?: number;
|
|
76
|
+
/** 频道数量 */
|
|
77
|
+
channel_number?: number;
|
|
78
|
+
}
|
|
79
|
+
export interface QChatChannelSubscribeResp {
|
|
80
|
+
/** 操作结果, 参考NIMResCode */
|
|
81
|
+
res_code?: NIMResCode;
|
|
82
|
+
/** 失败列表 */
|
|
83
|
+
failed_channels?: Array<NIMQChatChannelIDInfo>;
|
|
84
|
+
}
|
|
85
|
+
export interface QChatChannelSubscribeAsVisitorResp {
|
|
86
|
+
/** 操作结果, 参考NIMResCode */
|
|
87
|
+
res_code?: NIMResCode;
|
|
88
|
+
/** 失败列表 */
|
|
89
|
+
failed_channels?: Array<NIMQChatChannelIDInfo>;
|
|
90
|
+
}
|
|
91
|
+
export interface QChatChannelQueryUnreadInfoResp {
|
|
92
|
+
/** 操作结果, 参考NIMResCode */
|
|
93
|
+
res_code?: NIMResCode;
|
|
94
|
+
/** 未读信息列表 */
|
|
95
|
+
unread_infos?: Array<NIMQChatUnreadInfo>;
|
|
96
|
+
}
|
|
97
|
+
export interface QChatChannelCreateResp {
|
|
98
|
+
/** 操作结果, 参考NIMResCode */
|
|
99
|
+
res_code?: NIMResCode;
|
|
100
|
+
/** 频道信息 */
|
|
101
|
+
channel_info?: QChatChannelInfo;
|
|
102
|
+
}
|
|
103
|
+
export type QChatChannelDeleteResp = QChatBaseResp;
|
|
104
|
+
export type QChatChannelUpdateResp = QChatChannelCreateResp;
|
|
105
|
+
export type QChatChannelUpdateCategoryInfoResp = QChatChannelCreateResp;
|
|
106
|
+
export interface QChatChannelGetChannelsResp {
|
|
107
|
+
/** 操作结果, 参考NIMResCode */
|
|
108
|
+
res_code?: NIMResCode;
|
|
109
|
+
/** 频道列表 */
|
|
110
|
+
channel_list?: Array<QChatChannelInfo>;
|
|
111
|
+
}
|
|
112
|
+
export interface QChatChannelGetChannelsPageResp {
|
|
113
|
+
/** 操作结果, 参考NIMResCode */
|
|
114
|
+
res_code?: NIMResCode;
|
|
115
|
+
/** 分页信息 */
|
|
116
|
+
page_info?: QChatPageInfo;
|
|
117
|
+
/** 频道列表 */
|
|
118
|
+
channel_list?: Array<QChatChannelInfo>;
|
|
119
|
+
}
|
|
120
|
+
export interface QChatChannelUnreadResp {
|
|
121
|
+
/** 未读数信息 */
|
|
122
|
+
unread_infos?: Array<NIMQChatUnreadInfo>;
|
|
123
|
+
}
|
|
124
|
+
export type QChatChannelUpdateWhiteBlackRoleResp = QChatBaseResp;
|
|
125
|
+
export type QChatChannelUpdateWhiteBlackMembersResp = QChatBaseResp;
|
|
126
|
+
export interface QChatChannelGetWhiteBlackRolesPageResp {
|
|
127
|
+
/** 操作结果, 参考NIMResCode */
|
|
128
|
+
res_code?: NIMResCode;
|
|
129
|
+
/** 分页信息 */
|
|
130
|
+
page_info?: QChatPageInfo;
|
|
131
|
+
/** 身份组列表 */
|
|
132
|
+
roles?: Array<QChatServerRoleInfo>;
|
|
133
|
+
}
|
|
134
|
+
export interface QChatChannelGetWhiteBlackMembersPageResp {
|
|
135
|
+
/** 操作结果, 参考NIMResCode */
|
|
136
|
+
res_code?: NIMResCode;
|
|
137
|
+
/** 分页信息 */
|
|
138
|
+
page_info?: QChatPageInfo;
|
|
139
|
+
/** 身份组列表 */
|
|
140
|
+
members?: Array<QChatMemberInfo>;
|
|
141
|
+
}
|
|
142
|
+
export interface QChatChannelGetExistingWhiteBlackRolesResp {
|
|
143
|
+
/** 操作结果, 参考NIMResCode */
|
|
144
|
+
res_code?: NIMResCode;
|
|
145
|
+
/** 身份组列表 */
|
|
146
|
+
roles?: Array<QChatServerRoleInfo>;
|
|
147
|
+
}
|
|
148
|
+
export interface QChatChannelGetExistingWhiteBlackMembersResp {
|
|
149
|
+
/** 操作结果, 参考NIMResCode */
|
|
150
|
+
res_code?: NIMResCode;
|
|
151
|
+
/** 身份组列表,结果中不包含成员有效属性 vaild_flag */
|
|
152
|
+
members?: Array<QChatMemberInfo>;
|
|
153
|
+
}
|
|
154
|
+
export type QChatChannelGetMembersPageResp = QChatServerGetMembersPageResp;
|
|
155
|
+
export type QChatChannelSearchPageResp = QChatChannelGetChannelsPageResp;
|
|
156
|
+
export type QChatChannelMemberSearchResp = QChatServerGetMembersResp;
|
|
157
|
+
export interface QChatChannelCategoryCreateResp {
|
|
158
|
+
/** 操作结果, 参考NIMResCode */
|
|
159
|
+
res_code?: NIMResCode;
|
|
160
|
+
/** 分类信息 */
|
|
161
|
+
category_info?: QChatChannelCategoryInfo;
|
|
162
|
+
}
|
|
163
|
+
export type QChatChannelCategoryRemoveResp = QChatBaseResp;
|
|
164
|
+
export type QChatChannelCategoryUpdateResp = QChatChannelCategoryCreateResp;
|
|
165
|
+
export interface QChatChannelGetCategoriesByIDResp {
|
|
166
|
+
/** 操作结果, 参考NIMResCode */
|
|
167
|
+
res_code?: NIMResCode;
|
|
168
|
+
/** 频道分组信息列表 */
|
|
169
|
+
categories?: Array<QChatChannelCategoryInfo>;
|
|
170
|
+
}
|
|
171
|
+
export interface QChatChannelGetCategoriesPageResp {
|
|
172
|
+
/** 操作结果, 参考NIMResCode */
|
|
173
|
+
res_code?: NIMResCode;
|
|
174
|
+
/** 分页信息 */
|
|
175
|
+
page_info?: QChatPageInfo;
|
|
176
|
+
/** 分类信息 */
|
|
177
|
+
categories?: Array<QChatChannelCategoryInfo>;
|
|
178
|
+
}
|
|
179
|
+
export type QChatChannelGetCategoryChannelsPageResp = QChatChannelGetChannelsPageResp;
|
|
180
|
+
export type QChatChannelCategoryUpdateWhiteBlackRoleResp = QChatBaseResp;
|
|
181
|
+
export interface QChatChannelCategoryGetWhiteBlackRolesPageResp {
|
|
182
|
+
/** 操作结果, 参考NIMResCode */
|
|
183
|
+
res_code?: NIMResCode;
|
|
184
|
+
/** 分页信息 */
|
|
185
|
+
page_info?: QChatPageInfo;
|
|
186
|
+
/** 身份组列表 */
|
|
187
|
+
roles?: Array<QChatServerRoleInfo>;
|
|
188
|
+
}
|
|
189
|
+
export interface QChatChannelCategoryGetExistingWhiteBlackRolesResp {
|
|
190
|
+
/** 操作结果, 参考NIMResCode */
|
|
191
|
+
res_code?: NIMResCode;
|
|
192
|
+
/** 身份组列表 */
|
|
193
|
+
roles?: Array<QChatServerRoleInfo>;
|
|
194
|
+
}
|
|
195
|
+
export type QChatChannelCategoryUpdateWhiteBlackMembersResp = QChatBaseResp;
|
|
196
|
+
export interface QChatChannelCategoryGetWhiteBlackMembersPageResp {
|
|
197
|
+
/** 操作结果, 参考NIMResCode */
|
|
198
|
+
res_code?: NIMResCode;
|
|
199
|
+
/** 分页信息 */
|
|
200
|
+
page_info?: QChatPageInfo;
|
|
201
|
+
/** 成员列表 */
|
|
202
|
+
members?: Array<QChatMemberInfo>;
|
|
203
|
+
}
|
|
204
|
+
export interface QChatChannelCategoryGetExistingWhiteBlackMembersResp {
|
|
205
|
+
/** 操作结果, 参考NIMResCode */
|
|
206
|
+
res_code?: NIMResCode;
|
|
207
|
+
/** 成员列表 */
|
|
208
|
+
members?: Array<QChatMemberInfo>;
|
|
209
|
+
}
|
|
210
|
+
export type QChatChannelUpdateRTCInfoResp = QChatBaseResp;
|
|
211
|
+
export interface QChatChannelGetRTCInfoResp {
|
|
212
|
+
/** 操作结果, 参考NIMResCode */
|
|
213
|
+
res_code?: NIMResCode;
|
|
214
|
+
/** RTC信息 */
|
|
215
|
+
rtc_info?: QChatChannelRTCInfo;
|
|
216
|
+
}
|
|
217
|
+
export interface QChatChannelGetRTCOnlineMembersResp {
|
|
218
|
+
/** 操作结果, 参考NIMResCode */
|
|
219
|
+
res_code?: NIMResCode;
|
|
220
|
+
/** 成员列表 */
|
|
221
|
+
members?: Array<QChatMemberInfo>;
|
|
222
|
+
}
|
|
223
|
+
/** 未读信息回调 */
|
|
224
|
+
export type ChannelUnreadCallback = (resp: QChatChannelUnreadResp) => void;
|
|
225
|
+
/** 创建频道回调 */
|
|
226
|
+
export type ChannelCreateCallback = (resp: QChatChannelCreateResp) => void;
|
|
227
|
+
/** 删除频道回调 */
|
|
228
|
+
export type ChannelDeleteCallback = (resp: QChatChannelDeleteResp) => void;
|
|
229
|
+
/** 更新频道回调 */
|
|
230
|
+
export type ChannelUpdateCallback = (resp: QChatChannelUpdateResp) => void;
|
|
231
|
+
/** 更新频道的分组信息回调 */
|
|
232
|
+
export type ChannelUpdateCategoryInfoCallback = (resp: QChatChannelUpdateCategoryInfoResp) => void;
|
|
233
|
+
/** 查询频道列表回调 */
|
|
234
|
+
export type GetChannelsCallback = (resp: QChatChannelGetChannelsResp) => void;
|
|
235
|
+
/** 分页查询频道列表回调 */
|
|
236
|
+
export type GetChannelsPageCallback = (resp: QChatChannelGetChannelsPageResp) => void;
|
|
237
|
+
/** 分页查询成员列表回调 */
|
|
238
|
+
export type ChannelGetMembersPageCallback = (resp: QChatChannelGetMembersPageResp) => void;
|
|
239
|
+
/** 查询未读消息数回调 */
|
|
240
|
+
export type ChannelQueryUnreadInfoCallback = (resp: QChatChannelQueryUnreadInfoResp) => void;
|
|
241
|
+
/** 订阅回调 */
|
|
242
|
+
export type ChannelSubscribeCallback = (resp: QChatChannelSubscribeResp) => void;
|
|
243
|
+
/** 订阅回调 */
|
|
244
|
+
export type ChannelSubscribeAsVisitorCallback = (resp: QChatChannelSubscribeAsVisitorResp) => void;
|
|
245
|
+
/** 更新白/黑名单身份组回调 */
|
|
246
|
+
export type UpdateWhiteBlackRoleCallback = (resp: QChatChannelUpdateWhiteBlackRoleResp) => void;
|
|
247
|
+
/** 更新白/黑名单成员回调 */
|
|
248
|
+
export type UpdateWhiteBlackMembersCallback = (resp: QChatChannelUpdateWhiteBlackMembersResp) => void;
|
|
249
|
+
/** 分页查询白/黑名单身份组回调 */
|
|
250
|
+
export type GetWhiteBlackRolesPageCallback = (resp: QChatChannelGetWhiteBlackRolesPageResp) => void;
|
|
251
|
+
/** 分页查询白/黑名单成员回调 */
|
|
252
|
+
export type GetWhiteBlackMembersPageCallback = (resp: QChatChannelGetWhiteBlackMembersPageResp) => void;
|
|
253
|
+
/** 查询已存在白/黑名单身份组回调 */
|
|
254
|
+
export type GetExistingWhiteBlackRolesCallback = (resp: QChatChannelGetExistingWhiteBlackRolesResp) => void;
|
|
255
|
+
/** 查询已存在白/黑名单成员回调 */
|
|
256
|
+
export type GetExistingWhiteBlackMembersCallback = (resp: QChatChannelGetExistingWhiteBlackMembersResp) => void;
|
|
257
|
+
/** 搜索频道分页回调 */
|
|
258
|
+
export type ChannelSearchPageCallback = GetChannelsPageCallback;
|
|
259
|
+
/** 搜索频道成员回调 */
|
|
260
|
+
export type ChannelMemberSearchCallback = ServerGetMembersCallback;
|
|
261
|
+
/** 创建频道分组回调 */
|
|
262
|
+
export type ChannelCategoryCreateCallback = (resp: QChatChannelCategoryCreateResp) => void;
|
|
263
|
+
/** 删除频道分组回调 */
|
|
264
|
+
export type ChannelCategoryRemoveCallback = (resp: QChatChannelCategoryRemoveResp) => void;
|
|
265
|
+
/** 更新频道分组回调 */
|
|
266
|
+
export type ChannelCategoryUpdateCallback = (resp: QChatChannelCategoryUpdateResp) => void;
|
|
267
|
+
/** 根据频道分组ID查询频道分组列表回调 */
|
|
268
|
+
export type ChannelGetCategoriesByIDCallback = (resp: QChatChannelGetCategoriesByIDResp) => void;
|
|
269
|
+
/** 分页查询频道分组回调 */
|
|
270
|
+
export type ChannelGetCategoriesPageCallback = (resp: QChatChannelGetCategoriesPageResp) => void;
|
|
271
|
+
/** 分页查询指定频道分组中的频道 */
|
|
272
|
+
export type ChannelGetCategoryChannelsPageCallback = (resp: QChatChannelGetCategoryChannelsPageResp) => void;
|
|
273
|
+
/** 更新频道分组白/黑名单身份组 */
|
|
274
|
+
export type ChannelCategoryUpdateWhiteBlackRoleCallback = (resp: QChatChannelCategoryUpdateWhiteBlackRoleResp) => void;
|
|
275
|
+
/** 分页查询频道分组白/黑名单身份组 */
|
|
276
|
+
export type ChannelCategoryGetWhiteBlackRolesPageCallback = (resp: QChatChannelCategoryGetWhiteBlackRolesPageResp) => void;
|
|
277
|
+
/** 批量查询频道分组白/黑名单身份组 */
|
|
278
|
+
export type ChannelCategoryGetExistingWhiteBlackRolesCallback = (resp: QChatChannelCategoryGetExistingWhiteBlackRolesResp) => void;
|
|
279
|
+
/** 更新频道分组白/黑名单成员 */
|
|
280
|
+
export type ChannelCategoryUpdateWhiteBlackMembersCallback = (resp: QChatChannelCategoryUpdateWhiteBlackMembersResp) => void;
|
|
281
|
+
/** 分页查询频道分组白/黑名单成员 */
|
|
282
|
+
export type ChannelCategoryGetWhiteBlackMembersPageCallback = (resp: QChatChannelCategoryGetWhiteBlackMembersPageResp) => void;
|
|
283
|
+
/** 批量查询频道分组白/黑名单成员 */
|
|
284
|
+
export type ChannelCategoryGetExistingWhiteBlackMembersCallback = (resp: QChatChannelCategoryGetExistingWhiteBlackMembersResp) => void;
|
|
285
|
+
/** 修改RTC频道参数回调 */
|
|
286
|
+
export type ChannelUpdateRTCInfoCallback = (resp: QChatChannelUpdateRTCInfoResp) => void;
|
|
287
|
+
/** 查询RTC频道参数回调 */
|
|
288
|
+
export type ChannelGetRTCInfoCallback = (resp: QChatChannelGetRTCInfoResp) => void;
|
|
289
|
+
/** 查询RTC频道在线成员回调 */
|
|
290
|
+
export type ChannelGetRTCOnlineMembersCallback = (resp: QChatChannelGetRTCOnlineMembersResp) => void;
|
|
291
|
+
/** @interface QChatChannelSubscribeParam */
|
|
292
|
+
export interface QChatChannelSubscribeParam {
|
|
293
|
+
/** 操作类型 */
|
|
294
|
+
ope_type?: NIMQChatSubscribeOpeType;
|
|
295
|
+
/** 订阅类型 */
|
|
296
|
+
sub_type?: NIMQChatSubscribeType;
|
|
297
|
+
/** ID 列表 */
|
|
298
|
+
id_infos?: Array<NIMQChatChannelIDInfo>;
|
|
299
|
+
}
|
|
300
|
+
/** @interface QChatChannelSubscribeAsVisitorParam */
|
|
301
|
+
export interface QChatChannelSubscribeAsVisitorParam {
|
|
302
|
+
/** 操作类型 */
|
|
303
|
+
ope_type?: NIMQChatSubscribeOpeType;
|
|
304
|
+
/** ID 列表 */
|
|
305
|
+
id_infos?: Array<NIMQChatChannelIDInfo>;
|
|
306
|
+
}
|
|
307
|
+
/** @interface QChatChannelQueryUnreadInfoParam */
|
|
308
|
+
export interface QChatChannelQueryUnreadInfoParam {
|
|
309
|
+
/** 待查询的ID列表 */
|
|
310
|
+
id_infos?: Array<NIMQChatChannelIDInfo>;
|
|
311
|
+
}
|
|
312
|
+
/** @interface QChatChannelCreateParam */
|
|
313
|
+
export interface QChatChannelCreateParam {
|
|
314
|
+
/** 频道信息 */
|
|
315
|
+
channel_info?: QChatChannelInfo;
|
|
316
|
+
/** 反垃圾信息 */
|
|
317
|
+
anti_spam_info?: QChatBusinessAntiSpamInfo;
|
|
318
|
+
}
|
|
319
|
+
/** @interface QChatChannelDeleteParam */
|
|
320
|
+
export interface QChatChannelDeleteParam {
|
|
321
|
+
/** 频道ID */
|
|
322
|
+
channel_id?: string;
|
|
323
|
+
}
|
|
324
|
+
/** @interface QChatChannelUpdateParam */
|
|
325
|
+
export interface QChatChannelUpdateParam {
|
|
326
|
+
/** 频道ID */
|
|
327
|
+
channel_id?: string;
|
|
328
|
+
/** 名称 */
|
|
329
|
+
name?: string;
|
|
330
|
+
/** 主题 */
|
|
331
|
+
topic?: string;
|
|
332
|
+
/** 自定义字段 */
|
|
333
|
+
custom?: string;
|
|
334
|
+
/** 查看模式 */
|
|
335
|
+
view_mode?: NIMQChatChannelViewMode;
|
|
336
|
+
/** 圈组频道游客访问模式 */
|
|
337
|
+
visitor_mode?: NIMQChatChannelVisitorMode;
|
|
338
|
+
/** 反垃圾信息 */
|
|
339
|
+
anti_spam_info?: QChatBusinessAntiSpamInfo;
|
|
340
|
+
}
|
|
341
|
+
/** @interface QChatChannelUpdateCategoryInfoParam */
|
|
342
|
+
export interface QChatChannelUpdateCategoryInfoParam {
|
|
343
|
+
/** 频道ID */
|
|
344
|
+
channel_id?: string;
|
|
345
|
+
/** 频道分组ID */
|
|
346
|
+
category_id?: string;
|
|
347
|
+
/** 频道分组同步模式 */
|
|
348
|
+
sync_mode?: NIMQChatChannelSyncMode;
|
|
349
|
+
}
|
|
350
|
+
/** @interface QChatChannelGetChannelsParam */
|
|
351
|
+
export interface QChatChannelGetChannelsParam {
|
|
352
|
+
/** 频道id列表 */
|
|
353
|
+
channel_ids?: Array<string>;
|
|
354
|
+
}
|
|
355
|
+
/** @interface QChatChannelGetChannelsPageParam */
|
|
356
|
+
export interface QChatChannelGetChannelsPageParam {
|
|
357
|
+
/** 服务器ID */
|
|
358
|
+
server_id?: string;
|
|
359
|
+
/** 时间戳 */
|
|
360
|
+
timestamp?: number;
|
|
361
|
+
/** 查询条数 */
|
|
362
|
+
limit?: number;
|
|
363
|
+
}
|
|
364
|
+
/** @interface QChatChannelGetMembersPageParam */
|
|
365
|
+
export interface QChatChannelGetMembersPageParam {
|
|
366
|
+
/** 服务器ID */
|
|
367
|
+
server_id?: string;
|
|
368
|
+
/** 频道ID */
|
|
369
|
+
channel_id?: string;
|
|
370
|
+
/** 时间戳 */
|
|
371
|
+
timestamp?: number;
|
|
372
|
+
/** 查询条数 */
|
|
373
|
+
limit?: number;
|
|
374
|
+
}
|
|
375
|
+
/** @interface QChatChannelUpdateWhiteBlackRoleParam */
|
|
376
|
+
export interface QChatChannelUpdateWhiteBlackRoleParam {
|
|
377
|
+
/** 服务器ID */
|
|
378
|
+
server_id?: string;
|
|
379
|
+
/** 频道ID */
|
|
380
|
+
channel_id?: string;
|
|
381
|
+
/** 身份组id */
|
|
382
|
+
role_id?: string;
|
|
383
|
+
/** 白/黑名单类型 */
|
|
384
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
385
|
+
/** 操作类型 */
|
|
386
|
+
ope_type?: NIMQChatChannelWhiteBlackOpeType;
|
|
387
|
+
}
|
|
388
|
+
/** @interface QChatChannelUpdateWhiteBlackMembersParam */
|
|
389
|
+
export interface QChatChannelUpdateWhiteBlackMembersParam {
|
|
390
|
+
/** 服务器ID */
|
|
391
|
+
server_id?: string;
|
|
392
|
+
/** 频道ID */
|
|
393
|
+
channel_id?: string;
|
|
394
|
+
/** 用户accid列表 */
|
|
395
|
+
accids?: Array<string>;
|
|
396
|
+
/** 白/黑名单类型 */
|
|
397
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
398
|
+
/** 操作类型 */
|
|
399
|
+
ope_type?: NIMQChatChannelWhiteBlackOpeType;
|
|
400
|
+
}
|
|
401
|
+
/** @interface QChatChannelGetWhiteBlackRolesPageParam */
|
|
402
|
+
export interface QChatChannelGetWhiteBlackRolesPageParam {
|
|
403
|
+
/** 服务器ID */
|
|
404
|
+
server_id?: string;
|
|
405
|
+
/** 频道ID */
|
|
406
|
+
channel_id?: string;
|
|
407
|
+
/** 白/黑名单类型 */
|
|
408
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
409
|
+
/** 时间戳 */
|
|
410
|
+
timestamp?: number;
|
|
411
|
+
/** 查询条数 */
|
|
412
|
+
limit?: number;
|
|
413
|
+
}
|
|
414
|
+
/** @interface QChatChannelGetWhiteBlackMembersPageParam */
|
|
415
|
+
export interface QChatChannelGetWhiteBlackMembersPageParam {
|
|
416
|
+
/** 服务器ID */
|
|
417
|
+
server_id?: string;
|
|
418
|
+
/** 频道ID */
|
|
419
|
+
channel_id?: string;
|
|
420
|
+
/** 白/黑名单类型 */
|
|
421
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
422
|
+
/** 时间戳 */
|
|
423
|
+
timestamp?: number;
|
|
424
|
+
/** 查询条数 */
|
|
425
|
+
limit?: number;
|
|
426
|
+
}
|
|
427
|
+
/** @interface QChatChannelGetExistingWhiteBlackRolesParam */
|
|
428
|
+
export interface QChatChannelGetExistingWhiteBlackRolesParam {
|
|
429
|
+
/** 服务器ID */
|
|
430
|
+
server_id?: string;
|
|
431
|
+
/** 频道ID */
|
|
432
|
+
channel_id?: string;
|
|
433
|
+
/** 白/黑名单类型 */
|
|
434
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
435
|
+
/** 身份组id列表 */
|
|
436
|
+
role_ids?: Array<string>;
|
|
437
|
+
}
|
|
438
|
+
/** @interface QChatChannelGetExistingWhiteBlackMembersParam */
|
|
439
|
+
export interface QChatChannelGetExistingWhiteBlackMembersParam {
|
|
440
|
+
/** 服务器ID */
|
|
441
|
+
server_id?: string;
|
|
442
|
+
/** 频道ID */
|
|
443
|
+
channel_id?: string;
|
|
444
|
+
/** 白/黑名单类型 */
|
|
445
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
446
|
+
/** 用户accid列表 */
|
|
447
|
+
accids?: Array<string>;
|
|
448
|
+
}
|
|
449
|
+
/** @interface QChatChannelSearchPageParam */
|
|
450
|
+
export interface QChatChannelSearchPageParam {
|
|
451
|
+
/** 服务器 id, 若为空则表示在所有服务器下可见频道中搜索 */
|
|
452
|
+
server_id?: string;
|
|
453
|
+
/** 搜索内容 */
|
|
454
|
+
keyword?: string;
|
|
455
|
+
/** 起始时间 */
|
|
456
|
+
start_time?: number;
|
|
457
|
+
/** 结束时间 */
|
|
458
|
+
end_time?: number;
|
|
459
|
+
/** 排序规则 */
|
|
460
|
+
order?: NIMQChatSearchOrder;
|
|
461
|
+
/** 排序条件 */
|
|
462
|
+
sort?: NIMQChatChannelSearchSort;
|
|
463
|
+
/** 查询条数 */
|
|
464
|
+
limit?: number;
|
|
465
|
+
/** 查询游标, 查询的起始位置 */
|
|
466
|
+
cursor?: string;
|
|
467
|
+
}
|
|
468
|
+
/** @interface QChatChannelMemberSearchParam */
|
|
469
|
+
export interface QChatChannelMemberSearchParam {
|
|
470
|
+
/** 服务器 id */
|
|
471
|
+
server_id?: string;
|
|
472
|
+
/** 频道 id */
|
|
473
|
+
channel_id?: string;
|
|
474
|
+
/** 搜索内容 */
|
|
475
|
+
keyword?: string;
|
|
476
|
+
/** 查询条数 */
|
|
477
|
+
limit?: number;
|
|
478
|
+
}
|
|
479
|
+
/** @interface QChatChannelCategoryCreateParam */
|
|
480
|
+
export interface QChatChannelCategoryCreateParam {
|
|
481
|
+
/** 服务器 id */
|
|
482
|
+
server_id?: string;
|
|
483
|
+
/** 名称 */
|
|
484
|
+
name?: string;
|
|
485
|
+
/** 自定义字段 */
|
|
486
|
+
custom?: string;
|
|
487
|
+
/** 查看模式 */
|
|
488
|
+
view_mode?: NIMQChatChannelViewMode;
|
|
489
|
+
}
|
|
490
|
+
/** @interface QChatChannelCategoryRemoveParam */
|
|
491
|
+
export interface QChatChannelCategoryRemoveParam {
|
|
492
|
+
/** 频道分组 ID */
|
|
493
|
+
category_id?: string;
|
|
494
|
+
}
|
|
495
|
+
/** @interface QChatChannelCategoryUpdateParam */
|
|
496
|
+
export interface QChatChannelCategoryUpdateParam {
|
|
497
|
+
/** 分组 id */
|
|
498
|
+
category_id?: string;
|
|
499
|
+
/** 名称 */
|
|
500
|
+
name?: string;
|
|
501
|
+
/** 自定义字段 */
|
|
502
|
+
custom?: string;
|
|
503
|
+
/** 查看模式 */
|
|
504
|
+
view_mode?: NIMQChatChannelViewMode;
|
|
505
|
+
}
|
|
506
|
+
/** @interface QChatChannelGetCategoriesByIDParam */
|
|
507
|
+
export interface QChatChannelGetCategoriesByIDParam {
|
|
508
|
+
/** 分组ID列表 */
|
|
509
|
+
category_ids?: Array<string>;
|
|
510
|
+
}
|
|
511
|
+
/** @interface QChatChannelGetCategoriesPageParam */
|
|
512
|
+
export interface QChatChannelGetCategoriesPageParam {
|
|
513
|
+
/** 服务器 id */
|
|
514
|
+
server_id?: string;
|
|
515
|
+
/** 时间戳 */
|
|
516
|
+
timestamp?: number;
|
|
517
|
+
/** 查询条数 */
|
|
518
|
+
limit?: number;
|
|
519
|
+
}
|
|
520
|
+
/** @interface QChatChannelGetCategoryChannelsPageParam */
|
|
521
|
+
export interface QChatChannelGetCategoryChannelsPageParam {
|
|
522
|
+
/** 服务器 id */
|
|
523
|
+
server_id?: string;
|
|
524
|
+
/** 分组 id */
|
|
525
|
+
category_id?: string;
|
|
526
|
+
/** 时间戳 */
|
|
527
|
+
timestamp?: number;
|
|
528
|
+
/** 查询条数 */
|
|
529
|
+
limit?: number;
|
|
530
|
+
}
|
|
531
|
+
/** @interface QChatChannelCategoryUpdateWhiteBlackRoleParam */
|
|
532
|
+
export interface QChatChannelCategoryUpdateWhiteBlackRoleParam {
|
|
533
|
+
/** 服务器 id */
|
|
534
|
+
server_id?: string;
|
|
535
|
+
/** 分组 id */
|
|
536
|
+
category_id?: string;
|
|
537
|
+
/** 身份组 id */
|
|
538
|
+
role_id?: string;
|
|
539
|
+
/** 白/黑名单类型 */
|
|
540
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
541
|
+
/** 操作类型 */
|
|
542
|
+
ope_type?: NIMQChatChannelWhiteBlackOpeType;
|
|
543
|
+
}
|
|
544
|
+
/** @interface QChatChannelCategoryGetWhiteBlackRolesPageParam */
|
|
545
|
+
export interface QChatChannelCategoryGetWhiteBlackRolesPageParam {
|
|
546
|
+
/** 获取频道分组白/黑名单身份组回调 */
|
|
547
|
+
cb?: ChannelCategoryGetWhiteBlackRolesPageCallback;
|
|
548
|
+
/** 服务器 ID */
|
|
549
|
+
server_id?: string;
|
|
550
|
+
/** 分组ID */
|
|
551
|
+
category_id?: string;
|
|
552
|
+
/** 白/黑名单类型 */
|
|
553
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
554
|
+
/** 时间戳 */
|
|
555
|
+
timestamp?: number;
|
|
556
|
+
/** 查询条数 */
|
|
557
|
+
limit?: number;
|
|
558
|
+
}
|
|
559
|
+
/** @interface QChatChannelCategoryGetExistingWhiteBlackRolesParam */
|
|
560
|
+
export interface QChatChannelCategoryGetExistingWhiteBlackRolesParam {
|
|
561
|
+
/** 获取频道分组白/黑名单身份组回调 */
|
|
562
|
+
cb?: ChannelCategoryGetExistingWhiteBlackRolesCallback;
|
|
563
|
+
/** 服务器 ID */
|
|
564
|
+
server_id?: string;
|
|
565
|
+
/** 分组ID */
|
|
566
|
+
category_id?: string;
|
|
567
|
+
/** 白/黑名单类型 */
|
|
568
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
569
|
+
/** 身份组ID列表 */
|
|
570
|
+
role_ids?: Array<string>;
|
|
571
|
+
}
|
|
572
|
+
/** @interface QChatChannelCategoryUpdateWhiteBlackMembersParam */
|
|
573
|
+
export interface QChatChannelCategoryUpdateWhiteBlackMembersParam {
|
|
574
|
+
/** 更新频道分组白/黑名单成员回调 */
|
|
575
|
+
cb?: ChannelCategoryUpdateWhiteBlackMembersCallback;
|
|
576
|
+
/** 服务器 ID */
|
|
577
|
+
server_id?: string;
|
|
578
|
+
/** 分组ID */
|
|
579
|
+
category_id?: string;
|
|
580
|
+
/** 成员ID列表 */
|
|
581
|
+
accids?: Array<string>;
|
|
582
|
+
/** 白/黑名单类型 */
|
|
583
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
584
|
+
/** 操作类型 */
|
|
585
|
+
ope_type?: NIMQChatChannelWhiteBlackOpeType;
|
|
586
|
+
}
|
|
587
|
+
/** @interface QChatChannelCategoryGetWhiteBlackMembersPageParam */
|
|
588
|
+
export interface QChatChannelCategoryGetWhiteBlackMembersPageParam {
|
|
589
|
+
/** 获取频道分组白/黑名单成员回调 */
|
|
590
|
+
cb?: ChannelCategoryGetWhiteBlackMembersPageCallback;
|
|
591
|
+
/** 服务器 ID */
|
|
592
|
+
server_id?: string;
|
|
593
|
+
/** 分组ID */
|
|
594
|
+
category_id?: string;
|
|
595
|
+
/** 白/黑名单类型 */
|
|
596
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
597
|
+
/** 时间戳 */
|
|
598
|
+
timestamp?: number;
|
|
599
|
+
/** 查询条数 */
|
|
600
|
+
limit?: number;
|
|
601
|
+
}
|
|
602
|
+
/** @interface QChatChannelCategoryGetExistingWhiteBlackMembersParam */
|
|
603
|
+
export interface QChatChannelCategoryGetExistingWhiteBlackMembersParam {
|
|
604
|
+
/** 获取频道分组白/黑名单成员回调 */
|
|
605
|
+
cb?: ChannelCategoryGetExistingWhiteBlackMembersCallback;
|
|
606
|
+
/** 服务器 ID */
|
|
607
|
+
server_id?: string;
|
|
608
|
+
/** 分组ID */
|
|
609
|
+
category_id?: string;
|
|
610
|
+
/** 白/黑名单类型 */
|
|
611
|
+
type?: NIMQChatChannelWhiteBlackType;
|
|
612
|
+
/** 成员ID列表 */
|
|
613
|
+
accids?: Array<string>;
|
|
614
|
+
}
|
|
615
|
+
/** @interface QChatChannelUpdateRTCInfoParam */
|
|
616
|
+
export interface QChatChannelUpdateRTCInfoParam {
|
|
617
|
+
/** 修改RTC频道参数回调 */
|
|
618
|
+
cb?: ChannelUpdateRTCInfoCallback;
|
|
619
|
+
/** 服务器 ID */
|
|
620
|
+
server_id?: string;
|
|
621
|
+
/** 频道 ID */
|
|
622
|
+
channel_id?: string;
|
|
623
|
+
/** RTC频道参数 */
|
|
624
|
+
rtc_info?: QChatChannelRTCInfo;
|
|
625
|
+
}
|
|
626
|
+
/** @interface QChatChannelGetRTCInfoParam */
|
|
627
|
+
export interface QChatChannelGetRTCInfoParam {
|
|
628
|
+
/** 查询RTC频道参数回调 */
|
|
629
|
+
cb?: ChannelGetRTCInfoCallback;
|
|
630
|
+
/** 服务器 ID */
|
|
631
|
+
server_id?: string;
|
|
632
|
+
/** 频道 ID */
|
|
633
|
+
channel_id?: string;
|
|
634
|
+
}
|
|
635
|
+
/** @interface QChatChannelGetRTCOnlineMembersParam */
|
|
636
|
+
export interface QChatChannelGetRTCOnlineMembersParam {
|
|
637
|
+
/** 获取RTC在线成员列表回调 */
|
|
638
|
+
cb?: ChannelGetRTCOnlineMembersCallback;
|
|
639
|
+
/** 服务器 ID */
|
|
640
|
+
server_id?: string;
|
|
641
|
+
/** 频道 ID */
|
|
642
|
+
channel_id?: string;
|
|
643
|
+
}
|