Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • NIMChatroomMessage

Index

Properties

attach?: string

Additional information, JSON string is recommended

callbackExt?: string

Custom extension field for a custom webhook

chatroomId: string

Chat room ID

content?: string

body of a custom message. JSON string is preferred.

custom?: string

Extension field It is recommended to use JSON format. For data other than JSON format, the web client will receive the data but will be ignored by other clients.

env?: string

The environment variable pointing to different types of configurations for state sync and third-party callbacks.

object of a file message

flow: "in" | "out"

Message direction

  • 'in': received message
  • out': sent message
from: string

account of a sender

fromAvatar: string

Avatar of the sender

fromClientType: string

Client type of the sender

fromCustom: string

Custom field of the sender

fromNick: string

Nickname of the message sender

Geolocation message

idClient: string

The message ID generated by the SDK will be returned to the developer after sending the message as the unique key value of the message

resend: boolean

Whether the message will be resent in case of failure

skipHistory?: boolean

Whether to skip saving message history on the server, false: do not skip, true: skip saving message history. Default value: false

subType?: number

Custom message subtype, an integer greater than 0.

text?: string

body of a text message

time: number

Timestamp

tip?: string

content of an alert

type: string

Message type