Interface ChatMessageData

interface ChatMessageData {
    _id: null | string;
    _stats: DocumentStats;
    blind?: boolean;
    content: string;
    emote?: boolean;
    flags: DocumentFlags;
    flavor?: string;
    rolls?: string[];
    sound?: string;
    speaker: ChatSpeakerData;
    style?: ChatMessageStyle;
    system: object;
    timestamp: number;
    title?: string;
    type: string;
    user: string;
    whisper: string[];
}

Properties

_id _stats blind? content emote? flags flavor? rolls? sound? speaker style? system timestamp title? type user whisper

Properties

_id

_id: null | string

The _id which uniquely identifies this ChatMessage document

_stats

_stats: DocumentStats

An object of creation and access information

Optionalblind

blind?: boolean

Is this message sent blindly where the creating User cannot see it?

content

content: string

The HTML content of this chat message

Optionalemote

emote?: boolean

Is this message styled as an emote?

flags

flags: DocumentFlags

An object of optional key/value flags

Optionalflavor

flavor?: string

An optional flavor text message which summarizes this message

Optionalrolls

rolls?: string[]

Serialized content of any Roll instances attached to the ChatMessage

Optionalsound

sound?: string

The URL of an audio file which plays when this message is received

speaker

speaker: ChatSpeakerData

A ChatSpeakerData object which describes the origin of the ChatMessage

Optionalstyle

style?: ChatMessageStyle

The message style from CONST.CHAT_MESSAGE_STYLES

system

system: object

Data for a ChatMessage subtype, defined by a System or Module

timestamp

timestamp: number

The timestamp at which point this message was generated

Optionaltitle

title?: string

An optional title used if the message is popped-out

type

type: string

The type of this chat message, in BaseChatMessage.metadata.types

user

user: string

The _id of the User document who generated this message

whisper

whisper: string[]

An array of User _id values to whom this message is privately whispered

Settings

Member Visibility

On This Page

Properties