node-nim 9.15.6 → 9.16.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.
@@ -1,300 +0,0 @@
1
- declare enum V2NIMErrorCode {
2
- /** 未知错误 */
3
- V2NIM_ERROR_CODE_UNKNOWN = 0,
4
- /** 通用错误 */
5
- V2NIM_ERROR_CODE_GENERAL = 1,
6
- /** 使用姿势错误 */
7
- V2NIM_ERROR_CODE_MISUSE = 2,
8
- /** 操作取消 */
9
- V2NIM_ERROR_CODE_CANCELLED = 3,
10
- /** 回调错误 */
11
- V2NIM_ERROR_CODE_CALLBACK = 4,
12
- /** 非法状态 */
13
- V2NIM_ERROR_CODE_ILLEGAL_STATE = 5,
14
- /** 参数错误 */
15
- V2NIM_ERROR_CODE_INVALID_PARAMETER = 6,
16
- /** 连接错误 */
17
- V2NIM_ERROR_CODE_CONNECT_FAILED = 7,
18
- /** 连接断开 */
19
- V2NIM_ERROR_CODE_DISCONNECT = 8,
20
- /** 成功 */
21
- V2NIM_ERROR_CODE_SUCCESS = 200,
22
- /** 客户端版本错误, 需要升级sdk */
23
- V2NIM_ERROR_CODE_CLIENT_VERSION_ERROR = 201,
24
- /** 用户被封禁 */
25
- V2NIM_ERROR_CODE_USER_BANNED = 301,
26
- /** 用户名或密码错误 */
27
- V2NIM_ERROR_CODE_INVALID_ACCOUNT_OR_TOKEN = 302,
28
- /** 账号不存在 */
29
- V2NIM_ERROR_CODE_ACCOUNT_NOT_EXIST = 305,
30
- /** token 失效 */
31
- V2NIM_ERROR_CODE_TOKEN_EXPIRED = 306,
32
- /** IP 限制 */
33
- V2NIM_ERROR_CODE_RESTRICTED_IP = 315,
34
- /** 客户端版本低, 禁止登陆 */
35
- V2NIM_ERROR_CODE_LOW_SDK_VERSION = 317,
36
- /** 域名不存在 */
37
- V2NIM_ERROR_CODE_DOMAIN_NOT_EXIST = 320,
38
- /** 域名被禁用 */
39
- V2NIM_ERROR_CODE_DOMAIN_BANNED = 321,
40
- /** 请求临时禁止 */
41
- V2NIM_ERROR_CODE_REQUEST_TEMPRARY_FORBIDDEN = 398,
42
- /** 请求目标单元错误 */
43
- V2NIM_ERROR_CODE_REQUEST_TARGET_UNIT_ERROR = 399,
44
- /** 非法操作或没有权限 */
45
- V2NIM_ERROR_CODE_FORBIDDEN = 403,
46
- /** 对象不存在 */
47
- V2NIM_ERROR_CODE_NOT_FOUND = 404,
48
- /** 客户端请求超时 */
49
- V2NIM_ERROR_CODE_REQUEST_TIMEOUT = 408,
50
- /** 参数错误 */
51
- V2NIM_ERROR_CODE_PARAMETER_ERROR = 414,
52
- /** 客户端网络问题 */
53
- V2NIM_ERROR_CODE_NETWORK_ERROR = 415,
54
- /** 频率控制, 调用频率超过接口限制 */
55
- V2NIM_ERROR_CODE_FREQUNENCY_LIMIT = 416,
56
- /** 重复操作 */
57
- V2NIM_ERROR_CODE_REPEATED_OPERATION = 417,
58
- /** 账号被禁用 */
59
- V2NIM_ERROR_CODE_ACCOUNT_BLOCKED = 422,
60
- /** 服务器内部错误 */
61
- V2NIM_ERROR_CODE_SERVER_INTERNAL_ERROR = 500,
62
- /** 数据库操作失败 */
63
- V2NIM_ERROR_CODE_DB_OPERATION_FAILED = 501,
64
- /** 服务器繁忙 */
65
- V2NIM_ERROR_CODE_SERVER_BUSY = 503,
66
- /** 无效协议 */
67
- V2NIM_ERROR_CODE_INVALID_PROTOCOL = 509,
68
- /** App 不可达 */
69
- V2NIM_ERROR_CODE_APP_UNREACHABLE = 511,
70
- /** 服务不可用 */
71
- V2NIM_ERROR_CODE_SERVICE_UNAVAILABLE = 514,
72
- /** 协议被黑洞规则过滤 */
73
- V2NIM_ERROR_CODE_PROTOCOL_BLACKHOLE_FILTERED = 599,
74
- /** appid 没有权限调用该协议 */
75
- V2NIM_ERROR_CODE_NO_PERMISSION = 997,
76
- /** 解包错误 */
77
- V2NIM_ERROR_CODE_UNPACK_ERROR = 998,
78
- /** 打包错误 */
79
- V2NIM_ERROR_CODE_PACK_ERROR = 999
80
- }
81
- declare enum V2NIMIPProtocolVersion {
82
- /** 未指定, 自动判断 */
83
- V2NIM_IP_PROTOCOL_VERSION_UNSPECIFIED = 0,
84
- /** IPv4 */
85
- V2NIM_IP_PROTOCOL_VERSION_IPV4 = 1,
86
- /** IPv6 */
87
- V2NIM_IP_PROTOCOL_VERSION_IPV6 = 2
88
- }
89
- declare enum V2NIMAsymmetricEncryptionAlgorithm {
90
- /** RSA */
91
- V2NIM_ASYMMETRIC_ENCRYPTION_ALGORITHM_RSA = 1,
92
- /** SM2 */
93
- V2NIM_ASYMMETRIC_ENCRYPTION_ALGORITHM_SM2 = 2
94
- }
95
- declare enum V2NIMSymmetricEncryptionAlgorithm {
96
- /** RC4 */
97
- V2NIM_SYMMETRIC_ENCRYPTION_ALGORITHM_RC4 = 1,
98
- /** AES128 */
99
- V2NIM_SYMMETRIC_ENCRYPTION_ALGORITHM_AES128 = 2,
100
- /** SM4 */
101
- V2NIM_SYMMETRIC_ENCRYPTION_ALGORITHM_SM4 = 4
102
- }
103
- declare enum V2NIMSDKLogLevel {
104
- /** 致命 */
105
- V2NIM_SDK_LOG_LEVEL_FATAL = 1,
106
- /** 错误 */
107
- V2NIM_SDK_LOG_LEVEL_ERROR = 2,
108
- /** 警告 */
109
- V2NIM_SDK_LOG_LEVEL_WARN = 3,
110
- /** 应用 */
111
- V2NIM_SDK_LOG_LEVEL_APP = 5,
112
- /** 调试 */
113
- V2NIM_SDK_LOG_LEVEL_PRO = 6
114
- }
115
- declare enum V2NIMFCSAuthType {
116
- /** refer 鉴权 */
117
- V2NIM_FCS_AUTH_TYPE_REFER = 1,
118
- /** 基于时间的 token 鉴权 */
119
- V2NIM_FCS_AUTH_TYPE_TIME_TOKEN = 2,
120
- /** 基于 url 的 token 鉴权 */
121
- V2NIM_FCS_AUTH_TYPE_URL_TOKEN = 3,
122
- /** custom 鉴权 */
123
- V2NIM_FCS_AUTH_TYPE_CUSTOM = 4
124
- }
125
- declare enum V2NIMErrorSource {
126
- /** 未知来源 */
127
- V2NIM_ERROR_SOURCE_UNKNOWN = 0,
128
- /** 协议错误来源 */
129
- V2NIM_ERROR_SOURCE_PROTOCOL = 1,
130
- /** 本地错误来源 */
131
- V2NIM_ERROR_SOURCE_LOCAL = 2
132
- }
133
- declare enum V2NIMConversationType {
134
- /** 未知 */
135
- V2NIM_CONVERSATION_TYPE_UNKNOWN = 0,
136
- /** 单聊 */
137
- V2NIM_CONVERSATION_TYPE_P2P = 1,
138
- /** 群聊 */
139
- V2NIM_CONVERSATION_TYPE_TEAM = 2,
140
- /** 超大群 */
141
- V2NIM_CONVERSATION_TYPE_SUPER_TEAM = 3,
142
- /** 聊天室 */
143
- V2NIM_CONVERSATION_TYPE_CHATROOM = 4
144
- }
145
- declare enum V2NIMMessageType {
146
- /** 文本 */
147
- V2NIM_MESSAGE_TYPE_TEXT = 0,
148
- /** 图片 */
149
- V2NIM_MESSAGE_TYPE_IMAGE = 1,
150
- /** 语音 */
151
- V2NIM_MESSAGE_TYPE_AUDIO = 2,
152
- /** 视频 */
153
- V2NIM_MESSAGE_TYPE_VIDEO = 3,
154
- /** 位置 */
155
- V2NIM_MESSAGE_TYPE_LOCATION = 4,
156
- /** 通知 */
157
- V2NIM_MESSAGE_TYPE_NOTIFICATION = 5,
158
- /** 文件 */
159
- V2NIM_MESSAGE_TYPE_FILE = 6,
160
- /** 提醒 */
161
- V2NIM_MESSAGE_TYPE_TIP = 10,
162
- /** 机器人 */
163
- V2NIM_MESSAGE_TYPE_ROBOT = 11,
164
- /** 话单 */
165
- V2NIM_MESSAGE_TYPE_CALL = 12,
166
- /** 自定义 */
167
- V2NIM_MESSAGE_TYPE_CUSTOM = 100
168
- }
169
- declare enum V2NIMMessageState {
170
- /** 默认 */
171
- V2NIM_MESSAGE_STATE_DEFAULT = 0,
172
- /** 已删除 */
173
- V2NIM_MESSAGE_STATE_DELETED = 1,
174
- /** 已撤回 */
175
- V2NIM_MESSAGE_STATE_REVOKED = 2
176
- }
177
- declare enum V2NIMMessageSendState {
178
- /** 未知, 如果消息不是从这个端发送的 */
179
- V2NIM_MESSAGE_SEND_STATE_UNKNOWN = 0,
180
- /** 已发送 */
181
- V2NIM_MESSAGE_SEND_STATE_SENT = 1,
182
- /** 发送失败 */
183
- V2NIM_MESSAGE_SEND_STATE_FAILED = 2,
184
- /** 发送中 */
185
- V2NIM_MESSAGE_SEND_STATE_SENDING = 3
186
- }
187
- declare enum V2NIMMessageAttachmentUploadState {
188
- /** 未知, 不存在附件或不需要上传的附件 */
189
- V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_UNKNOWN = 0,
190
- /** 上传成功, 存在存储地址 */
191
- V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_SUCCEED = 1,
192
- /** 上传失败 */
193
- V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_FAILED = 2,
194
- /** 上传中 */
195
- V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_UPLOADING = 3
196
- }
197
- declare enum V2NIMMessageAttachmentDownloadState {
198
- /** 未知, 不存在附件或不需要下载的附件 */
199
- V2NIM_MESSAGE_ATTACHMENT_DOWNLOAD_STATE_UNKNOWN = 0,
200
- /** 下载成功 */
201
- V2NIM_MESSAGE_ATTACHMENT_DOWNLOAD_STATE_SUCCEED = 1,
202
- /** 下载失败 */
203
- V2NIM_MESSAGE_ATTACHMENT_DOWNLOAD_STATE_FAILED = 2,
204
- /** 下载中 */
205
- V2NIM_MESSAGE_ATTACHMENT_DOWNLOAD_STATE_DOWNLOADING = 3
206
- }
207
- declare enum V2NIMMessageAttachmentLocalState {
208
- /** 未知 */
209
- V2NIM_MESSAGE_ATTACHMENT_LOCAL_STATE_UNKNOWN = 0,
210
- /** 已播放 */
211
- V2NIM_MESSAGE_ATTACHMENT_LOCAL_STATE_PLAYED = 1
212
- }
213
- declare enum V2NIMLoginAuthType {
214
- /** 默认 */
215
- V2NIM_LOGIN_AUTH_TYPE_DEFAULT = 0,
216
- /** 动态token */
217
- V2NIM_LOGIN_AUTH_TYPE_DYNAMIC_TOKEN = 1,
218
- /** 第三方 */
219
- V2NIM_LOGIN_AUTH_TYPE_THIRD_PARTY = 2
220
- }
221
- declare enum V2NIMLoginClientType {
222
- /** 未知类型 */
223
- V2NIM_LOGIN_CLIENT_TYPE_UNKNOWN = 0,
224
- /** Android */
225
- V2NIM_LOGIN_CLIENT_TYPE_ANDROID = 1,
226
- /** iOS */
227
- V2NIM_LOGIN_CLIENT_TYPE_IOS = 2,
228
- /** PC */
229
- V2NIM_LOGIN_CLIENT_TYPE_PC = 4,
230
- /** Windows Phone */
231
- V2NIM_LOGIN_CLIENT_TYPE_WP = 8,
232
- /** WEB */
233
- V2NIM_LOGIN_CLIENT_TYPE_WEB = 16,
234
- /** REST API */
235
- V2NIM_LOGIN_CLIENT_TYPE_RESTFUL = 32
236
- }
237
- declare enum V2NIMLoginStatus {
238
- /** 未登录 */
239
- V2NIM_LOGIN_STATUS_LOGOUT = 0,
240
- /** 已登录 */
241
- V2NIM_LOGIN_STATUS_LOGINED = 1,
242
- /** 登录中 */
243
- V2NIM_LOGIN_STATUS_LOGINING = 2
244
- }
245
- declare enum V2NIMKickedOfflineReason {
246
- /** 多端登录互踢 */
247
- V2NIM_KICKED_OFFLINE_REASON_CLIENT_EXCLUSIVE = 1,
248
- /** 被服务器踢下线 */
249
- V2NIM_KICKED_OFFLINE_REASON_SERVER = 2,
250
- /** 被客户端踢下线 */
251
- V2NIM_KICKED_OFFLINE_REASON_CLIENT = 3
252
- }
253
- declare enum V2NIMLoginClientChange {
254
- /** 端列表刷新 */
255
- V2NIM_LOGIN_CLIENT_CHANGE_LIST = 1,
256
- /** 端登录 */
257
- V2NIM_LOGIN_CLIENT_CHANGE_LOGIN = 2,
258
- /** 端登出 */
259
- V2NIM_LOGIN_CLIENT_CHANGE_LOGOUT = 3
260
- }
261
- declare enum V2NIMConnectStatus {
262
- /** 未连接 */
263
- V2NIM_CONNECT_STATUS_DISCONNECTED = 0,
264
- /** 已连接 */
265
- V2NIM_CONNECT_STATUS_CONNECTED = 1,
266
- /** 连接中 */
267
- V2NIM_CONNECT_STATUS_CONNECTING = 2,
268
- /** 等待重连 */
269
- V2NIM_CONNECT_STATUS_WAITING = 3
270
- }
271
- declare enum V2NIMDataSyncLevel {
272
- /** 完全同步 */
273
- V2NIM_DATA_SYNC_LEVEL_FULL = 0,
274
- /** 只同步基础数据 */
275
- V2NIM_DATA_SYNC_LEVEL_BASIC = 1
276
- }
277
- declare enum V2NIMDataSyncType {
278
- /** 同步主数据 */
279
- V2NIM_DATA_SYNC_MAIN = 1,
280
- /** 同步群组成员 */
281
- V2NIM_DATA_SYNC_TEAM_MEMBER = 2,
282
- /** 同步超大群组成员 */
283
- V2NIM_DATA_SYNC_SUPER_TEAM_MEMBER = 3
284
- }
285
- declare enum V2NIMDataSyncState {
286
- /** 等待同步 */
287
- V2NIM_DATA_SYNC_STATE_WAITING = 0,
288
- /** 开始同步 */
289
- V2NIM_DATA_SYNC_STATE_SYNCING = 1,
290
- /** 同步完成 */
291
- V2NIM_DATA_SYNC_STATE_COMPLETED = 2
292
- }
293
- declare enum V2NIMMixLoginType {
294
- /** IM 业务登录 */
295
- V2NIM_MIX_LOGIN_TYPE_IM = 1,
296
- /** QChat 业务登录 */
297
- V2NIM_MIX_LOGIN_TYPE_QCHAT = 2,
298
- /** IM 和 QChat 业务融合登录 */
299
- V2NIM_MIX_LOGIN_TYPE_IM_AND_QCHAT = 3
300
- }
@@ -1,338 +0,0 @@
1
- export interface V2NIMError {
2
- /** 错误来源 */
3
- source?: V2NIMErrorSource;
4
- /** 错误码 */
5
- code?: V2NIMErrorCode;
6
- /** 错误描述 */
7
- desc?: string;
8
- /** 错误详情 */
9
- detail?: Map<string, string>;
10
- }
11
- export interface V2NIMLinkOption {
12
- /** 是否使用 https */
13
- useHttps?: boolean;
14
- /** 是否为专属集群 */
15
- exclusiveCluster?: boolean;
16
- /** 非对称加密"交换密钥"协议加密算法 */
17
- asymmetricEncryptionAlgorithm?: V2NIMAsymmetricEncryptionAlgorithm;
18
- /** 对称加密通信加密算法 */
19
- symmetricEncryptionAlgorithm?: V2NIMSymmetricEncryptionAlgorithm;
20
- }
21
- export interface V2NIMAttachmentOption {
22
- /** 缩略图宽度 */
23
- thumbnailWidth?: number;
24
- /** 缩略图高度 */
25
- thumbnailHeight?: number;
26
- /** 缩略图质量, 取值范围 [0, 100], 0 表示使用默认值 */
27
- thumbnailQuality?: number;
28
- /** 缩略图文件名模板, 以{filename}为token进行替换 */
29
- thumbnailNameTemplate?: string;
30
- /** 是否开启动图缩略图的支持 */
31
- enableAnimatedImageThumbnail?: boolean;
32
- /** 是否自动下载图片缩略图 */
33
- autoDownloadImageThumb?: boolean;
34
- /** 是否自动下载视频缩略图 */
35
- autoDownloadVideoThumb?: boolean;
36
- /** 是否自动下载图片 */
37
- autoDownloadImage?: boolean;
38
- /** 是否自动下载音频 */
39
- autoDownloadAudio?: boolean;
40
- /** 是否自动下载视频 */
41
- autoDownloadVideo?: boolean;
42
- }
43
- export interface V2NIMFCSOption {
44
- /** 启用融合存储 */
45
- enableFcs?: boolean;
46
- /** 融合存储认证类型 */
47
- fcsAuthType?: V2NIMFCSAuthType;
48
- /** mock refer */
49
- mockRefer?: string;
50
- /** mock ua */
51
- mockUa?: string;
52
- }
53
- export interface V2NIMPrivateServerOption {
54
- /** IP 协议版本 */
55
- ipProtocolVersion?: V2NIMIPProtocolVersion;
56
- /** 是否使用 httpdns */
57
- useHttpdns?: boolean;
58
- /** lbs 地址 */
59
- lbsAddresses?: Array<string>;
60
- /** nos lbs 地址 */
61
- nosLbsAddress?: string;
62
- /** 默认 link 地址 */
63
- defaultLinkAddress?: string;
64
- /** 默认 ipv6 link 地址 */
65
- defaultLinkAddressIpv6?: string;
66
- /** 默认 nos 上传地址 */
67
- defaultNosUploadAddress?: string;
68
- /** 默认 nos 上传主机地址 */
69
- defaultNosUploadHost?: string;
70
- /** nos 下载地址拼接模板, 用于拼接最终得到的下载地址 */
71
- nosDownloadAddress?: string;
72
- /** nos 加速域名列表 */
73
- nosAccelerateHosts?: Array<string>;
74
- /** nos 加速地址拼接模板, 用于获得加速后的下载地址 */
75
- nosAccelerateAddress?: string;
76
- /** 探测 ipv4 地址类型使用的 url */
77
- probeIpv4Url?: string;
78
- /** 探测 ipv6 地址类型使用的 url */
79
- probeIpv6Url?: string;
80
- /** 非对称加密密钥 A, RSA: module, SM2: X */
81
- asymmetricEncryptionKeyA?: string;
82
- /** 非对称加密密钥 B, RSA: EXP, SM2: SM2Y */
83
- asymmetricEncryptionKeyB?: string;
84
- /** 非对称加密算法 key 版本号 */
85
- asymmetricEncryptionKeyVersion?: number;
86
- }
87
- export interface V2NIMDatabaseOption {
88
- /** 数据库加密密钥 */
89
- encryptionKey?: string;
90
- /** 是否开启用户数据备份(本地)功能 */
91
- enableBackup?: boolean;
92
- /** 是否开启用户数据恢复(本地)功能 */
93
- enableRestore?: boolean;
94
- /** 用户数据备份(本地)目录, 缺省在数据文件所在目录创建一个dbFile.back目录 */
95
- backupFolder?: string;
96
- }
97
- export interface V2NIMBasicOption {
98
- /** 自定义客户端类型 */
99
- customClientType?: number;
100
- /** 登录自定义信息, 最大 32 个字符 */
101
- customTag?: string;
102
- /** 日志保留天数 */
103
- logReserveDays?: number;
104
- /** SDK日志级别 */
105
- sdkLogLevel?: V2NIMSDKLogLevel;
106
- /** 是否禁用 macOS 下的 App Nap 功能 */
107
- disableAppNap?: boolean;
108
- }
109
- export interface V2NIMInitOption {
110
- /** app key */
111
- appkey?: string;
112
- /** app数据目录, 为空则使用默认目录 */
113
- appDataPath?: string;
114
- /** 基础配置 */
115
- basicOption?: V2NIMBasicOption;
116
- /** 连接相关配置 */
117
- linkOption?: V2NIMLinkOption;
118
- /** 数据库配置 */
119
- databaseOption?: V2NIMDatabaseOption;
120
- /** 附件配置 */
121
- attachmentOption?: V2NIMAttachmentOption;
122
- /** 融合存储配置 */
123
- fcsOption?: V2NIMFCSOption;
124
- /** 私有化配置 */
125
- privateServerOption?: V2NIMPrivateServerOption;
126
- }
127
- export interface V2NIMMessageAttachment {
128
- /** 存储 url */
129
- url?: string;
130
- /** 显示名 */
131
- name?: string;
132
- /** md5 */
133
- md5?: string;
134
- /** 数据长度 */
135
- length?: string;
136
- /** 上传状态 */
137
- uploadState?: V2NIMMessageAttachmentUploadState;
138
- /** 下载状态 */
139
- downloadState?: V2NIMMessageAttachmentDownloadState;
140
- }
141
- export interface V2NIMMessagePushOption {
142
- /** 推送文本 */
143
- content?: string;
144
- /** 推送数据 */
145
- payload?: string;
146
- /** 是否强制推送, 忽略用户消息提醒相关设置 */
147
- forcePush?: boolean;
148
- /** 推送文本 */
149
- forcePushContent?: string;
150
- /** 推送目标账号列表 */
151
- forcePushAccountIds?: Array<string>;
152
- }
153
- export interface V2NIMMessageAntiSpamOption {
154
- /** 易盾反作弊(辅助检测数据), json格式, 限制长度1024 */
155
- yidunAntiCheating?: string;
156
- /** 易盾反垃圾(辅助检测数据), json格式, 限制长度1024 */
157
- yidunAntiSpam?: string;
158
- /** 自定义消息中需要反垃圾的内容(仅当消息类型为自定义消息时有效) */
159
- customMessageAntiSpamContent?: string;
160
- /** 指定易盾业务id, 而不使用云信后台配置的 */
161
- yidunBusinessId?: string;
162
- /** 指定不需要易盾反垃圾(仅开通易盾时有效) */
163
- yidunAntiSpamDisabled?: boolean;
164
- }
165
- export interface V2NIMMessageConfig {
166
- /** 是否不需要在服务端保存历史消息 */
167
- historyDisabled?: boolean;
168
- /** 是否不需要漫游消息 */
169
- roamingDisabled?: boolean;
170
- /** 是否不需要离线消息 */
171
- offlineDisabled?: boolean;
172
- /** 是否不需要发送方多端在线同步消息 */
173
- senderSyncDisabled?: boolean;
174
- /** 是否不需要更新消息所属的会话信息 */
175
- conversationUpdateDisabled?: boolean;
176
- /** 是否不需要推送消息 */
177
- pushDisabled?: boolean;
178
- /** 是否不需要推送消息未读角标计数 */
179
- pushBadgeDisabled?: boolean;
180
- /** 是否不需要推送消息发送者昵称 */
181
- pushNickDisabled?: boolean;
182
- /** 是否需要群消息已读回执信息 */
183
- teamReceiptEnabled?: boolean;
184
- /** 是否不需要路由消息 */
185
- routeDisabled?: boolean;
186
- }
187
- export interface V2NIMMessageRefer {
188
- /** 发送方账号 */
189
- senderAccountId?: string;
190
- /** 接收方账号 */
191
- receiverAccountId?: string;
192
- /** 客户端消息 id */
193
- clientId?: string;
194
- /** 服务端消息 id */
195
- serverId?: string;
196
- /** 消息时间 */
197
- time?: number;
198
- }
199
- export interface V2NIMMessageQueryTime {
200
- /** 起始时间 */
201
- begin?: number;
202
- /** 结束时间 */
203
- end?: number;
204
- /** 包含起始时间 */
205
- includeBegin?: boolean;
206
- /** 包含结束时间 */
207
- includeEnd?: boolean;
208
- }
209
- export interface V2NIMMessageUpdatedInfo {
210
- /** 消息状态 */
211
- state?: V2NIMMessageState;
212
- /** 服务端扩展信息 */
213
- serverExtension?: string;
214
- /** 客户端本地扩展信息 */
215
- localExtension?: string;
216
- }
217
- export interface V2NIMMessage {
218
- /** 会话标识 */
219
- conversationId?: string;
220
- /** 客户端消息 id */
221
- clientId?: string;
222
- /** 服务端消息 id */
223
- serverId?: string;
224
- /** 消息时间 */
225
- time?: number;
226
- /** 发送方账号 */
227
- senderAccountId?: string;
228
- /** 接收方账号 */
229
- receiverAccountId?: string;
230
- /** 消息类型 */
231
- type?: V2NIMMessageType;
232
- /** 消息子类型 */
233
- subType?: number;
234
- /** 消息文本 */
235
- text?: string;
236
- /** 附件 */
237
- attachment?: V2NIMMessageAttachment;
238
- /** 服务端扩展信息 */
239
- serverExtension?: string;
240
- /** 客户端本地扩展信息 */
241
- localExtension?: string;
242
- /** 发送状态 */
243
- sendState?: V2NIMMessageSendState;
244
- /** 附件上传状态 */
245
- attachmentUploadState?: V2NIMMessageAttachmentUploadState;
246
- /** 附件下载状态 */
247
- attachmentDownloadState?: V2NIMMessageAttachmentDownloadState;
248
- /** 消息状态 */
249
- state?: V2NIMMessageState;
250
- /** 推送相关 */
251
- pushOption?: V2NIMMessagePushOption;
252
- /** 反垃圾相关 */
253
- antiSpamOption?: V2NIMMessageAntiSpamOption;
254
- /** 设置相关 */
255
- config?: V2NIMMessageConfig;
256
- /** Thread消息引用 */
257
- threadRefer?: V2NIMMessageRefer;
258
- /** 回复消息引用 */
259
- replyRefer?: V2NIMMessageRefer;
260
- }
261
- export interface V2NIMSendMessageParam {
262
- /** 环境变量,用于指向不同的抄送,第三方回调等配置 */
263
- env?: string;
264
- /** 推送相关 */
265
- pushOption?: V2NIMMessagePushOption;
266
- /** 设置相关 */
267
- config?: V2NIMMessageConfig;
268
- /** 反垃圾相关 */
269
- antiSpamOption?: V2NIMMessageAntiSpamOption;
270
- }
271
- export interface V2NIMSendMessageResult {
272
- /** 第三方回调回来的自定义扩展 */
273
- thirdPartyCallbackExtension?: string;
274
- /** 易盾反垃圾返回的结果 */
275
- yidunAntiSpamResult?: string;
276
- }
277
- export interface V2NIMConversation {
278
- /** 会话标识 */
279
- conversationId?: string;
280
- /** 本地扩展信息 */
281
- localExt?: string;
282
- /** 服务端扩展信息 */
283
- serverExt?: string;
284
- /** 未读计数 */
285
- unreadCount?: number;
286
- /** 会话中最新的消息 */
287
- latestMessage?: V2NIMMessage;
288
- }
289
- /** @brief 动态 token 获取回调 */
290
- /** @param account 账号 */
291
- /** @return token */
292
- export type V2NIMTokenProvider = (account: string) => string;
293
- /** @brief 登陆扩展信息获取回调 */
294
- /** @param account 账号 */
295
- /** @return 登陆扩展信息 */
296
- export type V2NIMLoginExtensionProvider = (account: string) => string;
297
- export interface V2NIMLoginOption {
298
- /** 重试次数 */
299
- retryCount?: number;
300
- /** 强制登录模式 */
301
- forceMode?: boolean;
302
- /** 认证类型 */
303
- authType?: V2NIMLoginAuthType;
304
- /** 动态 token 获取回调 */
305
- tokenProvider?: V2NIMTokenProvider;
306
- /** 登陆扩展信息获取回调 */
307
- loginExtensionProvider?: V2NIMLoginExtensionProvider;
308
- /** 数据同步等级 */
309
- syncLevel?: V2NIMDataSyncLevel;
310
- }
311
- export interface V2NIMLoginClient {
312
- /** 客户端类型 */
313
- type?: V2NIMLoginClientType;
314
- /** 操作系统 */
315
- os?: string;
316
- /** 登录时间 */
317
- timestamp?: number;
318
- /** 自定义信息 */
319
- custom?: string;
320
- /** 自定义类型 */
321
- customClientType?: number;
322
- }
323
- export interface V2NIMKickedOfflineDetail {
324
- /** 原因 */
325
- reason?: V2NIMKickedOfflineReason;
326
- /** 说明 */
327
- reasonDesc?: string;
328
- /** 客户端类型 */
329
- clientType?: V2NIMLoginClientType;
330
- /** 自定义客户端类型 */
331
- customClientType?: number;
332
- }
333
- export interface V2NIMDataSyncDetail {
334
- /** 数据同步类型 */
335
- type?: V2NIMDataSyncType;
336
- /** 数据同步状态 */
337
- state?: V2NIMDataSyncState;
338
- }