Represents a message event. Message events are the simplest form of event with just text (optionally of different mimetypes, like HTML).

Message events can additionally be an Emote or Notice, though typically those are represented as EmoteEvent and NoticeEvent respectively.

Hierarchy

Constructors

Properties

html: Optional<string>

The default HTML for the event, if provided.

renderings: IMessageRendering[]

All the different renderings of the message. Note that this is the same format as an m.message body but may contain elements not found directly in the event content: this is because this is interpreted based off the other information available in the event.

text: string

The default text for the event.

Accessors

Methods

  • Determines if this event is equivalent to the provided event type. This is recommended over instanceof checks due to issues in the JS runtime (and layering of dependencies in some projects).

    Implementations should pass this check off to their super classes if their own checks fail. Some primary implementations do not extend fallback classes given they support the primary type first. Thus, those classes may return false if asked about their fallback representation.

    Note that this only checks primary event types: legacy events, like m.room.message, should/will fail this check.

    Returns

    True if this event could be represented as the given type.

    Parameters

    Returns boolean

Generated using TypeDoc