RongCloud React Native IM Wrapper - v5.34.0
    Preparing search index...

    Interface RCIMIWMessage

    interface RCIMIWMessage {
        conversationType?: RCIMIWConversationType;
        messageType?: RCIMIWMessageType;
        targetId?: string;
        channelId?: string;
        messageId?: number;
        messageUId?: string;
        offLine?: boolean;
        groupReadReceiptInfo?: RCIMIWGroupReadReceiptInfo;
        receivedTime?: number;
        sentTime?: number;
        destructDuration?: number;
        receivedStatus?: RCIMIWReceivedStatus;
        receivedStatusInfo?: RCIMIWReceivedStatusInfo;
        sentStatus?: RCIMIWSentStatus;
        senderUserId?: string;
        direction?: RCIMIWMessageDirection;
        userInfo?: RCIMIWUserInfo;
        mentionedInfo?: RCIMIWMentionedInfo;
        pushOptions?: RCIMIWMessagePushOptions;
        extra?: string;
        localExtra?: string;
        expansion?: { [propName: string]: string };
        canIncludeExpansion?: boolean;
        auditInfo?: RCIMIWMessageAuditInfo;
        directedUserIds?: string[];
        needReceipt?: boolean;
        sentReceipt?: boolean;
    }

    Hierarchy (View Summary)

    Index
    conversationType? messageType? targetId? channelId? messageId? messageUId? offLine? groupReadReceiptInfo? receivedTime? sentTime? destructDuration? receivedStatus? receivedStatusInfo? sentStatus? senderUserId? direction? userInfo? mentionedInfo? pushOptions? extra? localExtra? expansion? canIncludeExpansion? auditInfo? directedUserIds? needReceipt? sentReceipt?
    conversationType?: RCIMIWConversationType

    会话类型

    messageType?: RCIMIWMessageType

    消息的类型

    targetId?: string

    会话 ID

    channelId?: string

    所属会话的业务标识，长度限制 20 字符

    messageId?: number

    本地数据库中存储的消息的唯一 ID 值。发送新消息时无需指定该 ID，否则会导致消息入库失败。在失败重发消息时，可以填入已入库的消息的 ID，请确保使用上一次发送失败的消息实例。

    messageUId?: string

    服务器消息唯一 ID（在同一个 Appkey 下全局唯一）

    offLine?: boolean

    是否是离线消息，只在接收消息的回调方法中有效，如果消息为离线消息，则为 YES ，其他情况均为 NO

    groupReadReceiptInfo?: RCIMIWGroupReadReceiptInfo

    群阅读回执状态

    receivedTime?: number

    消息的接收时间（Unix 时间戳、毫秒）

    sentTime?: number

    消息的发送时间（Unix 时间戳、毫秒）

    destructDuration?: number

    设置焚烧时间，默认是 0，0 代表该消息非阅后即焚消息。若此值大于 0，则消息为已读状态后，经过 destructDuration 时间后销毁。

    receivedStatus?: RCIMIWReceivedStatus

    消息的接收状态，只能为单一某个状态

    receivedStatusInfo?: RCIMIWReceivedStatusInfo

    消息的接收状态，可同时设为已读、已听、已下载、已收取

    sentStatus?: RCIMIWSentStatus

    消息的发送状态

    senderUserId?: string

    消息的发送者 ID

    direction?: RCIMIWMessageDirection

    消息的方向

    userInfo?: RCIMIWUserInfo

    消息携带的用户信息

    mentionedInfo?: RCIMIWMentionedInfo

    消息的 @ 信息

    pushOptions?: RCIMIWMessagePushOptions

    消息推送配置

    extra?: string

    消息的附加字段，可以随着消息发送给远端

    localExtra?: string

    消息的本地扩展字段，不会随着消息发送给远端，只会保存在本地数据库中

    expansion?: { [propName: string]: string }

    消息扩展信息，发消息前设置该属性可打开消息扩展功能，否则无法使用消息扩展功能。 发送成功后需使用 updateMessageExpansion 接口更新扩展信息。 消息扩展 key 长度不超过 32 ，value 长度不超过 4096 ，单次设置扩展数量最大为 20，消息的扩展总数不能超过 300 注： 扩展信息只支持单聊和群组，其它会话类型不能设置扩展信息

    canIncludeExpansion?: boolean

    消息是否可以包含扩展消息。

    auditInfo?: RCIMIWMessageAuditInfo

    消息送审配置

    directedUserIds?: string[]

    定向用户列表，单聊会话类型返回空

    needReceipt?: boolean

    是否需要已读回执，发送消息时设置为 true 表示支持已读 V5

    sentReceipt?: boolean

    是否已发送过已读回执，SDK 内部赋值

    Settings
    Member Visibility

    On This Page
    Properties