@rongcloud/imlib-next 5.5.4 → 5.5.5-beem-alpha.1

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/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { LogLevel, MessageDirection, ReceivedStatus, IReadReceiptInfo, IPushConfig, NotificationStatus, NotificationLevel, IUserProfile, IReceivedMessage, IConversationOption, ITypingMessage, ConnectionStatus, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IReceivedConversation, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IPluginGenerator, IAsyncRes, ConversationType, IBaseConversationInfo, IConversationState, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRemoveChatRoomEntries, IRTCRoomBindOption, MentionedType, IMessageReaderResponse, ITagParam, ITagInfo, IConversationTag, IReceivedConversationByTag, FileType, IUploadAuth, UploadMethod } from '@rongcloud/engine';
2
- export { ChatroomEntryType, ChatroomUserChangeType, ConnectionStatus, ConversationType, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationOption, IConversationState, IConversationTag, IDeletedExpansion, IEventListener, IExpansionListenerData, IGetUltraGroupListOption, IGooglePushConfig, ILogExtensions, ILogInfo, ILogInit, IMessageReader, IMessageReaderResponse, IOperateStatusNotify, IPluginGenerator, IPushConfig, IRTCRoomBindOption, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, ITagInfo, ITagParam, ITypingMessage, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IiOSPushConfig, LogLevel, LogSource, LogTagId, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, ReceivedStatus, UltraGroupChannelType, UploadMethod, logger } from '@rongcloud/engine';
1
+ import { LogLevel, MessageDirection, ReceivedStatus, IReadReceiptInfo, IPushConfig, ConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUserProfile, IReceivedMessage, IConversationOption, ITypingMessage, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IReceivedConversation, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, ConversationType, IBaseConversationInfo, IConversationState, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRemoveChatRoomEntries, IRTCRoomBindOption, MentionedType, IMessageReaderResponse, ITagParam, ITagInfo, IConversationTag, IReceivedConversationByTag, FileType, IUploadAuth, UploadMethod } from '@rongcloud/engine';
2
+ export { ChatroomEntryType, ChatroomUserChangeType, ConnectionStatus, ConversationType, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationOption, IConversationState, IConversationTag, IDeletedExpansion, IEventListener, IExpansionListenerData, IGetUltraGroupListOption, IGooglePushConfig, IMessageReader, IMessageReaderResponse, IOperateStatusNotify, IPushConfig, IRTCRoomBindOption, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, ITagInfo, ITagParam, ITypingMessage, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IiOSPushConfig, LogLevel, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, ReceivedStatus, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
3
3
 
4
4
  declare enum Events {
5
5
  CONNECTING = "CONNECTING",
@@ -27,6 +27,10 @@ declare enum Events {
27
27
  ULTRA_GROUP_CHANNEL_DELETE = "ULTRA_GROUP_CHANNEL_DELETE",
28
28
  ULTRA_GROUP_CHANNEL_USER_KICKED = "ULTRA_GROUP_CHANNEL_USER_KICKED"
29
29
  }
30
+ /**
31
+ * 发送状态
32
+ * @category Enum
33
+ */
30
34
  declare enum SentStatus {
31
35
  /**
32
36
  * 发送中。
@@ -73,6 +77,7 @@ declare type IInitOption = {
73
77
  navigators?: string[];
74
78
  /**
75
79
  * 连接方式,默认使用 'websocket'
80
+ * @deprecated 自 5.6.0 版本开始,不再支持 Comet 连接,该配置项失效。
76
81
  */
77
82
  connectType?: 'websocket' | 'comet';
78
83
  /**
@@ -91,9 +96,39 @@ declare type IInitOption = {
91
96
  * 七牛上传文件地址域名(仅私有云)
92
97
  */
93
98
  uploadDomain?: string;
99
+ /**
100
+ * 开启后,SDK 内的 HTTP 请求将由 Electron 主进程内发送。
101
+ * @since 5.6.0
102
+ * @description
103
+ * 仅在 Electron 环境中搭配 `@rongcloud/electron-renderer` 与 `@rongcloud/electron` 包时有效。
104
+ * * 当值为 `true` 时,HTTP 请求由 Electron 主进程内发送,不受浏览器安全沙箱策略限制。
105
+ * * 当值为 `false` 时,保持使用 Chromium 的 XMLHttpRequest 发送 HTTP 协议请求,
106
+ * 请求由渲染进程内发出,受浏览器安全沙箱策略限制。
107
+ * @defautl `false`
108
+ */
109
+ httpInMainProcess?: boolean;
110
+ /**
111
+ * TODO: 自定义策略覆盖服务策略有安全风险,等产品确认通用化逻辑,是否前后端共同建立双重开关
112
+ * 目前仅 Beem Web-Meeting 使用
113
+ * @hidden
114
+ * 实时日志收集功能自定义上传策略
115
+ * @param {number} logSwitch 日志收集功能开关,0 关闭;1 开启
116
+ * @param {number} level 日志上传级别
117
+ * @param {number} itv: interval 即日志上传间隔,单位秒,最小时间间隔 1 秒
118
+ */
119
+ logPolicy?: {
120
+ logSwitch?: number;
121
+ level?: number;
122
+ /**
123
+ * 时间间隔不可定制
124
+ * @deprecated
125
+ */
126
+ itv?: number;
127
+ };
94
128
  };
95
129
  /**
96
130
  * 用户收到的消息结构
131
+ * @category Interface
97
132
  */
98
133
  interface IAReceivedMessage {
99
134
  /**
@@ -222,6 +257,9 @@ declare type GetHistoryMessageOption = {
222
257
  */
223
258
  order?: 0 | 1;
224
259
  };
260
+ /**
261
+ * @category Interface
262
+ */
225
263
  interface IGetHistoryMessagesByTypesOption extends GetHistoryMessageOption {
226
264
  /**
227
265
  * 消息类型
@@ -233,6 +271,62 @@ declare type GetHistoryMessageResult = {
233
271
  hasMore: boolean;
234
272
  };
235
273
 
274
+ declare function init(options: IInitOption): void;
275
+ /**
276
+ * 反初始化
277
+ */
278
+ declare function destroy(): Promise<void>;
279
+ /**
280
+ * 获取 IM 连接状态
281
+ * @category 基础
282
+ */
283
+ declare function getConnectionStatus(): ConnectionStatus;
284
+ /**
285
+ * 当前服务器时间
286
+ * 校准时间,可能存在误差
287
+ * @category 基础
288
+ */
289
+ declare function getServerTime(): number;
290
+ /**
291
+ * 获取 IM 连接用户的 id
292
+ * @category 基础
293
+ */
294
+ declare function getCurrentUserId(): string;
295
+ /**
296
+ * (内部方法)用于统计各组件版本信息
297
+ * @param name
298
+ * @param version
299
+ */
300
+ declare function __addSDKVersion(name: string, version: string): void;
301
+ /**
302
+ * 获取 deviceId
303
+ * @category 基础
304
+ */
305
+ declare function getDeviceId(): string;
306
+
307
+ /**
308
+ * 装载 plugin 插件,并返回相应的插件实例,需在调用 `connect` 方法之前使用
309
+ * @category 基础
310
+ * @param plugins
311
+ */
312
+ declare function installPlugin<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
313
+
314
+ /**
315
+ * 建立 IM 连接
316
+ * @category 基础
317
+ * @param token
318
+ * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
319
+ */
320
+ declare function connect(token: string, reconnectKickEnable?: boolean): Promise<IAsyncRes<{
321
+ userId: string;
322
+ }>>;
323
+ /**
324
+ * 断开当前用户的连接
325
+ * @category 基础
326
+ * @description 调用后将不再接收消息,不可发送消息,不可获取历史消息,不可获取会话列表
327
+ */
328
+ declare function disconnect(): Promise<void>;
329
+
236
330
  declare class BaseMessage<T = any> {
237
331
  readonly messageType: string;
238
332
  content: T;
@@ -242,6 +336,9 @@ declare class BaseMessage<T = any> {
242
336
  }
243
337
  declare type MessageConstructor<T> = new (content: T) => BaseMessage<T>;
244
338
 
339
+ /**
340
+ * @category Interface
341
+ */
245
342
  interface IConversationUpdateItem {
246
343
  time: number;
247
344
  val: any;
@@ -256,6 +353,9 @@ declare type MentionedInfo$1 = {
256
353
  */
257
354
  userIdList?: Array<string>;
258
355
  };
356
+ /**
357
+ * @category Interface
358
+ */
259
359
  interface IReceivedUpdateConversation {
260
360
  updatedItems: {
261
361
  [key: string]: IConversationUpdateItem;
@@ -272,6 +372,7 @@ interface IReceivedUpdateConversation {
272
372
  }
273
373
  /**
274
374
  * 用户收到的会话结构
375
+ * @category Interface
275
376
  */
276
377
  interface IAReceivedConversation {
277
378
  /**
@@ -332,6 +433,9 @@ interface IAReceivedConversation {
332
433
  */
333
434
  unreadMentionedCount?: number;
334
435
  }
436
+ /**
437
+ * @category Interface
438
+ */
335
439
  interface ISendMessageOptions {
336
440
  /**
337
441
  * 是否是状态消息,一般为无需注册的自定义消息
@@ -409,6 +513,7 @@ interface ISendMessageOptions {
409
513
  }
410
514
  /**
411
515
  * 文件消息配置
516
+ * @category Interface
412
517
  */
413
518
  interface IUploadMessageOption extends ISendMessageOptions {
414
519
  /**
@@ -421,6 +526,7 @@ interface IUploadMessageOption extends ISendMessageOptions {
421
526
  }
422
527
  /**
423
528
  * 缩略图配置
529
+ * @category Interface
424
530
  */
425
531
  interface IThumbnailConfig {
426
532
  maxHeight?: number;
@@ -430,10 +536,14 @@ interface IThumbnailConfig {
430
536
  }
431
537
  /**
432
538
  * 图片消息配置
539
+ * @category Interface
433
540
  */
434
541
  interface IImageMessageOption extends IUploadMessageOption {
435
542
  thumbnailConfig?: IThumbnailConfig;
436
543
  }
544
+ /**
545
+ * @category Interface
546
+ */
437
547
  interface IInsertOptions {
438
548
  /**
439
549
  * 插入消息是否计入未读数: true 计数 false 不计数, 默认不计数
@@ -444,6 +554,9 @@ interface IInsertOptions {
444
554
  */
445
555
  searchContent?: string;
446
556
  }
557
+ /**
558
+ * @category Interface
559
+ */
447
560
  interface IUserInfo {
448
561
  user?: {
449
562
  /**
@@ -469,18 +582,25 @@ interface IUserInfo {
469
582
  portrait?: string;
470
583
  };
471
584
  }
585
+ /**
586
+ * @category Interface
587
+ */
472
588
  interface IExtraData {
473
589
  /**
474
590
  * 消息中的附加信息
475
591
  */
476
592
  extra?: string;
477
593
  }
594
+ /**
595
+ * @category Interface
596
+ */
478
597
  interface IMessageDesc {
479
598
  messageUId: string;
480
599
  sendTime: number;
481
600
  }
482
601
  /**
483
602
  * 撤回消息 option 参数
603
+ * @category Interface
484
604
  */
485
605
  interface IRecallMessageOptions {
486
606
  /**
@@ -516,6 +636,7 @@ interface IRecallMessageOptions {
516
636
  }
517
637
  /**
518
638
  * 上传过程中的回调钩子
639
+ * @category Interface
519
640
  */
520
641
  interface IUploadHooks {
521
642
  /**
@@ -531,6 +652,7 @@ interface IUploadHooks {
531
652
  }
532
653
  /**
533
654
  * 在时间区间内搜索消息的参数配置
655
+ * @category Interface
534
656
  */
535
657
  interface ISearchMessageInTimeRangeOption {
536
658
  keyword: string;
@@ -605,7 +727,7 @@ declare type EventListeners = {
605
727
  [Events.CONNECTED]: () => void;
606
728
  [Events.DISCONNECT]: (status: ConnectionStatus) => void;
607
729
  [Events.SUSPEND]: (status: ConnectionStatus | ErrorCode) => void;
608
- [Events.MESSAGES]: (event: IMessagesEvent) => void;
730
+ [Events.MESSAGES]: (messages: IMessagesEvent) => void;
609
731
  [Events.READ_RECEIPT_RECEIVED]: (event: IReadReceiptReceivedEvent) => void;
610
732
  [Events.MESSAGE_RECEIPT_REQUEST]: (event: IMessageReceiptRequestEvent) => void;
611
733
  [Events.MESSAGE_RECEIPT_RESPONSE]: (event: IMessageReceiptResponseEvent) => void;
@@ -626,70 +748,39 @@ declare type EventListeners = {
626
748
  [Events.ULTRA_GROUP_CHANNEL_DELETE]: (list: IUltraChannelDeleteInfo[]) => void;
627
749
  [Events.ULTRA_GROUP_CHANNEL_USER_KICKED]: (list: IUltraChannelUserKickedInfo[]) => void;
628
750
  };
629
- /**
630
- * 初始化
631
- * @param initOption
632
- */
633
- declare const init: (initOption: IInitOption) => void;
634
- /**
635
- * 装载 plugin 插件,并返回相应的插件实例,需在调用 `connect` 方法之前使用
636
- * @param plugins
637
- */
638
- declare function installPlugin<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
639
- /**
640
- * 建立 IM 连接
641
- * @param token
642
- * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
643
- */
644
- declare function connect(token: string, reconnectKickEnable?: boolean): Promise<IAsyncRes<{
645
- userId: string;
646
- }>>;
647
- /**
648
- * 断开当前用户的连接
649
- * @description 调用后将不再接收消息,不可发送消息,不可获取历史消息,不可获取会话列表
650
- */
651
- declare function disconnect(): Promise<void>;
652
- /**
653
- * 获取 IM 连接状态
654
- */
655
- declare function getConnectionStatus(): ConnectionStatus;
656
- /**
657
- * 当前服务器时间
658
- * 校准时间,可能存在误差
659
- */
660
- declare function getServerTime(): number;
661
- /**
662
- * 获取 IM 连接用户的 id
663
- */
664
- declare function getCurrentUserId(): string;
751
+
665
752
  /**
666
753
  * 绑定事件
754
+ * @category 基础
667
755
  * @param eventType
668
756
  * @param listener
669
757
  * @param target
670
758
  */
671
759
  declare function addEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
760
+ /**
761
+ * 绑定仅执行一次的事件
762
+ * @category 基础
763
+ */
672
764
  declare function onceEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
673
765
  /**
674
766
  * 移除事件
767
+ * @category 基础
675
768
  */
676
769
  declare function removeEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
677
770
  /**
678
771
  * 移除同一类型下的所有事件
772
+ * @category 基础
679
773
  */
680
774
  declare function removeEventListeners(eventType: string): void;
681
775
  /**
682
776
  * 清理所有事件
777
+ * @category 基础
683
778
  */
684
779
  declare function clearEventListeners(): void;
685
- declare function __addSDKVersion(name: string, version: string): void;
686
- /**
687
- * 获取 deviceId
688
- */
689
- declare function getDeviceId(): string;
690
780
 
691
781
  /**
692
782
  * 获取会话列表
783
+ * @category 会话
693
784
  * @param options
694
785
  */
695
786
  declare function getConversationList$1(options?: {
@@ -714,21 +805,25 @@ declare function getConversationList$1(options?: {
714
805
  /**
715
806
  * 获取指定会话数据
716
807
  * @description 通过该方法获取的会话可能并不存在于当前的会话列表中,此处只作为功能性封装语法糖
808
+ * @category 会话
717
809
  * @param options
718
810
  */
719
811
  declare function getConversation(options: IConversationOption): Promise<IAsyncRes<IAReceivedConversation | null | undefined>>;
720
812
  /**
721
813
  * 移除指定的会话实例
814
+ * @category 会话
722
815
  */
723
816
  declare function removeConversation(options: IConversationOption): Promise<IAsyncRes<void>>;
724
817
  /**
725
818
  * 获取会话文本草稿
819
+ * @category 草稿
726
820
  * @params conversationType 会话类型
727
821
  * @params targetId 目标 ID
728
822
  */
729
823
  declare function getTextMessageDraft(options: IConversationOption): Promise<IAsyncRes<string>>;
730
824
  /**
731
825
  * 设置会话文本草稿
826
+ * @category 草稿
732
827
  * @params conversationType 会话类型
733
828
  * @params targetId 目标 ID
734
829
  * @params draft 草稿内容
@@ -736,12 +831,14 @@ declare function getTextMessageDraft(options: IConversationOption): Promise<IAsy
736
831
  declare function saveTextMessageDraft(options: IConversationOption, draft: string): Promise<IAsyncRes<void>>;
737
832
  /**
738
833
  * 删除会话文本草稿
834
+ * @category 草稿
739
835
  * @params conversationType 会话类型
740
836
  * @params targetId 目标 ID
741
837
  */
742
838
  declare function clearTextMessageDraft(options: IConversationOption): Promise<IAsyncRes<void>>;
743
839
  /**
744
840
  * 获取当前所有会话的消息未读数
841
+ * @category 会话未读数
745
842
  * @description
746
843
  * 1. 清除浏览器缓存会导致会话未读数不准确
747
844
  * 2. 会话消息未读数存储在 WebStorage 中, 若浏览器不支持或禁用 WebStorage,未读消息数将不会保存,浏览器页面刷新未读消息数将不会存在
@@ -752,6 +849,7 @@ declare function clearTextMessageDraft(options: IConversationOption): Promise<IA
752
849
  declare function getTotalUnreadCount(includeMuted?: boolean, conversationTypes?: ConversationType[]): Promise<IAsyncRes<number>>;
753
850
  /**
754
851
  * 获取会话指定免打扰级别的未读数
852
+ * @category 会话未读数
755
853
  * @param conversationTypes 会话类型列表
756
854
  * @param levels 免打扰级别列表,传空数组则获取全部免打扰级别未读数
757
855
  * @return number 未读总数
@@ -759,6 +857,7 @@ declare function getTotalUnreadCount(includeMuted?: boolean, conversationTypes?:
759
857
  declare function getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[]): Promise<IAsyncRes<number>>;
760
858
  /**
761
859
  * 获取会话指定免打扰级别未读 @ 消息数
860
+ * @category 会话未读数
762
861
  * @param conversationTypes 会话类型列表
763
862
  * @param levels 免打扰级别列表,传空数组则获取全部免打扰级别未读数
764
863
  * @return number 未读总数
@@ -766,16 +865,18 @@ declare function getTotalUnreadCountByLevels(conversationTypes: ConversationType
766
865
  declare function getTotalUnreadMentionedCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[]): Promise<IAsyncRes<number>>;
767
866
  /**
768
867
  * 获取单个会话的未读数
769
- *
868
+ * @category 会话未读数
770
869
  */
771
870
  declare function getUnreadCount(options: IConversationOption): Promise<IAsyncRes<number>>;
772
871
  /**
773
872
  * 清除会话未读数
774
873
  * 原:clearUnreadCount
874
+ * @category 会话未读数
775
875
  */
776
- declare function clearMessagesUnreadStatus(options: IConversationOption): Promise<IAsyncRes>;
876
+ declare function clearMessagesUnreadStatus(options: IConversationOption): Promise<IAsyncRes<void>>;
777
877
  /**
778
878
  * 清理全部未读数
879
+ * @category 会话未读数
779
880
  * @returns
780
881
  */
781
882
  declare function clearAllMessagesUnreadStatus(): Promise<IAsyncRes<ErrorCode>>;
@@ -790,6 +891,7 @@ declare function clearAllMessagesUnreadStatus(): Promise<IAsyncRes<ErrorCode>>;
790
891
  * * 3: @ 群用户组通知,通知用户组暂未实现,暂不暴露出去
791
892
  * * 4: @ 群全员通知
792
893
  * * 5: 消息通知被屏蔽,即不接收消息通知
894
+ * @category 会话
793
895
  */
794
896
  declare function setConversationNotificationLevel(options: IConversationOption, notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>;
795
897
  /**
@@ -799,103 +901,126 @@ declare function setConversationNotificationLevel(options: IConversationOption,
799
901
  * 是否免打扰
800
902
  * * 1: 开启免打扰
801
903
  * * 2: 关闭免打扰
904
+ * @category 会话
802
905
  */
803
906
  declare function setConversationNotificationStatus(options: IConversationOption, notificationStatus: NotificationStatus): Promise<IAsyncRes<void>>;
804
907
  /**
805
908
  * 查询指定会话和频道免打扰
806
909
  * 原: getConversationNotificationStatus 已废弃
910
+ * @category 会话
807
911
  */
808
912
  declare function getConversationNotificationLevel(options: IConversationOption): Promise<IAsyncRes<NotificationLevel | undefined>>;
809
913
  /**
810
914
  * 获取免打扰状态
811
915
  * getConversationNotificationStatus
916
+ * @category 会话
812
917
  * @deprecated 已废弃,请使用 getConversationNotificationLevel
813
918
  */
814
919
  declare function getConversationNotificationStatus(options: IConversationOption): Promise<IAsyncRes<NotificationStatus | undefined>>;
815
920
  /**
816
921
  * 获取免打扰状态列表
817
922
  * getBlockedConversationList
923
+ * @category 会话
818
924
  */
819
925
  declare function getBlockedConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
820
926
  /**
821
927
  * 设置会话是否置顶
928
+ * @category 会话
822
929
  */
823
930
  declare function setConversationToTop(options: IConversationOption, isTop?: boolean): Promise<IAsyncRes<void>>;
824
931
  /**
825
932
  * 获取置顶会话
933
+ * @category 会话
826
934
  */
827
935
  declare function getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
828
936
  /**
829
937
  * 获取单个群会话 @ 消息未读数
938
+ * @category 会话未读数
830
939
  * @param targetId 目标 ID
831
940
  */
832
941
  declare function getUnreadMentionedCount(options: IConversationOption): Promise<IAsyncRes<number>>;
833
942
  /**
834
943
  * 获取所有群会话 @ 消息未读数
944
+ * @category 会话未读数
835
945
  */
836
946
  declare function getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
837
947
  /**
838
948
  * 获取本地全部会话的状态
949
+ * @category 会话
839
950
  */
840
951
  declare function getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
841
952
 
842
953
  /**
843
954
  * 获取超级群会话列表
955
+ * @category 超级群
844
956
  */
845
957
  declare function getUltraGroupList(options?: IGetUltraGroupListOption): Promise<IAsyncRes<IUltraGroupConversation[]>>;
846
958
  /**
847
- * 获取超级群免打扰列表
848
- */
959
+ * 获取超级群免打扰列表
960
+ * @category 超级群
961
+ */
849
962
  declare function getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
850
963
  /**
851
964
  * 通知服务端正在输入中
965
+ * @category 超级群
852
966
  */
853
- declare function sendUltraGroupTypingStatus(options: IConversationOption): Promise<IAsyncRes>;
967
+ declare function sendUltraGroupTypingStatus(options: IConversationOption): Promise<IAsyncRes<void>>;
854
968
  /**
855
969
  * 根据消息 ID 获取消息
970
+ * @category 超级群
856
971
  */
857
- declare function getUltraGroupMessageListByMessageUId(options: IConversationOption, msgs: IMessageDesc[]): Promise<IAsyncRes>;
972
+ declare function getUltraGroupMessageListByMessageUId(options: IConversationOption, msgs: IMessageDesc[]): Promise<IAsyncRes<{
973
+ [messageUid: string]: IReceivedMessage | undefined;
974
+ }>>;
858
975
  /**
859
976
  * 修改消息扩展
977
+ * @category 超级群
860
978
  */
861
979
  declare function updateExpansionForUltraGroupMessage(expansion: {
862
980
  [key: string]: any;
863
- }, message: IAReceivedMessage): Promise<IAsyncRes>;
981
+ }, message: IAReceivedMessage): Promise<IAsyncRes<void>>;
864
982
  /**
865
983
  * 删除消息扩展
984
+ * @category 超级群
866
985
  */
867
- declare function removeExpansionForUltraGroupMessage(expansion: string[], message: IAReceivedMessage): Promise<IAsyncRes>;
986
+ declare function removeExpansionForUltraGroupMessage(expansion: string[], message: IAReceivedMessage): Promise<IAsyncRes<void>>;
868
987
  /**
869
988
  * 删除指定消息上的所有扩展
989
+ * @category 超级群
870
990
  */
871
- declare function removeAllExpansionForUltraGroupMessage(message: IAReceivedMessage): Promise<IAsyncRes>;
991
+ declare function removeAllExpansionForUltraGroupMessage(message: IAReceivedMessage): Promise<IAsyncRes<void>>;
872
992
  /**
873
993
  * 修改消息
994
+ * @category 超级群
874
995
  */
875
996
  declare function modifyMessage(content: {
876
997
  [key: string]: any;
877
- }, message: IAReceivedMessage): Promise<IAsyncRes>;
998
+ }, message: IAReceivedMessage): Promise<IAsyncRes<void>>;
878
999
  /**
879
1000
  * 获取超级群所有子频道的未读数
1001
+ * @category 超级群
880
1002
  * @param targetId 超级群 Id
881
1003
  * @param notificationLevels 免打扰级别,不传或传空数组则获取全部级别
882
1004
  */
883
- declare function getUltraGroupUnreadMentionedCountByTargetId(targetId: string, notificationLevels?: NotificationLevel[]): Promise<IAsyncRes>;
1005
+ declare function getUltraGroupUnreadMentionedCountByTargetId(targetId: string, notificationLevels?: NotificationLevel[]): Promise<IAsyncRes<number>>;
884
1006
  /**
885
1007
  * 查询指定超级群默认通知配置
1008
+ * @category 超级群
886
1009
  */
887
1010
  declare function getUltraGroupDefaultNotificationLevel(options: IUltraGroupOption): Promise<IAsyncRes<NotificationLevel>>;
888
1011
  /**
889
1012
  * 设置指定超级群默认通知配置
1013
+ * @category 超级群
890
1014
  * @param options
891
- * * 设置超级群默认通知配置 options: { targetId: 'xxx' }, channelId 不传或传 ''
892
- * * 设置超级群指定频道默认通知配置 options: { targetId: 'xxx', channelId: 'xxx' }
1015
+ * * 设置超级群默认通知配置 options: \{ targetId: 'xxx' \}, channelId 不传或传 ''
1016
+ * * 设置超级群指定频道默认通知配置 options: \{ targetId: 'xxx', channelId: 'xxx' \}
893
1017
  * @param notificationLevel
894
1018
  * * NotificationLevel
895
1019
  */
896
1020
  declare function setUltraGroupDefaultNotificationLevel(options: IUltraGroupOption, notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>;
897
1021
  /**
898
1022
  * 获取指定超级群所有频道未读数
1023
+ * @category 超级群
899
1024
  * @param targetId 超级群 Id
900
1025
  * @param notificationLevels 免打扰级别,不传或传空数组则获取全部级别
901
1026
  * @returns 未读数
@@ -903,22 +1028,26 @@ declare function setUltraGroupDefaultNotificationLevel(options: IUltraGroupOptio
903
1028
  declare function getUltraGroupUnreadCountByTargetId(targetId: string, notificationLevels?: NotificationLevel[]): Promise<IAsyncRes<number>>;
904
1029
  /**
905
1030
  * 超级群类型所有未读数
1031
+ * @category 超级群
906
1032
  * @returns 未读数
907
1033
  */
908
1034
  declare function getAllUltraGroupUnreadCount(): Promise<IAsyncRes<number>>;
909
1035
  /**
910
1036
  * 超级群类型所有 @ 消息未读数
1037
+ * @category 超级群
911
1038
  * @returns 未读数
912
1039
  */
913
1040
  declare function getAllUltraGroupUnreadMentionedCount(): Promise<IAsyncRes<number>>;
914
1041
  /**
915
1042
  * 超级群获取指定会话未读 @ 消息列表
1043
+ * @category 超级群
916
1044
  * @param options
917
1045
  * @returns 指定会话 @ 未读数消息列表
918
1046
  */
919
1047
  declare function getUltraGroupUnreadMentionedMessages(options: IUltraGroupUnreadMentionedOption): Promise<IAsyncRes<IUltraUnreadMsg[]>>;
920
1048
  /**
921
1049
  * 超级群获取指定会话第一条未读消息时间戳
1050
+ * @category 超级群
922
1051
  * @param conversation
923
1052
  * @returns 指定会话第一条未读消息时间戳
924
1053
  */
@@ -926,15 +1055,17 @@ declare function getUltraGroupFirstUnreadMessageTimestamp(conversation: IUltraGr
926
1055
 
927
1056
  /**
928
1057
  * 加入聊天室
1058
+ * @category 聊天室
929
1059
  */
930
1060
  declare function joinChatRoom(targetId: string, options: {
931
1061
  /**
932
- * 拉取消息数
933
- */
1062
+ * 拉取消息数
1063
+ */
934
1064
  count: number;
935
1065
  }): Promise<IAsyncRes<void>>;
936
1066
  /**
937
1067
  * 加入已存在的聊天室
1068
+ * @category 聊天室
938
1069
  */
939
1070
  declare function joinExistChatRoom(targetId: string, options: {
940
1071
  /**
@@ -944,10 +1075,12 @@ declare function joinExistChatRoom(targetId: string, options: {
944
1075
  }): Promise<IAsyncRes<void>>;
945
1076
  /**
946
1077
  * 退出聊天室
1078
+ * @category 聊天室
947
1079
  */
948
1080
  declare function quitChatRoom(targetId: string): Promise<IAsyncRes<void>>;
949
1081
  /**
950
1082
  * 获取聊天室房间数据
1083
+ * @category 聊天室
951
1084
  * @description count 或 order 有一个为0时,只返回成员总数,不返回成员列表信息
952
1085
  */
953
1086
  declare function getChatRoomInfo(targetId: string, options: {
@@ -964,21 +1097,25 @@ declare function getChatRoomInfo(targetId: string, options: {
964
1097
  }): Promise<IAsyncRes<IChatroomInfo>>;
965
1098
  /**
966
1099
  * 设置聊天室自定义属性
1100
+ * @category 聊天室
967
1101
  * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
968
1102
  */
969
1103
  declare function setChatRoomEntry(targetId: string, options: IChatRoomEntry): Promise<IAsyncRes<void>>;
970
1104
  /**
971
1105
  * 批量设置聊天室自定义属性
1106
+ * @category 聊天室
972
1107
  * @param options ISetChatroomEntryOption数组
973
1108
  */
974
1109
  declare function setChatRoomEntries(targetId: string, options: IChatroomEntries): Promise<IAsyncRes<void>>;
975
1110
  /**
976
1111
  * 强制 增加/修改 任意聊天室属性
1112
+ * @category 聊天室
977
1113
  * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
978
1114
  */
979
1115
  declare function forceSetChatRoomEntry(targetId: string, options: IChatRoomEntry): Promise<IAsyncRes<void>>;
980
1116
  /**
981
1117
  * 删除聊天室属性
1118
+ * @category 聊天室
982
1119
  * @description 仅限于删除自己设置的聊天室属性
983
1120
  * @param key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
984
1121
  * @param isSendNotification? 删除成功后是否发送通知消息
@@ -987,6 +1124,7 @@ declare function forceSetChatRoomEntry(targetId: string, options: IChatRoomEntry
987
1124
  declare function removeChatRoomEntry(targetId: string, options: IRemoveChatRoomEntry): Promise<IAsyncRes<void>>;
988
1125
  /**
989
1126
  * 批量删除聊天室属性
1127
+ * @category 聊天室
990
1128
  * @description 仅限于删除自己设置的聊天室属性
991
1129
  * @param entries[] 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
992
1130
  * @param notificationExtra? RC:chrmKVNotiMsg 通知消息中携带的附加信息
@@ -994,11 +1132,13 @@ declare function removeChatRoomEntry(targetId: string, options: IRemoveChatRoomE
994
1132
  declare function removeChatRoomEntries(targetId: string, options: IRemoveChatRoomEntries): Promise<IAsyncRes<void>>;
995
1133
  /**
996
1134
  * 强制删除聊天室内的任意属性
1135
+ * @category 聊天室
997
1136
  * @description
998
1137
  */
999
1138
  declare function forceRemoveChatRoomEntry(targetId: string, options: IRemoveChatRoomEntry): Promise<IAsyncRes<void>>;
1000
1139
  /**
1001
1140
  * 获取聊天室的指定属性
1141
+ * @category 聊天室
1002
1142
  */
1003
1143
  declare function getChatRoomEntry(targetId: string,
1004
1144
  /**
@@ -1007,32 +1147,42 @@ declare function getChatRoomEntry(targetId: string,
1007
1147
  key: string): Promise<IAsyncRes<string | number | boolean>>;
1008
1148
  /**
1009
1149
  * 获取聊天室的所有属性
1150
+ * @category 聊天室
1010
1151
  */
1011
1152
  declare function getAllChatRoomEntries(targetId: string): Promise<IAsyncRes<{
1012
1153
  [key: string]: string | number | boolean;
1013
1154
  }>>;
1014
1155
  /**
1015
1156
  * 获取聊天室的历史消息
1157
+ * @category 聊天室
1016
1158
  */
1017
1159
  declare function getChatroomHistoryMessages(targetId: string, options: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>;
1018
- declare function bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<IAsyncRes>;
1160
+ /**
1161
+ * 将聊天室和 RTC 房间绑定
1162
+ * @category 聊天室
1163
+ */
1164
+ declare function bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<IAsyncRes<void>>;
1019
1165
 
1020
1166
  /**
1021
1167
  * 添加用户到黑名单
1168
+ * @category 黑名单
1022
1169
  * @param userId 用户 ID
1023
1170
  */
1024
- declare function addToBlacklist(userId: string): Promise<IAsyncRes>;
1171
+ declare function addToBlacklist(userId: string): Promise<IAsyncRes<void>>;
1025
1172
  /**
1026
1173
  * 从黑名单中移除用户
1174
+ * @category 黑名单
1027
1175
  * @param userId 用户 ID
1028
1176
  */
1029
- declare function removeFromBlacklist(userId: string): Promise<IAsyncRes>;
1177
+ declare function removeFromBlacklist(userId: string): Promise<IAsyncRes<void>>;
1030
1178
  /**
1031
1179
  * 获取黑名单列表
1180
+ * @category 黑名单
1032
1181
  */
1033
1182
  declare function getBlacklist(): Promise<IAsyncRes<string[]>>;
1034
1183
  /**
1035
1184
  * 查询用户是否在黑名单中
1185
+ * @category 黑名单
1036
1186
  * @param userId 用户 ID
1037
1187
  */
1038
1188
  declare function getBlacklistStatus(userId: string): Promise<IAsyncRes<boolean>>;
@@ -1053,6 +1203,10 @@ interface IMentionedInfo {
1053
1203
  mentionedInfo?: MentionedInfo;
1054
1204
  }
1055
1205
 
1206
+ /**
1207
+ * 图片消息
1208
+ * @category Interface
1209
+ */
1056
1210
  interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
1057
1211
  /**
1058
1212
  * 图片的略缩图
@@ -1069,6 +1223,10 @@ interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
1069
1223
  }
1070
1224
  declare const _default$a: MessageConstructor<IImageMessageBody>;
1071
1225
 
1226
+ /**
1227
+ * 图片消息
1228
+ * @category Interface
1229
+ */
1072
1230
  interface IHQVoiceMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
1073
1231
  /**
1074
1232
  * 远程媒体资源地址
@@ -1085,6 +1243,10 @@ interface IHQVoiceMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
1085
1243
  }
1086
1244
  declare const _default$9: MessageConstructor<IHQVoiceMessageBody>;
1087
1245
 
1246
+ /**
1247
+ * 短视频消息
1248
+ * @category Interface
1249
+ */
1088
1250
  interface ISightMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
1089
1251
  /**
1090
1252
  * 远程视频资源 url 地址
@@ -1112,6 +1274,7 @@ declare const _default$8: MessageConstructor<ISightMessageBody>;
1112
1274
 
1113
1275
  /**
1114
1276
  * 文本消息
1277
+ * @category Interface
1115
1278
  */
1116
1279
  interface ITextMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
1117
1280
  /**
@@ -1121,6 +1284,10 @@ interface ITextMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
1121
1284
  }
1122
1285
  declare const _default$7: MessageConstructor<ITextMessageBody>;
1123
1286
 
1287
+ /**
1288
+ * 富文本消息
1289
+ * @category Interface
1290
+ */
1124
1291
  interface ICombineMessageBody extends IExtraData, IUserInfo {
1125
1292
  /**
1126
1293
  * 存储在融云服务器的远端 HTML 文件路径
@@ -1141,6 +1308,10 @@ interface ICombineMessageBody extends IExtraData, IUserInfo {
1141
1308
  }
1142
1309
  declare const _default$6: MessageConstructor<ICombineMessageBody>;
1143
1310
 
1311
+ /**
1312
+ * 文件消息
1313
+ * @category Interface
1314
+ */
1144
1315
  interface IFileMessageBody extends IExtraData, IUserInfo {
1145
1316
  /**
1146
1317
  * 文件名称
@@ -1161,6 +1332,9 @@ interface IFileMessageBody extends IExtraData, IUserInfo {
1161
1332
  }
1162
1333
  declare const _default$5: MessageConstructor<IFileMessageBody>;
1163
1334
 
1335
+ /**
1336
+ * @category Interface
1337
+ */
1164
1338
  interface IGIFMessageBody extends IExtraData, IUserInfo {
1165
1339
  /**
1166
1340
  * GIF 图片文件大小,单位为 KB
@@ -1181,6 +1355,9 @@ interface IGIFMessageBody extends IExtraData, IUserInfo {
1181
1355
  }
1182
1356
  declare const _default$4: MessageConstructor<IGIFMessageBody>;
1183
1357
 
1358
+ /**
1359
+ * @category Interface
1360
+ */
1184
1361
  interface IVoiceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
1185
1362
  content: string;
1186
1363
  duration: number;
@@ -1188,6 +1365,9 @@ interface IVoiceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
1188
1365
  }
1189
1366
  declare const _default$3: MessageConstructor<IVoiceMessageBody>;
1190
1367
 
1368
+ /**
1369
+ * @category Interface
1370
+ */
1191
1371
  interface ILocationMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
1192
1372
  /**
1193
1373
  * 经度
@@ -1208,6 +1388,9 @@ interface ILocationMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
1208
1388
  }
1209
1389
  declare const _default$2: MessageConstructor<ILocationMessageBody>;
1210
1390
 
1391
+ /**
1392
+ * @category Interface
1393
+ */
1211
1394
  interface IReferenceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
1212
1395
  /**
1213
1396
  * 被引用消息的发送用户 Id
@@ -1234,15 +1417,23 @@ interface IArticle {
1234
1417
  imageUri: string;
1235
1418
  url: string;
1236
1419
  }
1420
+ /**
1421
+ * @category Interface
1422
+ */
1237
1423
  interface IRichContentMessageBody extends IArticle, IExtraData, IMentionedInfo, IUserInfo {
1238
1424
  }
1239
1425
  declare const _default: MessageConstructor<IRichContentMessageBody>;
1240
1426
 
1241
1427
  /**
1242
1428
  * 发送消息
1429
+ * @category 消息
1243
1430
  * @param options
1244
1431
  */
1245
1432
  declare function sendMessage(conversation: IConversationOption, message: BaseMessage, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
1433
+ /**
1434
+ * 发送文本消息
1435
+ * @category 消息
1436
+ */
1246
1437
  declare function sendTextMessage(conversation: IConversationOption, messageBody: ITextMessageBody, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
1247
1438
  declare type ISendBody = IUserInfo & IExtraData & {
1248
1439
  file: Blob;
@@ -1250,15 +1441,18 @@ declare type ISendBody = IUserInfo & IExtraData & {
1250
1441
  declare type ISendFileMessageOptions = ISendBody;
1251
1442
  /**
1252
1443
  * 发送文件消息
1444
+ * @category 消息
1253
1445
  */
1254
1446
  declare const sendFileMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
1255
1447
  declare type ISendImageMessageOptions = ISendBody;
1256
1448
  /**
1257
1449
  * 发送图片消息
1450
+ * @category 消息
1258
1451
  */
1259
1452
  declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IImageMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
1260
1453
  /**
1261
1454
  * 发送高清语音消息,待发送的文件必须为 AAC 音频文件
1455
+ * @category 消息
1262
1456
  */
1263
1457
  declare const sendHQVoiceMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
1264
1458
  declare type ISendSightMessageOptions = {
@@ -1268,34 +1462,41 @@ declare type ISendSightMessageOptions = {
1268
1462
  } & ISendBody;
1269
1463
  /**
1270
1464
  * 发送小视频消息
1465
+ * @category 消息
1271
1466
  * @description 发送的小视频消息必须是 MP4 文件,且音频编码为 AAC,视频编码 H264,否则可能造成 iOS 或 Android 接收后不可播放问题
1272
1467
  */
1273
1468
  declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISendSightMessageOptions, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
1274
1469
  /**
1275
1470
  * 获取历史消息
1471
+ * @category 消息
1276
1472
  */
1277
1473
  declare function getHistoryMessages(conversation: IConversationOption, options?: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>;
1278
1474
  /**
1279
1475
  * 获取远程历史消息
1476
+ * @category 消息
1280
1477
  */
1281
1478
  declare function getRemoteHistoryMessages(conversation: IConversationOption, options?: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>;
1282
1479
  /**
1283
1480
  * 发送单聊已读回执
1481
+ * @category 消息
1284
1482
  */
1285
1483
  declare function sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<void>>;
1286
1484
  /**
1287
1485
  * 发送群已读回执请求
1486
+ * @category 消息
1288
1487
  * @param messageUIds 消息UID列表
1289
1488
  */
1290
1489
  declare function sendReadReceiptRequest(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<void>>;
1291
1490
  /**
1491
+ * @category 消息
1292
1492
  * @deprecated 已废弃,请使用 sendReadReceiptResponseV2
1293
1493
  */
1294
1494
  declare function sendReadReceiptResponse(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes<void>>;
1295
1495
  /**
1296
1496
  * 发送群阅读回执响应V2
1497
+ * @category 消息
1297
1498
  * @param targetId 群组Id
1298
- * @param messageList 要回执的消息列表,结构为: {senderUserId: [messageUId1, messageUId2]}
1499
+ * @param messageList 要回执的消息列表,结构为: \{senderUserId: [messageUId1, messageUId2]\}
1299
1500
  * @param channelId
1300
1501
  */
1301
1502
  declare function sendReadReceiptResponseV2(targetId: string, messageList: {
@@ -1303,23 +1504,26 @@ declare function sendReadReceiptResponseV2(targetId: string, messageList: {
1303
1504
  }, channelId?: string): Promise<IAsyncRes<void>>;
1304
1505
  /**
1305
1506
  * 多端同步阅读状态
1507
+ * @category 消息
1306
1508
  * @param conversation
1307
1509
  * @param timestamp
1308
1510
  */
1309
1511
  declare function sendSyncReadStatusMessage(conversation: IConversationOption, lastMessageSendTime: number): Promise<{
1310
- code: ErrorCode.SUCCESS;
1512
+ code: ErrorCode;
1311
1513
  msg?: undefined;
1312
1514
  } | {
1313
- code: ErrorCode.TIMEOUT | ErrorCode.UNKNOWN | ErrorCode.PARAMETER_ERROR | ErrorCode.EXTRA_METHOD_UNDEFINED | ErrorCode.MAIN_PROCESS_ERROR | ErrorCode.PARAMETER_CHANGED | ErrorCode.RC_DISCUSSION_GROUP_ID_INVALID | ErrorCode.SEND_FREQUENCY_TOO_FAST | ErrorCode.NOT_IN_DISCUSSION | ErrorCode.FORBIDDEN_IN_GROUP | ErrorCode.RECALL_MESSAGE | ErrorCode.NOT_IN_GROUP | ErrorCode.NOT_IN_CHATROOM | ErrorCode.FORBIDDEN_IN_CHATROOM | ErrorCode.RC_CHATROOM_USER_KICKED | ErrorCode.RC_CHATROOM_NOT_EXIST | ErrorCode.RC_CHATROOM_IS_FULL | ErrorCode.RC_CHATROOM_PATAMETER_INVALID | ErrorCode.CHATROOM_GET_HISTORYMSG_ERROR | ErrorCode.CHATROOM_NOT_OPEN_HISTORYMSG_STORE | ErrorCode.CHATROOM_KV_EXCEED | ErrorCode.CHATROOM_KV_OVERWRITE_INVALID | ErrorCode.CHATROOM_KV_STORE_NOT_OPEN | ErrorCode.CHATROOM_KEY_NOT_EXIST | ErrorCode.CHATROOM_KV_SET_ERROR | ErrorCode.SENSITIVE_SHIELD | ErrorCode.SENSITIVE_REPLACE | ErrorCode.JOIN_IN_DISCUSSION | ErrorCode.CREATE_DISCUSSION | ErrorCode.INVITE_DICUSSION | ErrorCode.GET_USERINFO_ERROR | ErrorCode.REJECTED_BY_BLACKLIST | ErrorCode.RC_NET_CHANNEL_INVALID | ErrorCode.RC_NET_UNAVAILABLE | ErrorCode.RC_MSG_RESP_TIMEOUT | ErrorCode.RC_HTTP_SEND_FAIL | ErrorCode.RC_HTTP_REQ_FAIL | ErrorCode.RC_HTTP_RECV_FAIL | ErrorCode.RC_NAVI_RESOURCE_ERROR | ErrorCode.RC_NODE_NOT_FOUND | ErrorCode.RC_DOMAIN_NOT_RESOLVE | ErrorCode.RC_SOCKET_NOT_CREATED | ErrorCode.RC_SOCKET_DISCONNECTED | ErrorCode.RC_PING_SEND_FAIL | ErrorCode.RC_PONG_RECV_FAIL | ErrorCode.RC_MSG_SEND_FAIL | ErrorCode.RC_MSG_CONTENT_EXCEED_LIMIT | ErrorCode.RC_CONN_ACK_TIMEOUT | ErrorCode.RC_CONN_PROTO_VERSION_ERROR | ErrorCode.RC_CONN_ID_REJECT | ErrorCode.RC_CONN_SERVER_UNAVAILABLE | ErrorCode.RC_CONN_USER_OR_PASSWD_ERROR | ErrorCode.RC_CONN_NOT_AUTHRORIZED | ErrorCode.RC_CONN_REDIRECTED | ErrorCode.RC_CONN_PACKAGE_NAME_INVALID | ErrorCode.RC_CONN_APP_BLOCKED_OR_DELETED | ErrorCode.RC_CONN_USER_BLOCKED | ErrorCode.RC_DISCONN_KICK | ErrorCode.RC_DISCONN_EXCEPTION | ErrorCode.RC_DISCONN_SAME_CLIENT_ON_LINE | ErrorCode.RC_APP_AUTH_NOT_PASS | ErrorCode.RC_OTP_USED | ErrorCode.RC_PLATFORM_ERROR | ErrorCode.RC_QUERY_ACK_NO_DATA | ErrorCode.RC_MSG_DATA_INCOMPLETE | ErrorCode.BIZ_ERROR_CLIENT_NOT_INIT | ErrorCode.BIZ_ERROR_DATABASE_ERROR | ErrorCode.BIZ_ERROR_INVALID_PARAMETER | ErrorCode.BIZ_ERROR_NO_CHANNEL | ErrorCode.BIZ_ERROR_RECONNECT_SUCCESS | ErrorCode.BIZ_ERROR_CONNECTING | ErrorCode.MSG_ROAMING_SERVICE_UNAVAILABLE | ErrorCode.MSG_INSERT_ERROR | ErrorCode.MSG_DEL_ERROR | ErrorCode.TAG_EXISTS | ErrorCode.TAG_NOT_EXIST | ErrorCode.NO_TAG_IN_CONVER | ErrorCode.CONVER_REMOVE_ERROR | ErrorCode.CONVER_GETLIST_ERROR | ErrorCode.CONVER_SETOP_ERROR | ErrorCode.CONVER_TOTAL_UNREAD_ERROR | ErrorCode.CONVER_TYPE_UNREAD_ERROR | ErrorCode.CONVER_ID_TYPE_UNREAD_ERROR | ErrorCode.EXPANSION_LIMIT_EXCEET | ErrorCode.MESSAGE_KV_NOT_SUPPORT | ErrorCode.CONVER_OUT_LIMIT_ERROR | ErrorCode.CONVER_GET_ERROR | ErrorCode.GROUP_SYNC_ERROR | ErrorCode.GROUP_MATCH_ERROR | ErrorCode.READ_RECEIPT_ERROR | ErrorCode.PACKAGE_ENVIRONMENT_ERROR | ErrorCode.CAN_NOT_RECONNECT | ErrorCode.SERVER_UNAVAILABLE | ErrorCode.HOSTNAME_ERROR | ErrorCode.HAS_OHTER_SAME_CLIENT_ON_LINE | ErrorCode.METHOD_NOT_AVAILABLE | ErrorCode.METHOD_NOT_SUPPORT | ErrorCode.MSG_LIMIT_ERROR | ErrorCode.METHOD_ONLY_SUPPORT_ULTRA_GROUP | ErrorCode.UPLOAD_FILE_FAILED | ErrorCode.CHATROOM_ID_ISNULL | ErrorCode.CHARTOOM_JOIN_ERROR | ErrorCode.CHATROOM_HISMESSAGE_ERROR | ErrorCode.CHATROOM_KV_NOT_FOUND | ErrorCode.BLACK_ADD_ERROR | ErrorCode.BLACK_GETSTATUS_ERROR | ErrorCode.BLACK_REMOVE_ERROR | ErrorCode.DRAF_GET_ERROR | ErrorCode.DRAF_SAVE_ERROR | ErrorCode.DRAF_REMOVE_ERROR | ErrorCode.SUBSCRIBE_ERROR | ErrorCode.NOT_SUPPORT | ErrorCode.QNTKN_FILETYPE_ERROR | ErrorCode.QNTKN_GET_ERROR | ErrorCode.COOKIE_ENABLE | ErrorCode.HAVNODEVICEID | ErrorCode.DEVICEIDISHAVE | ErrorCode.FEILD | ErrorCode.VOIPISNULL | ErrorCode.NOENGINETYPE | ErrorCode.NULLCHANNELNAME | ErrorCode.VOIPDYANMICERROR | ErrorCode.NOVOIP | ErrorCode.INTERNALERRROR | ErrorCode.VOIPCLOSE | ErrorCode.ULTRA_GROUP_USER_NOT_IN_PRIVATE_CHANNEL | ErrorCode.CANCEL | ErrorCode.REJECT | ErrorCode.HANGUP | ErrorCode.BUSYLINE | ErrorCode.NO_RESPONSE | ErrorCode.ENGINE_UN_SUPPORTED | ErrorCode.NETWORK_ERROR | ErrorCode.REMOTE_CANCEL | ErrorCode.REMOTE_REJECT | ErrorCode.REMOTE_HANGUP | ErrorCode.REMOTE_BUSYLINE | ErrorCode.REMOTE_NO_RESPONSE | ErrorCode.REMOTE_ENGINE_UN_SUPPORTED | ErrorCode.REMOTE_NETWORK_ERROR | ErrorCode.VOIP_NOT_AVALIABLE | ErrorCode.CHATROOM_KV_STORE_NOT_ALL_SUCCESS | ErrorCode.CHATROOM_KV_STORE_OUT_LIMIT | ErrorCode.SEARCH_PROPS_LIMIT_ERROR;
1515
+ code: ErrorCode.TIMEOUT | ErrorCode.UNKNOWN | ErrorCode.PARAMETER_ERROR | ErrorCode.EXTRA_METHOD_UNDEFINED | ErrorCode.MAIN_PROCESS_ERROR | ErrorCode.PARAMETER_CHANGED | ErrorCode.RC_DISCUSSION_GROUP_ID_INVALID | ErrorCode.SEND_FREQUENCY_TOO_FAST | ErrorCode.NOT_IN_DISCUSSION | ErrorCode.FORBIDDEN_IN_GROUP | ErrorCode.RECALL_MESSAGE | ErrorCode.NOT_IN_GROUP | ErrorCode.NOT_IN_CHATROOM | ErrorCode.FORBIDDEN_IN_CHATROOM | ErrorCode.RC_CHATROOM_USER_KICKED | ErrorCode.RC_CHATROOM_NOT_EXIST | ErrorCode.RC_CHATROOM_IS_FULL | ErrorCode.RC_CHATROOM_PATAMETER_INVALID | ErrorCode.CHATROOM_GET_HISTORYMSG_ERROR | ErrorCode.CHATROOM_NOT_OPEN_HISTORYMSG_STORE | ErrorCode.CHATROOM_KV_EXCEED | ErrorCode.CHATROOM_KV_OVERWRITE_INVALID | ErrorCode.CHATROOM_KV_STORE_NOT_OPEN | ErrorCode.CHATROOM_KEY_NOT_EXIST | ErrorCode.CHATROOM_KV_SET_ERROR | ErrorCode.SENSITIVE_SHIELD | ErrorCode.SENSITIVE_REPLACE | ErrorCode.JOIN_IN_DISCUSSION | ErrorCode.CREATE_DISCUSSION | ErrorCode.INVITE_DICUSSION | ErrorCode.GET_USERINFO_ERROR | ErrorCode.REJECTED_BY_BLACKLIST | ErrorCode.RC_NET_CHANNEL_INVALID | ErrorCode.RC_NET_UNAVAILABLE | ErrorCode.RC_MSG_RESP_TIMEOUT | ErrorCode.RC_HTTP_SEND_FAIL | ErrorCode.RC_HTTP_REQ_FAIL | ErrorCode.RC_HTTP_RECV_FAIL | ErrorCode.RC_NAVI_RESOURCE_ERROR | ErrorCode.RC_NODE_NOT_FOUND | ErrorCode.RC_DOMAIN_NOT_RESOLVE | ErrorCode.RC_SOCKET_NOT_CREATED | ErrorCode.RC_SOCKET_DISCONNECTED | ErrorCode.RC_PING_SEND_FAIL | ErrorCode.RC_PONG_RECV_FAIL | ErrorCode.RC_MSG_SEND_FAIL | ErrorCode.RC_MSG_CONTENT_EXCEED_LIMIT | ErrorCode.RC_CONN_ACK_TIMEOUT | ErrorCode.RC_CONN_PROTO_VERSION_ERROR | ErrorCode.RC_CONN_ID_REJECT | ErrorCode.RC_CONN_SERVER_UNAVAILABLE | ErrorCode.RC_CONN_USER_OR_PASSWD_ERROR | ErrorCode.RC_CONN_NOT_AUTHRORIZED | ErrorCode.RC_CONN_REDIRECTED | ErrorCode.RC_CONN_PACKAGE_NAME_INVALID | ErrorCode.RC_CONN_APP_BLOCKED_OR_DELETED | ErrorCode.RC_CONN_USER_BLOCKED | ErrorCode.RC_DISCONN_KICK | ErrorCode.RC_DISCONN_EXCEPTION | ErrorCode.RC_DISCONN_SAME_CLIENT_ON_LINE | ErrorCode.RC_APP_AUTH_NOT_PASS | ErrorCode.RC_OTP_USED | ErrorCode.RC_PLATFORM_ERROR | ErrorCode.RC_CONN_USER_LOGOUT | ErrorCode.RC_LICENSE_EXPIRED | ErrorCode.RC_QUERY_ACK_NO_DATA | ErrorCode.RC_MSG_DATA_INCOMPLETE | ErrorCode.BIZ_ERROR_CLIENT_NOT_INIT | ErrorCode.BIZ_ERROR_DATABASE_ERROR | ErrorCode.BIZ_ERROR_INVALID_PARAMETER | ErrorCode.BIZ_ERROR_NO_CHANNEL | ErrorCode.BIZ_ERROR_RECONNECT_SUCCESS | ErrorCode.BIZ_ERROR_CONNECTING | ErrorCode.MSG_ROAMING_SERVICE_UNAVAILABLE | ErrorCode.MSG_INSERT_ERROR | ErrorCode.MSG_DEL_ERROR | ErrorCode.TAG_EXISTS | ErrorCode.TAG_NOT_EXIST | ErrorCode.NO_TAG_IN_CONVER | ErrorCode.CONVER_REMOVE_ERROR | ErrorCode.CONVER_GETLIST_ERROR | ErrorCode.CONVER_SETOP_ERROR | ErrorCode.CONVER_TOTAL_UNREAD_ERROR | ErrorCode.CONVER_TYPE_UNREAD_ERROR | ErrorCode.CONVER_ID_TYPE_UNREAD_ERROR | ErrorCode.EXPANSION_LIMIT_EXCEET | ErrorCode.MESSAGE_KV_NOT_SUPPORT | ErrorCode.CONVER_OUT_LIMIT_ERROR | ErrorCode.CONVER_GET_ERROR | ErrorCode.GROUP_SYNC_ERROR | ErrorCode.GROUP_MATCH_ERROR | ErrorCode.READ_RECEIPT_ERROR | ErrorCode.PACKAGE_ENVIRONMENT_ERROR | ErrorCode.CAN_NOT_RECONNECT | ErrorCode.SERVER_UNAVAILABLE | ErrorCode.HOSTNAME_ERROR | ErrorCode.HAS_OHTER_SAME_CLIENT_ON_LINE | ErrorCode.METHOD_NOT_AVAILABLE | ErrorCode.METHOD_NOT_SUPPORT | ErrorCode.MSG_LIMIT_ERROR | ErrorCode.METHOD_ONLY_SUPPORT_ULTRA_GROUP | ErrorCode.UPLOAD_FILE_FAILED | ErrorCode.CHATROOM_ID_ISNULL | ErrorCode.CHARTOOM_JOIN_ERROR | ErrorCode.CHATROOM_HISMESSAGE_ERROR | ErrorCode.CHATROOM_KV_NOT_FOUND | ErrorCode.BLACK_ADD_ERROR | ErrorCode.BLACK_GETSTATUS_ERROR | ErrorCode.BLACK_REMOVE_ERROR | ErrorCode.DRAF_GET_ERROR | ErrorCode.DRAF_SAVE_ERROR | ErrorCode.DRAF_REMOVE_ERROR | ErrorCode.SUBSCRIBE_ERROR | ErrorCode.NOT_SUPPORT | ErrorCode.QNTKN_FILETYPE_ERROR | ErrorCode.QNTKN_GET_ERROR | ErrorCode.COOKIE_ENABLE | ErrorCode.HAVNODEVICEID | ErrorCode.DEVICEIDISHAVE | ErrorCode.FEILD | ErrorCode.VOIPISNULL | ErrorCode.NOENGINETYPE | ErrorCode.NULLCHANNELNAME | ErrorCode.VOIPDYANMICERROR | ErrorCode.NOVOIP | ErrorCode.INTERNALERRROR | ErrorCode.VOIPCLOSE | ErrorCode.ULTRA_GROUP_USER_NOT_IN_PRIVATE_CHANNEL | ErrorCode.CANCEL | ErrorCode.REJECT | ErrorCode.HANGUP | ErrorCode.BUSYLINE | ErrorCode.NO_RESPONSE | ErrorCode.ENGINE_UN_SUPPORTED | ErrorCode.NETWORK_ERROR | ErrorCode.REMOTE_CANCEL | ErrorCode.REMOTE_REJECT | ErrorCode.REMOTE_HANGUP | ErrorCode.REMOTE_BUSYLINE | ErrorCode.REMOTE_NO_RESPONSE | ErrorCode.REMOTE_ENGINE_UN_SUPPORTED | ErrorCode.REMOTE_NETWORK_ERROR | ErrorCode.VOIP_NOT_AVALIABLE | ErrorCode.CHATROOM_KV_STORE_NOT_ALL_SUCCESS | ErrorCode.CHATROOM_KV_STORE_OUT_LIMIT | ErrorCode.SEARCH_PROPS_LIMIT_ERROR;
1314
1516
  msg: string | undefined;
1315
1517
  }>;
1316
1518
  /**
1317
1519
  * 撤回消息
1520
+ * @category 消息
1318
1521
  * @param options
1319
1522
  */
1320
1523
  declare function recallMessage(conversation: IConversationOption, options: IRecallMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
1321
1524
  /**
1322
1525
  * 按消息 UId 删除消息
1526
+ * @category 消息
1323
1527
  */
1324
1528
  declare function deleteMessages$1(conversation: IConversationOption, messages: {
1325
1529
  /**
@@ -1339,12 +1543,14 @@ declare function deleteMessages$1(conversation: IConversationOption, messages: {
1339
1543
  }[]): Promise<IAsyncRes<void>>;
1340
1544
  /**
1341
1545
  * 按时间戳删除消息
1546
+ * @category 消息
1342
1547
  * @param conversation 会话
1343
1548
  * @param timestamp 清除时间点, 该时间之前的消息将被清除
1344
1549
  */
1345
1550
  declare function clearHistoryMessages(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>;
1346
1551
  /**
1347
1552
  * 更新(添加、替换)消息扩展属性
1553
+ * @category 消息
1348
1554
  * @param expansion 要更新的消息扩展信息键值对
1349
1555
  * @param message 要更新的原始消息体
1350
1556
  */
@@ -1353,37 +1559,43 @@ declare function updateMessageExpansion(expansion: {
1353
1559
  }, message: IAReceivedMessage): Promise<IAsyncRes<void>>;
1354
1560
  /**
1355
1561
  * 删除扩展存储
1562
+ * @category 消息
1356
1563
  * @params keys 需删除消息扩展的 keys
1357
1564
  * @params message 原始消息体
1358
1565
  */
1359
1566
  declare function removeMessageExpansionForKey(keys: string[], message: IAReceivedMessage): Promise<IAsyncRes<void>>;
1360
1567
  /**
1361
1568
  * 发送typing消息
1569
+ * @category 消息
1362
1570
  * @param typingContentType 输入状态消息类型
1363
1571
  * @returns
1364
1572
  */
1365
1573
  declare function sendTypingStatusMessage(conversation: IConversationOption, typingContentType: string): Promise<IAsyncRes<IAReceivedMessage>>;
1366
1574
  /**
1367
1575
  * 获取群已读列表
1576
+ * @category 消息
1368
1577
  * @param messageUId 消息UID
1369
1578
  * @returns
1370
1579
  */
1371
1580
  declare function getMessageReader(targetId: string, messageUId: string, channelId: string): Promise<IAsyncRes<IMessageReaderResponse>>;
1372
1581
  /**
1373
- * 注册自定义消息
1374
- * @param messageType 消息类型
1375
- * @param isPersited 是否存储
1376
- * @param isCounted 是否计数
1377
- * @param prototypes 消息属性名称
1378
- */
1582
+ * 注册自定义消息
1583
+ * @category 消息
1584
+ * @param messageType 消息类型
1585
+ * @param isPersited 是否存储
1586
+ * @param isCounted 是否计数
1587
+ * @param prototypes 消息属性名称
1588
+ */
1379
1589
  declare function registerMessageType<T>(messageType: string, isPersited: boolean, isCounted: boolean, prototypes?: string[], isStatusMessage?: boolean): new (content: T) => BaseMessage<T>;
1380
1590
  /**
1381
1591
  * 获取第一条未读消息
1592
+ * @category 消息
1382
1593
  * @param conversation
1383
1594
  */
1384
1595
  declare function getFirstUnreadMessage(conversation: IConversationOption): Promise<IAsyncRes<IReceivedMessage | null>>;
1385
1596
  /**
1386
1597
  * 向本地插入一条消息,不发送到服务器
1598
+ * @category 消息
1387
1599
  * @param conversationType 会话类型
1388
1600
  * @param targetId 目标 ID
1389
1601
  * @param content 消息体
@@ -1393,17 +1605,20 @@ declare function getFirstUnreadMessage(conversation: IConversationOption): Promi
1393
1605
  declare function insertMessage$1(conversation: IConversationOption, content: IReceivedMessage, options?: IInsertOptions): Promise<IAsyncRes<IAReceivedMessage>>;
1394
1606
  /**
1395
1607
  * 获取消息
1608
+ * @category 消息
1396
1609
  * @param messageId 本地消息 ID 或 messageUId
1397
1610
  */
1398
1611
  declare function getMessage(messageId: number): Promise<IAsyncRes<IAReceivedMessage>>;
1399
1612
  /**
1400
1613
  * 获取会话下所有未读的 @ 消息
1614
+ * @category 消息
1401
1615
  * @param conversationType 会话类型
1402
1616
  * @param targetId 目标 ID
1403
1617
  */
1404
1618
  declare function getUnreadMentionedMessages(conversation: IConversationOption): IAsyncRes<IAReceivedMessage[]>;
1405
1619
  /**
1406
1620
  * 按关键字搜索会话内的消息
1621
+ * @category 消息
1407
1622
  * @deprecated 已废弃,推荐使用 electronExtension.searchMessages 方法
1408
1623
  * @param conversation 会话
1409
1624
  * @param keyword 搜索内容
@@ -1417,6 +1632,7 @@ declare function searchMessages$1(conversation: IConversationOption, keyword: st
1417
1632
  }>>;
1418
1633
  /**
1419
1634
  * 从本地消息数据库中删除某一会话指定时间之前的消息数据
1635
+ * @category 消息
1420
1636
  * @param conversation 会话
1421
1637
  * @param timestamp 指定删除该时间戳之前的消息
1422
1638
  * @param cleanSpace 指定删除该时间戳之前的消息。是否清理数据条目所使用的磁盘空间。清理磁盘空间会阻塞进程且耗时较长,不推荐使用。
@@ -1426,12 +1642,14 @@ declare function searchMessages$1(conversation: IConversationOption, keyword: st
1426
1642
  declare function deleteLocalMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<IAsyncRes<void>>;
1427
1643
  /**
1428
1644
  * 清空会话下历史消息
1645
+ * @category 消息
1429
1646
  * @param conversation 会话
1430
1647
  * @deprecated
1431
1648
  */
1432
1649
  declare function clearMessages$1(conversation: IConversationOption): Promise<IAsyncRes<void>>;
1433
1650
  /**
1434
1651
  * 按内容搜索会话
1652
+ * @category 消息
1435
1653
  * @param keyword 关键字
1436
1654
  * @param conversationTypes 会话类型数组
1437
1655
  * @deprecated
@@ -1439,6 +1657,7 @@ declare function clearMessages$1(conversation: IConversationOption): Promise<IAs
1439
1657
  declare function searchConversationByContent$1(keyword: string, conversationTypes?: ConversationType[], customMessageType?: string[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[] | undefined>>;
1440
1658
  /**
1441
1659
  * 清除时间戳前的未读数
1660
+ * @category 消息
1442
1661
  * @param conversationType 会话类型
1443
1662
  * @param targetId 目标 ID
1444
1663
  * @param timestamp 目标 ID
@@ -1447,60 +1666,71 @@ declare function searchConversationByContent$1(keyword: string, conversationType
1447
1666
  declare function clearUnreadCountByTimestamp(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>;
1448
1667
  /**
1449
1668
  * 设置消息接收状态
1669
+ * @category 消息
1450
1670
  * @deprecated
1451
1671
  */
1452
1672
  declare function setMessageReceivedStatus$1(messageId: number, receivedStatus: number): Promise<IAsyncRes<void>>;
1453
1673
 
1454
1674
  /**
1455
1675
  * 创建标签
1676
+ * @category 标签
1456
1677
  * @param tag 标签信息
1457
1678
  */
1458
1679
  declare function addTag(tag: ITagParam): Promise<IAsyncRes<void>>;
1459
1680
  /**
1460
1681
  * 删除标签
1682
+ * @category 标签
1461
1683
  * @param tagId 标签 ID
1462
1684
  */
1463
1685
  declare function removeTag(tagId: string): Promise<IAsyncRes<void>>;
1464
1686
  /**
1465
1687
  * 编辑标签
1688
+ * @category 标签
1466
1689
  * @param tag 标签信息
1467
1690
  */
1468
1691
  declare function updateTag(tag: ITagParam): Promise<IAsyncRes<void>>;
1469
1692
  /**
1470
1693
  * 获取标签列表
1694
+ * @category 标签
1471
1695
  */
1472
1696
  declare function getTags(): Promise<IAsyncRes<ITagInfo[] | undefined>>;
1473
1697
  /**
1474
1698
  * 获取会话下的标签
1699
+ * @category 标签
1475
1700
  * @param conversation 会话信息
1476
1701
  */
1477
1702
  declare function getTagsFromConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[] | undefined>>;
1478
1703
  /**
1479
1704
  * 添加会话到指定标签
1705
+ * @category 标签
1480
1706
  * @param tagId 标签 ID
1481
1707
  * @param conversations 要添加的会话列表
1482
1708
  */
1483
1709
  declare function addConversationsToTag(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>;
1484
1710
  /**
1485
1711
  * 删除指定标签中会话
1712
+ * @category 标签
1486
1713
  * @param tagId 标签 ID
1487
1714
  * @param conversations 要删除的会话列表
1488
1715
  */
1489
1716
  declare function removeConversationsFromTag(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>;
1490
1717
  /**
1491
1718
  * 从指定会话中删除多个标签
1719
+ * @category 标签
1492
1720
  * @param conversation 会话
1493
1721
  * @param tagIds 要删除的标签列表
1494
1722
  */
1495
1723
  declare function removeTagsFromConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<void>>;
1496
1724
  /**
1497
1725
  * 从多个会话中删除指定的标签
1726
+ * @category 标签
1498
1727
  * @param tagId 标签 ID
1499
1728
  * @param conversations 要删除的会话列表
1500
1729
  */
1501
1730
  declare function removeTagFromConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>;
1502
1731
  /**
1503
1732
  * 分页获取标签下会话列表
1733
+ * @category 标签
1504
1734
  * @param tagId 标签id
1505
1735
  * @param count 获取数量
1506
1736
  * @param timestamp 会话时间戳
@@ -1508,12 +1738,14 @@ declare function removeTagFromConversations(tagId: string, conversations: IConve
1508
1738
  declare function getConversationsFromTagByPage(tagId: string, count: number, startTime: number): Promise<IAsyncRes<IReceivedConversationByTag[] | undefined>>;
1509
1739
  /**
1510
1740
  * 根据标签获取未读消息数
1741
+ * @category 标签
1511
1742
  * @param tagId 标签id
1512
1743
  * @param containMuted 是否包含免打扰
1513
1744
  */
1514
1745
  declare function getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number | undefined>>;
1515
1746
  /**
1516
1747
  * 设置标签中会话置顶
1748
+ * @category 标签
1517
1749
  * @param tagId 标签id
1518
1750
  * @param conversation 会话
1519
1751
  * @param status 状态
@@ -1523,6 +1755,7 @@ declare function setConversationToTopInTag(tagId: string, conversation: IConvers
1523
1755
  /**
1524
1756
  * 获取文件 token
1525
1757
  * @description 上传文件时,获取文件 token
1758
+ * @hidden
1526
1759
  * @param fileType 上传类型, 通过 RongIMLib.FILE_TYPE 获取
1527
1760
  * @param fileName 上传文件名,Server 通过文件名生成百度上传认证, 若不传 engine 自动生成
1528
1761
  * @param httpMethod STC 分段上传时的必填参数,有效值为 PUT | POST
@@ -1536,9 +1769,11 @@ declare function setConversationToTopInTag(tagId: string, conversation: IConvers
1536
1769
  declare function getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IAsyncRes<IUploadAuth & {
1537
1770
  bos: string;
1538
1771
  qiniu: string;
1772
+ ossConfig: string;
1539
1773
  }>>;
1540
1774
  /**
1541
1775
  * 获取文件的下载地址
1776
+ * @hidden
1542
1777
  * @param fileType 文件类型
1543
1778
  * @param fileName 文件名
1544
1779
  * @param saveName 下载后的存储文件名
@@ -1554,8 +1789,8 @@ declare function getFileUrl(fileType: FileType, filename?: string, saveName?: st
1554
1789
  }>>;
1555
1790
 
1556
1791
  /**
1557
- * 业务层枚举, 此处枚举会暴露给开发者
1558
- */
1792
+ * @deprecated 从 5.6.0 版本开始,此定义失效
1793
+ */
1559
1794
  declare const ConnectType: {
1560
1795
  COMET: string;
1561
1796
  WEBSOCKET: string;
@@ -1641,25 +1876,25 @@ declare function setMessageStatusToRead(conversation: IConversationOption, times
1641
1876
  * @param messageId 消息 ID
1642
1877
  * @param receivedStatus 接受状态
1643
1878
  */
1644
- declare function setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<IAsyncRes>;
1879
+ declare function setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<IAsyncRes<void>>;
1645
1880
  /**
1646
1881
  * 设置自己发送的消息的发送状态
1647
1882
  * @param messageId 消息ID
1648
1883
  * @param sentStatus 发送状态
1649
1884
  */
1650
- declare function setMessageSentStatus(messageId: number, sentStatus: SentStatus): Promise<IAsyncRes>;
1885
+ declare function setMessageSentStatus(messageId: number, sentStatus: SentStatus): Promise<IAsyncRes<void>>;
1651
1886
  /**
1652
1887
  * 修改消息内容
1653
1888
  * @param messageId 消息 ID
1654
1889
  * @param content 消息 content
1655
1890
  * @param messageType 消息类型,如果设置了消息类型,会使该消息无法被搜索
1656
1891
  */
1657
- declare function setMessageContent(messageId: number, content: Object, messageType?: string): Promise<IAsyncRes>;
1892
+ declare function setMessageContent(messageId: number, content: Object, messageType?: string): Promise<IAsyncRes<void>>;
1658
1893
  /**
1659
1894
  * 删除消息
1660
1895
  * @param messageIds 消息 ID 列表, 需是同一会话的消息
1661
1896
  */
1662
- declare function deleteMessages(messageIds: number[]): Promise<IAsyncRes>;
1897
+ declare function deleteMessages(messageIds: number[]): Promise<IAsyncRes<void>>;
1663
1898
  /**
1664
1899
  * 清空会话下历史消息
1665
1900
  * @param conversation 会话
@@ -1722,4 +1957,4 @@ declare namespace index {
1722
1957
  };
1723
1958
  }
1724
1959
 
1725
- export { BaseMessage, _default$6 as CombineMessage, ConnectType, EventListeners, Events, _default$5 as FileMessage, _default$4 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$9 as HQVoiceMessage, IAReceivedConversation, IAReceivedMessage, ICombineMessageBody, IConversationEvent, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadHooks, IUploadMessageOption, IUserInfo, IVoiceMessageBody, _default$a as ImageMessage, _default$2 as LocationMessage, MentionedInfo$1 as MentionedInfo, MentionedInfo as MentionedInfoBody, MessageConstructor, MessageType, _default$1 as ReferenceMessage, _default as RichContentMessage, SentStatus, _default$8 as SightMessage, _default$7 as TextMessage, _default$3 as VoiceMessage, __addSDKVersion, addConversationsToTag, addEventListener, addTag, addToBlacklist, bindRTCRoomForChatroom, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, disconnect, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationState, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList$1 as getConversationList, getConversationNotificationLevel, getConversationNotificationStatus, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getFileToken, getFileUrl, getFirstUnreadMessage, getHistoryMessages, getMessage, getMessageReader, getRemoteHistoryMessages, getServerTime, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, init, insertMessage$1 as insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, modifyMessage, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchMessages$1 as searchMessages, sendFileMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setMessageReceivedStatus$1 as setMessageReceivedStatus, setUltraGroupDefaultNotificationLevel, updateExpansionForUltraGroupMessage, updateMessageExpansion, updateTag };
1960
+ export { BaseMessage, _default$6 as CombineMessage, ConnectType, EventListeners, Events, _default$5 as FileMessage, _default$4 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$9 as HQVoiceMessage, IAReceivedConversation, IAReceivedMessage, ICombineMessageBody, IConversationEvent, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadHooks, IUploadMessageOption, IUserInfo, IVoiceMessageBody, _default$a as ImageMessage, _default$2 as LocationMessage, MentionedInfo$1 as MentionedInfo, MentionedInfo as MentionedInfoBody, MessageConstructor, MessageType, _default$1 as ReferenceMessage, _default as RichContentMessage, SentStatus, _default$8 as SightMessage, _default$7 as TextMessage, _default$3 as VoiceMessage, __addSDKVersion, addConversationsToTag, addEventListener, addTag, addToBlacklist, bindRTCRoomForChatroom, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, destroy, disconnect, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationState, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList$1 as getConversationList, getConversationNotificationLevel, getConversationNotificationStatus, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getFileToken, getFileUrl, getFirstUnreadMessage, getHistoryMessages, getMessage, getMessageReader, getRemoteHistoryMessages, getServerTime, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, init, insertMessage$1 as insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, modifyMessage, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchMessages$1 as searchMessages, sendFileMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setMessageReceivedStatus$1 as setMessageReceivedStatus, setUltraGroupDefaultNotificationLevel, updateExpansionForUltraGroupMessage, updateMessageExpansion, updateTag };