RongCloud React Native IM Wrapper - v5.12.1
    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;
        receivedStatus?: RCIMIWReceivedStatus;
        sentStatus?: RCIMIWSentStatus;
        senderUserId?: string;
        direction?: RCIMIWMessageDirection;
        userInfo?: RCIMIWUserInfo;
        mentionedInfo?: RCIMIWMentionedInfo;
        pushOptions?: RCIMIWMessagePushOptions;
        extra?: string;
        expansion?: { [propName: string]: string };
    }

    Hierarchy (View Summary)

    Index

    Properties

    conversationType? messageType? targetId? channelId? messageId? messageUId? offLine? groupReadReceiptInfo? receivedTime? sentTime? receivedStatus? sentStatus? senderUserId? direction? userInfo? mentionedInfo? pushOptions? extra? expansion?

    Properties

    conversationType?: RCIMIWConversationType

    Session type

    messageType?: RCIMIWMessageType

    Message type

    targetId?: string

    Session ID

    channelId?: string

    Business ID of the session, limited to 20 characters

    messageId?: number

    Unique ID for messages stored in the local database. Don’t specify this ID when sending new messages—it’ll cause the message to fail to save. For retrying failed messages, use the ID of the previously saved message instance.

    messageUId?: string

    Unique server message ID (globally unique under the same Appkey)

    offLine?: boolean

    Indicates if it's an offline message. Only valid in the message reception callback. Returns YES for offline messages, otherwise NO.

    groupReadReceiptInfo?: RCIMIWGroupReadReceiptInfo

    Group read receipt status

    receivedTime?: number

    Message received time (Unix timestamp, milliseconds)

    sentTime?: number

    Message send time (Unix timestamp, milliseconds)

    receivedStatus?: RCIMIWReceivedStatus

    Message receipt status

    sentStatus?: RCIMIWSentStatus

    Message delivery status

    senderUserId?: string

    Sender ID of the message

    direction?: RCIMIWMessageDirection

    Message direction

    userInfo?: RCIMIWUserInfo

    User info in the message

    mentionedInfo?: RCIMIWMentionedInfo

    Message @ info

    pushOptions?: RCIMIWMessagePushOptions

    Message push configuration

    extra?: string

    Additional message fields

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

    Message expansion information. Set this property before sending a message to enable the message expansion feature; otherwise, the message expansion feature cannot be used. After sending a message successfully, use the updateMessageExpansion interface to update the expansion information. Message extension key length should not exceed 32 characters, and value length should not exceed 4096 characters. The maximum number of extensions that can be set at one time is 20, and the total number of extensions for a message cannot exceed 300." Note: Extension information is only supported for private chats and groups; extension information cannot be set for other conversation types.

    Settings

    Member Visibility

    On This Page

    Properties