@rongcloud/imlib-next 5.9.2 → 5.9.4

package/index.d.ts

@@ -1,5 +1,5 @@
-import { FileType, APIContext, LogLevel, EnableLogL, IRuntime, AreaCode, ConversationType, MessageDirection, ReceivedStatus, SentStatus, IReadReceiptInfo, IPushConfig, UltraGroupChannelType, RCConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUltraUnreadMsg, IUserProfile, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IMessageDeliver, IGroupMessageDeliverStatus, IReadReceiptData, ISyncReadStatusData, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraGroupUnreadInfo, IChatroomJoinResponse, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRemoveChatRoomEntries, IRTCRoomBindOption, MentionedInfoBody, ICombineV2MessageContent, IMessageReadReceiptV4Response, IGroupReadReceiptData, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, IReceivedMessage, IReceivedConversation, ITagParam, ITagInfo, IConversationTag, IUploadAuth, IDownloadAuth, UploadMethod, IInsertMessage, IGroupMessageDeliverInfo, IProxy, IPromiseResult, IResponse } from '@rongcloud/engine';
-export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineV2MessageContent, ICombinedMessage, IConversationIdentifier, IConversationOption, IConversationTag, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEventListener, IExpansionListenerData, IFirstUnreadMessageInfo, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IMessageDeliver, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPrivateReadReceiptData, IPromiseResult, IProxy, IPushConfig, IRTCRoomBindOption, IReadReceiptData, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, ISyncReadStatusData, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IiOSPushConfig, InterruptionLevel, LogL, LogLevel, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, OperateStatus, PushImportanceHonor, RCConnectionStatus, ReceivedStatus, SentStatus, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
+import { FileType, APIContext, LogLevel, EnableLogL, IRuntime, AreaCode, ConversationType, MessageDirection, ReceivedStatus, IReceivedStatusInfo, SentStatus, IReadReceiptResponseInfo, IReadReceiptInfo, IPushConfig, UltraGroupChannelType, RCConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUltraUnreadMsg, IUserProfile, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IMessageDeliver, IGroupMessageDeliverStatus, IReadReceiptData, ISyncReadStatusData, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraGroupUnreadInfo, IChatroomJoinResponse, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRTCRoomBindOption, MentionedInfoBody, ICombineV2MessageContent, IMessageReadReceiptV4Response, IGroupReadReceiptData, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, IReceivedMessage, IReceivedConversation, ITagParam, ITagInfo, IConversationTag, IUploadAuth, IDownloadAuth, UploadMethod, IInsertMessage, IGroupMessageDeliverInfo, IProxy, IPromiseResult, IResponse } from '@rongcloud/engine';
+export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineV2MessageContent, ICombinedMessage, IConversationIdentifier, IConversationOption, IConversationTag, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEventListener, IExpansionListenerData, IFirstUnreadMessageInfo, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IMessageDeliver, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPrivateReadReceiptData, IPromiseResult, IProxy, IPushConfig, IRTCRoomBindOption, IReadReceiptData, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, ISyncReadStatusData, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IiOSPushConfig, InterruptionLevel, LogL, LogLevel, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, OperateStatus, PushImportanceHonor, RCConnectionStatus, ReceivedStatus, SentStatus, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
 
 interface IThumbnailConfig {
     maxHeight?: number;
@@ -200,7 +200,7 @@ interface IAReceivedMessage {
      */
     isCounted: boolean;
     /**
-     * 是否为离线消息
+     * 是否为离线消息, 在超级群会话中不适用
      */
     isOffLineMessage: boolean;
     /**
@@ -228,17 +228,24 @@ interface IAReceivedMessage {
     } | null;
     /**
      * 消息接收状态
+     * 只能表示单一状态，推荐使用 receivedStatusInfo 来判断接收消息状态
+     * @deprecated
     */
     receivedStatus: ReceivedStatus;
+    /**
+     * 消息接收状态详情
+     * 推荐使用, receivedStatusInfo 值更详细，能同时表示多个接收状态
+     */
+    receivedStatusInfo: IReceivedStatusInfo;
     /**
      * 消息的发送状态，Electron 平台可由 SDK 内自动更新和用户设置,
      * web 端仅支持 SDK 内更新为 发送中、已发送和发送失败
      */
     sentStatus?: SentStatus;
     /**
-     * 消息已读回执信息，导航配置grpRRVer=1时群组类型消息内存在, 其他情况为undefined
+     * 群已读回执信息(V1 版本为 IReadReceiptResponseInfo, V4 版本为 IReadReceiptInfo）
      */
-    readReceiptInfo?: IReadReceiptInfo;
+    readReceiptInfo?: IReadReceiptResponseInfo | IReadReceiptInfo;
     /**
      * 推送扩展
      */
@@ -483,6 +490,14 @@ declare enum Events {
    */
     USER_GROUP_STATUS = "USER_GROUP_STATUS"
 }
+/**
+ * 消息审核状态
+ * @category Enum
+*/
+declare enum MessageAuditType {
+    DISALLOW = 0,
+    ALLOW = 1
+}
 
 /**
  * 上传任务
@@ -656,6 +671,7 @@ interface ISendMessageOptions {
      * @description
      * 1. 状态消息只有 pub，没有 ack 应答
      * 2. 状态消息默认不存储，不计数，`isPersited` 与 `isCounted` 配置将失效
+     * @deprecated 请在注册消息时设置消息类型是否是状态消息
      */
     isStatusMessage?: boolean;
     /**
@@ -724,6 +740,10 @@ interface ISendMessageOptions {
      * 正常发消息时无需传该参数。
      */
     messageId?: number;
+    /**
+     * 消息审核配置
+     */
+    auditInfo?: IAuditInfo;
 }
 /**
  * 文件消息配置
@@ -799,6 +819,26 @@ interface IExtraData {
      */
     extra?: string;
 }
+/**
+ * @category Interface
+ * 消息审核配置
+ */
+interface IAuditInfo {
+    audit?: {
+        /**
+         * 发送方指定是否送审, 1:送审（默认值），0:不送审
+         */
+        auditType?: MessageAuditType;
+        /**
+         * 项目名称, 默认为空字符串
+         */
+        project?: string;
+        /**
+         * 策略映射字段
+         */
+        strategy?: string;
+    };
+}
 /**
  * @category Interface
  */
@@ -888,6 +928,10 @@ interface IReadReceiptReceivedEvent {
     * 消息发送时间
     */
     sentTime: number;
+    /**
+     * 发送者ID
+     */
+    sendUserId: string;
 }
 interface IMessageReceiptRequestEvent {
     /**
@@ -1206,8 +1250,12 @@ declare function getBlockedConversationList(): Promise<IAsyncRes<IBaseConversati
 /**
  * 设置会话是否置顶
  * @category 会话
+ * @param options 回话信息
+ * @param isTop 置顶状态
+ * @param isUpdateTime 是否更新会话操作时间，默认为更新，仅私有云环境有效
+ * @returns
  */
-declare function setConversationToTop(options: IConversationOption, isTop?: boolean): Promise<IAsyncRes<void>>;
+declare function setConversationToTop(options: IConversationOption, isTop?: boolean, isUpdateTime?: boolean): Promise<IAsyncRes<void>>;
 /**
  * 批量设置会话置顶
  * @param conversations 会话数组, 最大数量为 20
@@ -1454,7 +1502,10 @@ declare function removeChatRoomEntry(targetId: string, options: IRemoveChatRoomE
  * @param entries[] 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
  * @param notificationExtra? RC:chrmKVNotiMsg 通知消息中携带的附加信息
  */
-declare function removeChatRoomEntries(targetId: string, options: IRemoveChatRoomEntries): Promise<IAsyncRes<void>>;
+declare function removeChatRoomEntries(targetId: string, options: {
+    entries: string[];
+    notificationExtra?: string;
+}): Promise<IAsyncRes<void>>;
 /**
  * 强制删除聊天室内的任意属性
  * @category 聊天室
@@ -1523,7 +1574,7 @@ interface IMentionedInfo {
  * 图片消息
  * @category Interface
  */
-interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
+interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo, IAuditInfo {
     /**
     * 图片的略缩图
     * @description
@@ -1543,7 +1594,7 @@ declare const _default$e: MessageConstructor<IImageMessageBody>;
  * 图片消息
  * @category Interface
  */
-interface IHQVoiceMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
+interface IHQVoiceMessageBody extends IUserInfo, IExtraData, IMentionedInfo, IAuditInfo {
     /**
      * 远程媒体资源地址
      */
@@ -1563,7 +1614,7 @@ declare const _default$d: MessageConstructor<IHQVoiceMessageBody>;
  * 短视频消息
  * @category Interface
  */
-interface ISightMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
+interface ISightMessageBody extends IExtraData, IMentionedInfo, IUserInfo, IAuditInfo {
     /**
      * 远程视频资源 url 地址
      */
@@ -1592,7 +1643,7 @@ declare const _default$c: MessageConstructor<ISightMessageBody>;
  * 文本消息
  * @category Interface
  */
-interface ITextMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
+interface ITextMessageBody extends IUserInfo, IExtraData, IMentionedInfo, IAuditInfo {
     /**
      * 文本消息内容
      */
@@ -1654,7 +1705,7 @@ declare const _default$8: MessageConstructor<IFileMessageBody>;
 /**
  * @category Interface
  */
-interface IGIFMessageBody extends IExtraData, IUserInfo, IMentionedInfo {
+interface IGIFMessageBody extends IExtraData, IUserInfo, IMentionedInfo, IAuditInfo {
     /**
      * GIF 图片文件大小，单位为 Byte
      */
@@ -1677,7 +1728,7 @@ declare const _default$7: MessageConstructor<IGIFMessageBody>;
 /**
  * @category Interface
  */
-interface IVoiceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
+interface IVoiceMessageBody extends IExtraData, IMentionedInfo, IUserInfo, IAuditInfo {
     content: string;
     duration: number;
     extra: string;
@@ -1710,7 +1761,7 @@ declare const _default$5: MessageConstructor<ILocationMessageBody>;
 /**
  * @category Interface
  */
-interface IReferenceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
+interface IReferenceMessageBody extends IExtraData, IMentionedInfo, IUserInfo, IAuditInfo {
     /**
      * 被引用消息的发送用户 Id
      */
@@ -1816,7 +1867,7 @@ declare function sendMessage(conversation: IConversationOption, message: BaseMes
 declare function sendTextMessage(conversation: IConversationOption, messageBody: ITextMessageBody, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
 declare type ISendBody = IUserInfo & IExtraData & {
     file: File;
-} & IMentionedInfo;
+} & IMentionedInfo & IAuditInfo;
 declare type ISendFileMessageOptions = ISendBody;
 /**
  * 发送文件消息
@@ -1883,7 +1934,7 @@ declare function sendReadReceiptResponse(targetId: string, messageUIds: string[]
  *  @param messageList 要回执的消息列表，结构为： \{senderUserId: [messageUId1, messageUId2]\}
  *  @param channelId
  */
-declare function sendReadReceiptResponseV2(targetId: string, messageList: {
+declare function sendReadReceiptResponseV2(targetId: string, messageList?: {
     [senderUserId: string]: string[];
 }, channelId?: string): Promise<IAsyncRes<void>>;
 /**
@@ -2075,7 +2126,7 @@ declare function getMessageReader(targetId: string, messageUId: string, channelI
  * @param isPersited  是否存储
  * @param isCounted   是否计数
  * @param searchProps  可搜索的属性
- * @param isStatusMessage  是否状态消息
+ * @param isStatusMessage  是否状态消息，状态消息不计数，不存储，仅在线能收到
 */
 declare function registerMessageType<T>(messageType: string, isPersited: boolean, isCounted: boolean, searchProps?: string[], isStatusMessage?: boolean): new (content: T) => BaseMessage<T>;
 /**
@@ -2351,7 +2402,7 @@ declare function getAllConversationList(channelId?: string): Promise<IAsyncRes<I
  * @param count 数量
  * @param channelId 频道 ID，不传则获取全部频道 ID 类型
  */
-declare function getConversationList(startTime: number, count: number, channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>;
+declare function getConversationList(startTime: number, count: number, channelId?: string, topPriority?: boolean): Promise<IAsyncRes<IAReceivedConversation[]>>;
 /**
  * 根据消息内容搜索会话列表
  * @param keyword 搜索关键字
@@ -2412,8 +2463,15 @@ declare function setMessageStatusToRead(conversation: IConversationOption, times
  * 设置对方发送的消息 自己的接受状态
  * @param messageId 消息 ID
  * @param receivedStatus 接受状态
+ * @deprecated 建议使用 setMessageReceivedStatusInfo, 支持设置多种状态
  */
 declare function setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<IAsyncRes<void>>;
+/**
+ * 设置对方发送的消息 自己的接受状态信息
+ * @param messageId
+ * @param receivedStatusInfo
+ */
+declare function setMessageReceivedStatusInfo(messageId: number, receivedStatusInfo: IReceivedStatusInfo): Promise<IAsyncRes<void>>;
 /**
  * 设置自己发送的消息的发送状态
  * @param messageId 消息ID
@@ -2522,7 +2580,7 @@ declare function getGroupMessageDeliverList(targetId: string, messageUId: string
  * @returns data => true: 成功，false: 失败
  *
  */
-declare function setCheckDuplicateMessage(enableCheck: boolean): Promise<IAsyncRes<boolean>>;
+declare function setCheckDuplicateMessage(enableCheck?: boolean): Promise<IAsyncRes<boolean>>;
 
 /**
  * 清除本地数据, 包括消息列表、会话列表、拉取消息的时间戳
@@ -2544,6 +2602,7 @@ declare const index_searchMessagesByUser: typeof searchMessagesByUser;
 declare const index_getHistoryMessagesByMessageTypes: typeof getHistoryMessagesByMessageTypes;
 declare const index_setMessageStatusToRead: typeof setMessageStatusToRead;
 declare const index_setMessageReceivedStatus: typeof setMessageReceivedStatus;
+declare const index_setMessageReceivedStatusInfo: typeof setMessageReceivedStatusInfo;
 declare const index_setMessageSentStatus: typeof setMessageSentStatus;
 declare const index_setMessageContent: typeof setMessageContent;
 declare const index_deleteMessages: typeof deleteMessages;
@@ -2569,6 +2628,7 @@ declare namespace index {
     index_getHistoryMessagesByMessageTypes as getHistoryMessagesByMessageTypes,
     index_setMessageStatusToRead as setMessageStatusToRead,
     index_setMessageReceivedStatus as setMessageReceivedStatus,
+    index_setMessageReceivedStatusInfo as setMessageReceivedStatusInfo,
     index_setMessageSentStatus as setMessageSentStatus,
     index_setMessageContent as setMessageContent,
     index_deleteMessages as deleteMessages,