RCKitStore
    Preparing search index...

    Interface IKitMessageCache

    interface IKitMessageCache {
        canIncludeExpansion: boolean;
        channelId: string;
        channelType?: UltraGroupChannelType;
        content: any;
        conversationType: ConversationType;
        directedUserIds?: string[];
        disableNotification?: boolean;
        disableUpdateLastMessage?: boolean;
        expansion?: null | { [key: string]: any };
        isCounted: boolean;
        isInterrupt?: boolean;
        isMentioned?: boolean;
        isModifyMessage?: boolean;
        isOffLineMessage: boolean;
        isPersited: boolean;
        isStatusMessage?: boolean;
        localTmpPath?: string;
        messageDirection: MessageDirection;
        messageId?: number;
        messageType: string;
        messageUId: string;
        pushConfig?: IPushConfig;
        readReceiptInfo?: IReadReceiptResponseInfo | IReadReceiptInfo;
        receivedStatus: ReceivedStatus;
        receivedStatusInfo?: IReceivedStatusInfo;
        receivedTime: number;
        senderUserId: string;
        sentStatus?: SentStatus;
        sentTime: number;
        targetId: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    canIncludeExpansion channelId channelType? content conversationType directedUserIds? disableNotification? disableUpdateLastMessage? expansion? isCounted isInterrupt? isMentioned? isModifyMessage? isOffLineMessage isPersited isStatusMessage? localTmpPath? messageDirection messageId? messageType messageUId pushConfig? readReceiptInfo? receivedStatus receivedStatusInfo? receivedTime senderUserId sentStatus? sentTime targetId

    Properties

    canIncludeExpansion: boolean

    是否支持消息扩展

    channelId: string

    会话的业务标识

    channelType?: UltraGroupChannelType

    超级群专有字段，拉取历史消息时表示该消息是否为超级群频道类型（仅超级群有效）

    content

    content: any

    消息内容

    conversationType: ConversationType

    会话类型

    • 1: 单聊
    • 3: 群聊
    • 4: 聊天室
    • 5: 客服会话
    • 6: 系统消息
    • 7: 默认关注的公众号
    • 8: 手动关注的公众号
    • 9: RTCLib 房间
    directedUserIds?: string[]

    定向用户列表(仅支持群聊, 超级群)

    disableNotification?: boolean

    消息是否静默

    静默消息不会发送 Push 信息和本地通知提醒

    disableUpdateLastMessage?: boolean

    禁止更新到会话最新一条消息，默认 false: 更新，true: 不更新

    expansion?: null | { [key: string]: any }

    消息扩展

    isCounted: boolean

    是否计数

    true
    isInterrupt?: boolean

    超级群专有字段，是否断档，服务端收到大量消息可能会断档，所以消息存在此标志位，断档需要客户手动拉取历史消息

    isMentioned?: boolean

    是否为 @ 消息

    isModifyMessage?: boolean

    超级群专有字段，拉取历史消息时表示该消息是否修改过（仅超级群有效）

    isOffLineMessage: boolean

    是否为离线消息, 在超级群会话中不适用

    isPersited: boolean

    是否存储

    true
    isStatusMessage?: boolean

    是否是状态消息

    localTmpPath?: string

    媒体消息本地临时路径

    messageDirection: MessageDirection

    消息方向

    • 1: 发送
    • 2: 接收
    messageId?: number

    消息本地 ID，Electron 平台独有字段

    messageType: string

    消息类型

    RC:TxtMsg
    messageUId: string

    服务端存储的消息 Id

    pushConfig?: IPushConfig

    推送扩展

    readReceiptInfo?: IReadReceiptResponseInfo | IReadReceiptInfo

    群已读回执信息(V1 版本为 IReadReceiptResponseInfo, V4 版本为 IReadReceiptInfo）

    receivedStatus: ReceivedStatus

    消息接收状态 只能表示单一状态，推荐使用 receivedStatusInfo 来判断接收消息状态

    receivedStatusInfo?: IReceivedStatusInfo

    消息接收状态详情 推荐使用, receivedStatusInfo 值更详细，能同时表示多个接收状态

    receivedTime: number

    消息接收时间，该时间通过消息的 sentTime 值在本地进行计算得出，不推荐使用

    当 isOffLineMessage 为 true 时，该值无效

    senderUserId: string

    消息发送者的用户 id

    sentStatus?: SentStatus

    消息的发送状态，Electron 平台可由 SDK 内自动更新和用户设置, web 端仅支持 SDK 内更新为 发送中、已发送和发送失败

    sentTime: number

    消息在服务器端的发送时间

    targetId: string

    会话 id

    Settings

    Member Visibility

    On This Page

    Properties