Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAReceivedMessage

Structure of messages received by users

Hierarchy

  • IAReceivedMessage

Index

Properties

Properties

messageType

messageType: string

Message type

example

RC:TxtMsg

content

content: any

Message content

senderUserId

senderUserId: string

The user ID of the message sender

targetId

targetId: string

Conversation ID

channelId

channelId: string

Business identifier of the conversation

conversationType

conversationType: ConversationType

Conversation type

sentTime

sentTime: number

The timestamp when the message was sent on the server.

receivedTime

receivedTime: number

Message reception time, which is calculated locally based on the sentTime value of the message. Not recommended for use.

description

When isOffLineMessage is true, this value is invalid.

messageUId

messageUId: string

Server-side stored message ID

messageDirection

messageDirection: MessageDirection

Message direction

  • 1: Sent
  • 2: Received

isPersited

isPersited: boolean

Whether to store\n * @defaultValue true

isCounted

isCounted: boolean

Whether to count

defaultvalue

true

isOffLineMessage

isOffLineMessage: boolean

Indicates whether it is an offline message. Not applicable in ultra group conversations.

Optional isMentioned

isMentioned?: boolean

Indicates whether it is a @ mention message

Optional disableNotification

disableNotification?: boolean

Whether the message is silent

description

Silent messages do not trigger push notifications or local notification alerts

Optional isStatusMessage

isStatusMessage?: boolean

Indicates whether it is a status message

canIncludeExpansion

canIncludeExpansion: boolean

Supports message extension

Optional expansion

expansion?: null | {}

Message extension

receivedStatus

receivedStatus: ReceivedStatus

Message receiving status Indicates a single status only. It is recommended to use receivedStatusInfo to determine the message receiving status.

deprecated

Optional receivedStatusInfo

receivedStatusInfo?: IReceivedStatusInfo

Message receiving status details Recommended for use. The receivedStatusInfo value provides more detailed information and can represent multiple receiving states simultaneously.

Optional sentStatus

sentStatus?: SentStatus

Indicates the message sending status. On the Electron platform, this can be automatically updated by the SDK or manually set by the user. On the web platform, the SDK only supports updating the status to "Sending," "Sent," and "Failed to send.

Optional readReceiptInfo

readReceiptInfo?: IReadReceiptInfo | IReadReceiptResponseInfo

Group read receipt information (V1 version is IReadReceiptResponseInfo, V4 version is IReadReceiptInfo)

Optional pushConfig

pushConfig?: IPushConfig

Push notification extensions

Optional messageId

messageId?: number

Message local ID, a field unique to the Electron platform.

Optional isInterrupt

isInterrupt?: boolean

Super Group-specific field, indicating whether there is a gap in message continuity. The server may experience gaps when receiving a large volume of messages. This flag is used to indicate such gaps, requiring clients to manually retrieve historical messages.

Optional isModifyMessage

isModifyMessage?: boolean

Ultra group-specific field, indicates whether the message has been modified when retrieving historical messages (only valid for ultra groups).

Optional channelType

channelType?: UltraGroupChannelType

Super group-specific field, indicates whether the message is of a super group channel type when pulling historical messages (valid only for super groups).

Optional directedUserIds

directedUserIds?: string[]

Targeted user list (Only supported for group chat and ultra group)

Optional disableUpdateLastMessage

disableUpdateLastMessage?: boolean

Prohibits updating to the latest message in the conversation. Default is false: updates, true: does not update.