@rongcloud/imlib-v2-adapter 5.8.4 → 5.8.5-alpha.2

package/index.d.ts

@@ -151,6 +151,38 @@ 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;
+    };
+}
+interface IBurnDuration {
+    /**
+     * 阅后即焚时间间隔
+     */
+    burnDuration?: number;
+}
 
 interface IConversationStatus {
     /**
@@ -1762,34 +1794,220 @@ declare class MentionedInfo {
     mentionedContent?: string | undefined;
     constructor(type?: MentionedType$1 | undefined, userIdList?: string[] | undefined, mentionedContent?: string | undefined);
 }
+interface IMentionedInfo {
+    /**
+     * 群组消息中的 @ 信息
+     */
+    mentionedInfo?: MentionedInfo;
+}
 
-declare const _default$h: any;
+interface TextMessageContent extends IMentionedInfo, IExtraData, IUserInfo, IBurnDuration {
+    /**
+     * 文本消息内容
+     */
+    content: string;
+}
+declare const _default$h: new (content: TextMessageContent) => BaseMessage<TextMessageContent>;
 
-declare const _default$g: any;
+interface LocationMessageContent extends IExtraData, IMentionedInfo, IUserInfo {
+    /**
+     * 经度
+     */
+    longitude: number;
+    /**
+     * 维度
+     */
+    latitude: number;
+    /**
+     * 位置信息
+     */
+    poi: string;
+    /**
+     * 位置缩略图，图片需要是不带前缀的 base64 字符串
+     */
+    content: string;
+}
+declare const _default$g: new (content: LocationMessageContent) => BaseMessage<LocationMessageContent>;
 
-declare const _default$f: any;
+interface TypingStatusMessageOptions {
+    /**
+     * 正在输入的消息 ObjectName，可以通过各消息类型的静态属性获取，如 RongIMLib.TextMessage.ObjectName
+     */
+    typingContentType: string;
+    /**
+     * 附加信息
+     */
+    data?: string;
+}
+declare const _default$f: new (content: TypingStatusMessageOptions) => BaseMessage<TypingStatusMessageOptions>;
 
-declare const _default$e: any;
+interface ImageMessageOptions extends IExtraData, IMentionedInfo, IUserInfo, IBurnDuration {
+    /**
+     * 图片的略缩图
+     * @description
+     * 1. 必须是 base64 字符串, 图片类型为 JPG
+     * 2. base64 字符串大小不可超过 80 KB
+     * 3. 字符串前无媒体类型前缀
+     */
+    content: string;
+    /**
+     * 原图远程地址
+     */
+    imageUri: string;
+}
+declare const _default$e: new (content: ImageMessageOptions) => BaseMessage<ImageMessageOptions>;
 
-declare const _default$d: any;
+interface IArticle {
+    title: string;
+    content: string;
+    imageUri: string;
+    url: string;
+}
+interface RichContentMessageOptions extends IArticle, IExtraData, IMentionedInfo, IUserInfo {
+}
+declare const _default$d: new (content: RichContentMessageOptions) => BaseMessage<RichContentMessageOptions>;
 
-declare const _default$c: any;
+interface VoiceMessageOptions extends IExtraData, IMentionedInfo, IUserInfo, IBurnDuration {
+    content: string;
+    duration: number;
+    extra: string;
+}
+declare const _default$c: new (content: VoiceMessageOptions) => BaseMessage<VoiceMessageOptions>;
 
-declare const _default$b: any;
+interface HQVoiceMessageOptions extends IExtraData, IMentionedInfo, IBurnDuration {
+    /**
+     * 远程媒体资源地址
+     */
+    remoteUrl: string;
+    /**
+     * 编解码类型，默认为 aac 音频
+     */
+    type?: string;
+    /**
+     * 语音消息的时长，最大值为 60 （单位：秒）
+     */
+    duration: number;
+}
+declare const _default$b: new (content: HQVoiceMessageOptions) => BaseMessage<HQVoiceMessageOptions>;
 
-declare const _default$a: any;
+interface FileMessageOptions extends IExtraData, IUserInfo {
+    /**
+     * 文件名称
+     */
+    name: string;
+    /**
+     * 文件尺寸，单位: Byte
+     */
+    size: number;
+    /**
+     * 文件类型
+     */
+    type: string;
+    /**
+     * 远程文件资源地址
+     */
+    fileUrl: string;
+}
+declare const _default$a: new (content: FileMessageOptions) => BaseMessage<FileMessageOptions>;
 
-declare const _default$9: any;
+interface SightMessageOptions extends IExtraData, IMentionedInfo, IUserInfo {
+    /**
+     * 远程视频资源 url 地址
+     */
+    sightUrl: string;
+    /**
+     * 小视频首帧的缩略图进行 Base64 编码的结果值，格式为 JPG
+     * @description 注意在 Base64 进行 Encode 后需要将所有 \r\n 和 \r 和 \n 替换成空
+     */
+    content: string;
+    /**
+     * 视频时长，单位：秒
+     */
+    duration: number;
+    /**
+     * 视频尺寸，单位：Byte
+     */
+    size: number;
+    /**
+     * 视频文件名称
+     */
+    name: string;
+}
+declare const _default$9: new (content: SightMessageOptions) => BaseMessage<SightMessageOptions>;
 
-declare const _default$8: any;
+interface GIFMessageOptions extends IExtraData, IUserInfo {
+    /**
+     * GIF 图片文件大小，单位为 KB
+     */
+    gifDataSize: number;
+    /**
+     * GIF 图片资源 url 地址
+     */
+    remoteUrl: string;
+    /**
+     * 图片宽度
+     */
+    width: number;
+    /**
+     * 图片高度
+     */
+    height: number;
+}
+declare const _default$8: new (content: GIFMessageOptions) => BaseMessage<GIFMessageOptions>;
 
-declare const _default$7: any;
+interface ReadReceiptMessageContent {
+    /**
+     * 消息唯一 ID
+     */
+    messageUId: String;
+    /**
+     * 最后一条消息的发送时间
+     */
+    lastMessageSendTime: Number;
+    /**
+     * 备用，默认赋值 1 即可
+     */
+    type: String;
+}
+declare const _default$7: new (content: ReadReceiptMessageContent) => BaseMessage<ReadReceiptMessageContent>;
 
-declare const _default$6: any;
+interface ReadReceiptRequestMessageContent {
+    /**
+     * 消息唯一 ID
+     */
+    messageUId: String;
+}
+declare const _default$6: new (content: ReadReceiptRequestMessageContent) => BaseMessage<ReadReceiptRequestMessageContent>;
 
-declare const _default$5: any;
+interface ReadReceiptResponseMessageContent {
+    /**
+     * 回复已读通知信息,{userId: [messageUId]}
+     */
+    receiptMessageDic: {
+        [userId: string]: string[];
+    };
+}
+declare const _default$5: new (content: ReadReceiptResponseMessageContent) => BaseMessage<ReadReceiptResponseMessageContent>;
 
-declare const _default$4: any;
+interface CombineMessageOptions extends IExtraData, IUserInfo {
+    /**
+     * 存储在融云服务器的远端 HTML 文件路径
+    */
+    remoteUrl: string;
+    /**
+     * 在会话界面显示的合并转发消息中，前 4 条消息的用户名称
+    */
+    nameList: string;
+    /**
+     * 在会话界面显示的合并转发消息中，前 4 条消息的简略信息，与 nameList 属性相对应
+    */
+    summaryList: string;
+    /**
+     * 会话类型，目前合并转发功能支持二人会话及群聊会话，二人会话是 1 、群组会话是 3
+    */
+    conversationType: ConversationType;
+}
+declare const _default$4: new (content: CombineMessageOptions) => BaseMessage<CombineMessageOptions>;
 
 declare class Message implements IReceivedMessageV2 {
     conversationType: ConversationType;
@@ -1823,21 +2041,115 @@ declare enum VoIPMediaType {
     MEDIA_VIDEO = 2
 }
 
-declare const AcceptMessage: any;
-declare const RingingMessage: any;
-declare const SummaryMessage: any;
-declare const HungupMessage: any;
-declare const InviteMessage: any;
-declare const MediaModifyMessage: any;
-declare const MemberModifyMessage: any;
+interface AcceptMessageOption {
+    messageName: string;
+    callId: string;
+    mediaId: string;
+    mediaType: VoIPMediaType;
+    mode: string;
+    subInfo: string[];
+}
+declare const AcceptMessage: new (content: AcceptMessageOption) => BaseMessage<AcceptMessageOption>;
+interface RingingMessageOption {
+    messageName: string;
+    callId: string;
+}
+declare const RingingMessage: new (content: RingingMessageOption) => BaseMessage<RingingMessageOption>;
+interface SummaryMessageOptions {
+    messageName: string;
+    caller: string;
+    inviter: string;
+    mediaType: VoIPMediaType;
+    memberIdList: string[];
+    startTime: number;
+    connectedTime: number;
+    duration: number;
+    status: ErrorCode;
+}
+declare const SummaryMessage: new (content: SummaryMessageOptions) => BaseMessage<SummaryMessageOptions>;
+interface HungupMessageOptions {
+    messageName: string;
+    callId: string;
+    reason: string;
+    mode: string;
+    subInfo: string[];
+}
+declare const HungupMessage: new (content: HungupMessageOptions) => BaseMessage<HungupMessageOptions>;
+declare class ChannelInfo {
+    Id: string;
+    Key: string;
+    constructor(Id: string, Key: string);
+}
+interface InviteMessageOptions {
+    messageName: string;
+    mediaId: string;
+    callId: string;
+    engineType: number;
+    channelInfo: ChannelInfo;
+    mediaType: VoIPMediaType;
+    inviteUserIds: string[];
+    observerUserIds: any[];
+    extra: string;
+    mode: string;
+    subInfo: string[];
+}
+declare const InviteMessage: new (content: InviteMessageOptions) => BaseMessage<InviteMessageOptions>;
+interface MediaModifyMessageOptions {
+    messageName: string;
+    callId: string;
+    mediaType: VoIPMediaType;
+    mode: string;
+    subInfo: string[];
+}
+declare const MediaModifyMessage: new (content: MediaModifyMessageOptions) => BaseMessage<MediaModifyMessageOptions>;
+interface MemberModifyMessageOptions {
+    messageName: string;
+    modifyMemType: number;
+    callId: string;
+    caller: string;
+    engineType: number;
+    channelInfo: ChannelInfo;
+    mediaType: VoIPMediaType;
+    extra: string;
+    inviteUserIds: string[];
+    existedMemberStatusList: string[];
+    existedUserPofiles: any;
+    observerUserIds: any;
+    mode: string;
+    subInfo: string[];
+}
+declare const MemberModifyMessage: new (content: MemberModifyMessageOptions) => BaseMessage<MemberModifyMessageOptions>;
 
-declare const _default$3: any;
+interface SyncReadStatusMessage {
+    /**
+     * 最后一条消息时间
+     */
+    lastMessageSendTime: number;
+}
+declare const _default$3: new (content: SyncReadStatusMessage) => BaseMessage<SyncReadStatusMessage>;
 
-declare const _default$2: any;
+interface ReferenceMessageContent extends IExtraData, IMentionedInfo, IUserInfo {
+    /**
+     * 被引用消息的发送用户 Id
+     */
+    referMsgUserId: String;
+    /**
+     * 引用消息对象
+    */
+    referMsg: any;
+    /**
+     * 输入的文本消息内容
+    */
+    content: string;
+}
+declare const _default$2: new (content: ReferenceMessageContent) => BaseMessage<ReferenceMessageContent>;
 
-declare const _default$1: any;
+interface IPSMessageContent extends IExtraData {
+    articles: IArticle[];
+}
+declare const _default$1: new (content: IPSMessageContent) => BaseMessage<IPSMessageContent>;
 
-declare const _default: any;
+declare const _default: new (content: IPSMessageContent) => BaseMessage<IPSMessageContent>;
 
 /**
  * 群组 @ 类型