@rongcloud/imlib-v2-adapter 5.30.0 → 5.30.1-enterprise-alpha.1

package/index.d.ts

@@ -1,5 +1,5 @@
-import { IPushConfig, IUserProfile, ConversationType, MessageDirection, SentStatus, ReceivedStatus, IReadReceiptInfo, IReadReceiptResponseInfo, IConversationTag, LogLevel, EnableLogL, RCConnectionStatus, ErrorCode, ITypingMessage, IBlockedMessageInfo, IChatroomListenerData, ILogger, APIContext, AppStorage, IMessageReaderResponse, IInsertMessage, NotificationStatus, IRemoveChatroomEntry, RTCMode, IPluginGenerator, INaviInfo, IChatroomEntry, IChatroomEntries, FileType, IUploadAuth, UploadMethod, ITagParam, ITagInfo, MentionedType as MentionedType$1 } from '@rongcloud/engine';
-export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationTag, IDeletedExpansion, IEventListener, IExpansionListenerData, IGooglePushConfig, IInsertMessage, IMessageReader, IMessageReaderResponse, IPushConfig, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatroomEntry, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUpdatedExpansion, IUploadAuth, IUserProfile, IiOSPushConfig, LogL, LogLevel, LogSource, MentionedInfo as MentionedInfoBody, MessageBlockType, MessageDirection, NotificationStatus, RCConnectionStatus, RTCApiType, RTCMode, ReceivedStatus, SentStatus, UploadMethod, logger } from '@rongcloud/engine';
+import { IPushConfig, IUserProfile, ConversationType, MessageDirection, SentStatus, ReceivedStatus, IReadReceiptInfo, IReadReceiptResponseInfo, IExtraDataKeyInMessage, IUserExtraKeyInMessage, IConversationTag, LogLevel, EnableLogL, RCConnectionStatus, ErrorCode, ITypingMessage, IBlockedMessageInfo, IChatroomListenerData, ReadReceiptResponseV5, ILogger, APIContext, AppStorage, IMessageReaderResponse, IInsertMessage, NotificationStatus, IRemoveChatroomEntry, RTCMode, IPluginGenerator, INaviInfo, IChatroomEntry, IChatroomEntries, FileType, IUploadAuth, UploadMethod, ITagParam, ITagInfo, AppSettings, IConversationIdentifier, RCResult, ReadReceiptInfoV5, IMessageIdentifier, ReadReceiptUsersOption, ReadReceiptUsersResult, MentionedType as MentionedType$1 } from '@rongcloud/engine';
+export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, GroupReadReceiptVersion, IAndroidPushConfig, IAsyncRes, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationIdentifier, IConversationTag, IDeletedExpansion, IEventListener, IExpansionListenerData, IExtraDataKeyInMessage, IGooglePushConfig, IHarmonyOSPushConfig, IInsertMessage, IMentionedInfoKeyInMessage, IMessageIdentifier, IMessageReader, IMessageReaderResponse, IPushConfig, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatroomEntry, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUpdatedExpansion, IUploadAuth, IUserExtraKeyInMessage, IUserProfile, IiOSPushConfig, InterruptionLevel, LogL, LogLevel, LogSource, MentionedInfo as MentionedInfoBody, MessageBlockType, MessageDirection, NotificationStatus, RCConnectionStatus, RTCApiType, RTCMode, ReadReceiptInfoV5, ReadReceiptResponseV5, ReadReceiptUsersOption, ReadReceiptUsersResult, ReceivedStatus, SentStatus, UploadMethod, UserType, logger } from '@rongcloud/engine';
 
 declare enum GetChatRoomType {
     NONE = 0,
@@ -21,7 +21,7 @@ interface ISendOptionsV2 {
      * @description
      * 当值为 `true` 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒
      */
-    disableNotification: boolean;
+    disableNotification?: boolean;
     /**
      * 消息是否支持拓展内容
      */
@@ -35,7 +35,7 @@ interface ISendOptionsV2 {
     /**
      * 过滤黑/白名单
     */
-    isFilerWhiteBlacklist: boolean;
+    isFilerWhiteBlacklist?: boolean;
     /**
      * 推送扩展消息
      */
@@ -57,6 +57,11 @@ interface ISendOptionsV2 {
      * 仅 electron 中有效。
      */
     resendMessageId?: number;
+    /**
+     * 是否需要回执，仅支持单群聊会话类型内有效，需要开启已读 v5 功能开关
+     * @since 5.34.0
+     */
+    needReceipt?: boolean;
 }
 interface IRecallOptionsV2 {
     /**
@@ -64,7 +69,7 @@ interface IRecallOptionsV2 {
      * @description
      * 当值为 `true` 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒
      */
-    disableNotification: boolean;
+    disableNotification?: boolean;
     /**
      * 推送扩展消息
      */
@@ -79,7 +84,7 @@ interface IRecallOptionsV2 {
     user?: IUserProfile;
 }
 /**
- * v2 版本中要吐给应用层的消息结构
+ * v2 版本消息结构
  */
 interface IReceivedMessageV2 {
     receiptResponse?: any;
@@ -111,6 +116,16 @@ interface IReceivedMessageV2 {
      */
     readReceiptInfo?: IReadReceiptInfo | IReadReceiptResponseInfo;
     pushConfig?: IPushConfig;
+    /**
+     * 是否需要回执，仅支持单群聊会话类型内有效
+     * @since 5.34.0
+     */
+    needReceipt?: boolean;
+    /**
+     * 是否已发送回执，仅获取历史消息列表时有效；仅单群聊会话类型内有效
+     * @since 5.34.0
+     */
+    sendReceipt?: boolean;
 }
 /**
  * @todo 非直接对用户暴露的数据类
@@ -124,32 +139,14 @@ declare class BaseMessage<T = any> {
     readonly isCounted: boolean;
     constructor(messageType: string, objectName: string, content: T, isPersited?: boolean, isCounted?: boolean);
 }
-interface IExtraData {
-    /**
-     * 消息中的附加信息
-     */
-    extra?: string;
-}
-interface IUserInfo {
-    user?: {
-        /**
-         * 用户 ID
-         */
-        id?: string;
-        /**
-         * 用户名
-         */
-        name?: string;
-        /**
-         * 用户头像地址
-         */
-        portraitUri?: string;
-        /**
-         * user info 中附加信息
-         */
-        extra?: string;
-    };
-}
+/**
+ * @deprecated - 已废弃，请使用 `IExtraDataKeyInMessage` 替代
+ */
+declare type IExtraData = IExtraDataKeyInMessage;
+/**
+ * @deprecated - 已废弃，请使用 `IUserExtraKeyInMessage` 替代
+ */
+declare type IUserInfo = IUserExtraKeyInMessage;
 interface IBurnDuration {
     /**
      * 阅后即焚时间间隔
@@ -230,6 +227,7 @@ interface IInitOption {
     navi?: string;
     /**
      * 私有云部署 API 地址，公有云可传空
+     * @deprecated 该参数已废弃，无用参数。
      */
     api?: string;
     /**
@@ -607,6 +605,37 @@ interface IIMClientOptions {
      */
     readReceiptTimeout: number;
 }
+/**
+ * 消息已读回执监听器
+ * @since 5.34.0
+ */
+interface IMessageReadReceiptV5Listener {
+    /**
+     * 回执接收监听。
+     * @param responses 消息已读回执信息。
+     */
+    onMessageReceiptResponse(responses: ReadReceiptResponseV5[]): void | Promise<void>;
+}
+
+declare class MessageTag {
+    /**
+     * 是否计数
+     */
+    isCounted: boolean;
+    /**
+     * 是否存储
+     */
+    isPersited: boolean;
+    constructor(
+    /**
+     * 是否计数
+     */
+    isCounted: boolean, 
+    /**
+     * 是否存储
+     */
+    isPersited: boolean);
+}
 
 declare class ChannelClient {
     private readonly logger;
@@ -933,15 +962,115 @@ declare type RTCRoomOption = {
     mode: RTCMode;
     broadcastType: number;
 };
-declare class IMClient {
-    private readonly _context;
+declare type ICallLibReceivedMsgListener = {
+    onReceived?: (msg: IReceivedMessageV2) => void;
+};
+declare class RongIMClient {
+    private readonly _ctx;
     private readonly _options;
     private readonly logger;
     private readonly _storage;
+    /**
+     * 初始化 IM SDK
+     * @param appkey
+     * @param _ 该参数已废弃，为保持向前兼容，保留占位参数
+     * @param options
+     */
+    static init(appkey: string, _: any, options?: IInitOption): void;
+    /**
+     * 单例模式，用于获取 IMClient 实例
+     */
+    static getInstance(): RongIMClient;
+    /**
+     * @deprecated 请使用 `onConnectionStatusChange` 替代该方法
+     */
+    static setConnectionStatusListener(_: IConnectionStatusListener): void;
+    /**
+     * 添加连接监听器
+     */
+    static onConnectionStatusChange(listener: IConnectionStatusListener): void;
+    /**
+     * 添加消息监听器
+     * @param listener
+     */
+    static setOnReceiveMessageListener(listener: IReceiveMessageListener): void;
+    /**
+     * 会话状态监听器
+     * @param listener
+    */
+    static setConversationStatusListener(listener: IConversationStatusListener): void;
+    /**
+     * 消息扩展监听
+    */
+    static setMessageExpansionListener(listener: IMessageExpansionListener): void;
+    /**
+     * tag 监听
+     */
+    static setTagListener(listener: ITagListener): void;
+    /**
+     * 会话中 tag 状态监听
+     */
+    static setConversationTagListener(listener: ITagListener): void;
+    /**
+     * 用于拉取完毕监听
+     */
+    static setPullOffLineFinished(listener: IPullFinishedListener): void;
+    /**
+     * typing 监听
+     */
+    static setTypingStatusListener(listenner: ITypingListener): void;
+    /**
+     * 敏感词监听
+     */
+    static setMessageBlockedListener(listenner: IMessageBlockedListener): void;
+    /**
+     * 聊天室信息监听
+     */
+    static setChatRoomStatusListener(listenner: IChatRoomListener): void;
+    /**
+      * 连接 IM 服务
+      * @param token 用于连接鉴权
+      * @param callback 连接状态回调
+      */
+    static connect(token: string, callback: IConnectCallback, reconnectKickEnable?: boolean): Promise<void>;
+    /**
+     * 重连 im 服务
+     * @description Web IM 3.0 开始 SDK 内部会进行自动重连，不需要主动调用此方法。此方法建议主动断开连接后，再次链接时调用。
+     * @param callback 重连状态回调
+     * @param options 该参数已废弃
+     */
+    static reconnect(callback: IConnectCallback, options?: IReconnectOptions, reconnectKickEnable?: boolean): void;
+    /**
+      * 已注册的消息类型定义
+      */
+    static RegisterMessage: {
+        [messageType: string]: ThisType<BaseMessage<any>>;
+    };
+    /**
+     * 已注册的消息类型映射
+    */
+    static RegisterMessageTypeMapping: {
+        [key: string]: string;
+    };
+    /**
+     * 根据 messageType 获取对应的消息 objectName 值
+     * 若无记录，则返回原字符串
+     * @param messageType
+     * @todo 优化算法
+     */
+    static getMessageObjectName(messageType: string): string;
+    /**
+      * 注册自定义消息
+      * @param messageType v2 中定义的消息类型，如：TextMessage
+      * @param objectName 与移动端对齐的消息结构类型，如：RC:TxtMsg
+      * @param mesasgeTag 是否存储或计数标记
+      * @param searchProps 消息属性名称列表
+      */
+    static registerMessageType(messageType: string, objectName: string, mesasgeTag: MessageTag, searchProps: string[]): void;
     private readonly _channelClient;
     private readonly _defaultChannelClient;
     private readonly _isCPPMode;
-    constructor(_context: APIContext, _options: IIMClientOptions, logger: ILogger, _storage: AppStorage);
+    constructor(_ctx: APIContext, _options: IIMClientOptions, logger: ILogger, _storage: AppStorage);
     /**
      * 协议栈方法校验
      */
@@ -1660,130 +1789,55 @@ declare class IMClient {
      * 获取服务器时间
      */
     getServerTime(): number;
-}
-
-declare class MessageTag {
-    /**
-     * 是否计数
-     */
-    isCounted: boolean;
-    /**
-     * 是否存储
-     */
-    isPersited: boolean;
-    constructor(
-    /**
-     * 是否计数
-     */
-    isCounted: boolean, 
-    /**
-     * 是否存储
-     */
-    isPersited: boolean);
-}
-
-declare type ICallLibReceivedMsgListener = {
-    onReceived?: (msg: IReceivedMessageV2) => void;
-};
-declare const _default$j: {
-    /**
-      * 初始化 IM SDK
-      * @param appkey
-      * @param _ 该参数已废弃，为保持向前兼容，保留占位参数
-      * @param options
-      */
-    init(appkey: string, _: void, options?: IInitOption): void;
-    /**
-     * 单例模式，用于获取 IMClient 实例
-     */
-    getInstance(): IMClient;
-    /**
-     * @deprecated 请使用 `onConnectionStatusChange` 替代该方法
-     */
-    setConnectionStatusListener(_: IConnectionStatusListener): never;
     /**
-     * 添加连接监听器
+     * 获取应用设置，需登录后调用，否则将返回 null
+     * @since 5.34.0
      */
-    onConnectionStatusChange(listener: IConnectionStatusListener): void;
-    /**
-      * 添加消息监听器
-      * @param listener
-      */
-    setOnReceiveMessageListener(listener: IReceiveMessageListener): void;
-    /**
-     * 会话状态监听器
-     * @param listener
-    */
-    setConversationStatusListener(listener: IConversationStatusListener): void;
+    getAppSettings(): AppSettings | null;
     /**
-     * 消息扩展监听
-    */
-    setMessageExpansionListener(listener: IMessageExpansionListener): void;
-    /**
-     * tag 监听
+     * 添加消息已读回执监听器
+     * @param listener 消息已读回执监听器
+     * @since 5.34.0
      */
-    setTagListener(listener: ITagListener): void;
+    static setMessageReadReceiptV5Listener(listener: IMessageReadReceiptV5Listener): void;
     /**
-     * 会话中 tag 状态监听
+     * 发送已读回执（V5 版本）
+     * @since 5.34.0
+     * @param identifier 会话信息
+     * @param messageUIds 消息 UId 列表，长度限制为 1-100
      */
-    setConversationTagListener(listener: ITagListener): void;
+    sendReadReceiptResponseV5(identifier: IConversationIdentifier, messageUIds: string[]): Promise<RCResult>;
     /**
-     * 用于拉取完毕监听
-     */
-    setPullOffLineFinished(listener: IPullFinishedListener): void;
-    /**
-     * typing 监听
-     */
-    setTypingStatusListener(listenner: ITypingListener): void;
-    /**
-     * 敏感词监听
+     * 获取消息已读人数信息（V5 版本）
+     * @since 5.34.0
+     * @param conversation 会话信息
+     * @param messageUIds 消息 UId 列表，长度限制为 1-100
      */
-    setMessageBlockedListener(listenner: IMessageBlockedListener): void;
+    getMessageReadReceiptInfoV5(identifier: IConversationIdentifier, messageUIds: Array<string>): Promise<RCResult<ReadReceiptInfoV5[]>>;
     /**
-     * 聊天室信息监听
+     * 跨会话批量获取消息已读人数信息（V5 版本）
+     * @since 5.34.0
+     * @param messageIds 消息标识列表
+     * @returns 消息已读人数信息列表
      */
-    setChatRoomStatusListener(listenner: IChatRoomListener): void;
+    getMessageReadReceiptInfoV5ByIdentifiers(messageIds: IMessageIdentifier[]): Promise<RCResult<ReadReceiptInfoV5[]>>;
     /**
-      * 连接 IM 服务
-      * @param token 用于连接鉴权
-      * @param callback 连接状态回调
-      */
-    connect(token: string, callback: IConnectCallback, reconnectKickEnable?: boolean | undefined): Promise<void>;
-    /**
-     * 重连 im 服务
-     * @description Web IM 3.0 开始 SDK 内部会进行自动重连，不需要主动调用此方法。此方法建议主动断开连接后，再次链接时调用。
-     * @param callback 重连状态回调
-     * @param options 该参数已废弃
+     * 分页查询消息已读、未读成员列表
+     * @param identifier 会话标识
+     * @param messageUid 消息 UId
+     * @param option 分页选项
+     * @since 5.34.0
      */
-    reconnect(callback: IConnectCallback, options?: IReconnectOptions | undefined, reconnectKickEnable?: boolean | undefined): void;
-    /**
-      * 已注册的消息类型定义
-      */
-    RegisterMessage: {
-        [messageType: string]: ThisType<BaseMessage<any>>;
-    };
+    getMessagesReadReceiptUsersByPageV5(identifier: IConversationIdentifier, messageUId: string, option: ReadReceiptUsersOption): Promise<RCResult<ReadReceiptUsersResult>>;
     /**
-     * 已注册的消息类型映射
-    */
-    RegisterMessageTypeMapping: {
-        [key: string]: string;
-    };
-    /**
-     * 根据 messageType 获取对应的消息 objectName 值
-     * 若无记录，则返回原字符串
-     * @param messageType
-     * @todo 优化算法
+     * 查询指定消息是否已被指定人员已读
+     * @param identifier 会话标识
+     * @param messageUId 消息 UId
+     * @param userIds 用户列表
+     * @since 5.34.0
      */
-    getMessageObjectName(messageType: string): string;
-    /**
-      * 注册自定义消息
-      * @param messageType v2 中定义的消息类型，如：TextMessage
-      * @param objectName 与移动端对齐的消息结构类型，如：RC:TxtMsg
-      * @param mesasgeTag 是否存储或计数标记
-      * @param searchProps 消息属性名称列表
-      */
-    registerMessageType(messageType: string, objectName: string, mesasgeTag: MessageTag, searchProps: string[]): void;
-};
+    getMessagesReadReceiptByUsersV5(identifier: IConversationIdentifier, messageUId: string, userIds: Array<string>): Promise<RCResult<ReadReceiptUsersResult>>;
+}
 
 /**
  * 群组内的消息包含的 @ 数据
@@ -1795,16 +1849,13 @@ declare class MentionedInfo {
     constructor(type?: MentionedType$1 | undefined, userIdList?: string[] | undefined, mentionedContent?: string | undefined);
 }
 interface IMentionedInfo {
-    /** [EN]
-     * Mentions in group messages
-     */
     /**
      * 群组消息中的 @ 信息
      */
     mentionedInfo?: MentionedInfo;
 }
 
-interface TextMessageContent extends IMentionedInfo, IExtraData, IUserInfo, IBurnDuration {
+interface TextMessageContent extends IExtraDataKeyInMessage, IUserExtraKeyInMessage, IBurnDuration, IMentionedInfo {
     /**
      * 文本消息内容
      */
@@ -2275,4 +2326,4 @@ declare const ConnectionState: {
     LICENSE_EXPIRED: number;
 };
 
-export { AcceptMessage, BaseMessage, ChannelClient, ConnectionState, _default$b as FileMessage, _default$9 as GIFMessage, GetChatRoomType, _default$c as HQVoiceMessage, HungupMessage, ICallLibReceivedMsgListener, ICallback, IChatRoomListener, IConnectCallback, IConnectionStatusListener, IV2Conversation as IConversation, IConversationOption, IConversationStatus, IConversationStatusListener, IDeleteByTime, IDeleteMessge, IGetFileUrl, IIMClientOptions, IInitOption, IInsertOptions, IMClient, IMessageBlockedListener, IMessageExpansionListener, IPullFinishedListener, IRecallOptionsV2, IReceiveMessageListener, IReceivedConversationStatus, IReceivedDeletedExpansion, IReceivedMessageV2, IReceivedUpdatedExpansion, IReconnectOptions, IRemoveChatRoomEntryOption, ISendCallback, ISendOptionsV2, ITagListener, ITypingListener, IV2ChatRoomInfo, IV2ConversationContainTag, _default$f as ImageMessage, InviteMessage, _default$h as LocationMessage, MediaModifyMessage, MemberModifyMessage, MentionedInfo, MentionedType, Message, MessageTag, _default as PublicServiceCommandMessage, _default$1 as PublicServiceMultiRichContentMessage, _default$2 as PublicServiceRichContentMessage, _default$5 as RCCombineMessage, RTCRoomOption, _default$8 as ReadReceiptMessage, _default$7 as ReadReceiptRequestMessage, _default$6 as ReadReceiptResponseMessage, _default$3 as ReferenceMessage, _default$e as RichContentMessage, RingingMessage, _default$j as RongIMClient, _default$a as SightMessage, SummaryMessage, _default$4 as SyncReadStatusMessage, _default$i as TextMessage, _default$g as TypingStatusMessage, VoIPMediaType, _default$d as VoiceMessage };
+export { AcceptMessage, BaseMessage, ChannelClient, ConnectionState, _default$b as FileMessage, _default$9 as GIFMessage, GetChatRoomType, _default$c as HQVoiceMessage, HungupMessage, ICallLibReceivedMsgListener, ICallback, IChatRoomListener, IConnectCallback, IConnectionStatusListener, IV2Conversation as IConversation, IConversationOption, IConversationStatus, IConversationStatusListener, IDeleteByTime, IDeleteMessge, IGetFileUrl, IIMClientOptions, IInitOption, IInsertOptions, RongIMClient as IMClient, IMessageBlockedListener, IMessageExpansionListener, IMessageReadReceiptV5Listener, IPullFinishedListener, IRecallOptionsV2, IReceiveMessageListener, IReceivedConversationStatus, IReceivedDeletedExpansion, IReceivedMessageV2, IReceivedUpdatedExpansion, IReconnectOptions, IRemoveChatRoomEntryOption, ISendCallback, ISendOptionsV2, ITagListener, ITypingListener, IV2ChatRoomInfo, IV2Conversation, IV2ConversationContainTag, _default$f as ImageMessage, InviteMessage, _default$h as LocationMessage, MediaModifyMessage, MemberModifyMessage, MentionedInfo, MentionedType, Message, MessageTag, _default as PublicServiceCommandMessage, _default$1 as PublicServiceMultiRichContentMessage, _default$2 as PublicServiceRichContentMessage, _default$5 as RCCombineMessage, RTCRoomOption, _default$8 as ReadReceiptMessage, _default$7 as ReadReceiptRequestMessage, _default$6 as ReadReceiptResponseMessage, _default$3 as ReferenceMessage, _default$e as RichContentMessage, RingingMessage, RongIMClient, _default$a as SightMessage, SummaryMessage, _default$4 as SyncReadStatusMessage, _default$i as TextMessage, TextMessageContent, _default$g as TypingStatusMessage, VoIPMediaType, _default$d as VoiceMessage };