Theia API Documentation v1.65.0
    Preparing search index...

    Class ConflatableMessage

    A convenience message class which conflates automatically.

    Message conflation is an advanced topic. Most user code will not make use of this class.

    This message class is useful for creating message instances which should be conflated, but which have no state other than type.

    If conflation of stateful messages is required, a custom Message subclass should be created.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

    type: string

    The type of the message.

    The type of a message should be related directly to its actual runtime type. This means that type can and will be used to cast the message to the relevant derived Message subtype.

    Accessors

    • get isConflatable(): boolean

      Test whether the message is conflatable.

      This property is always true.

      Returns boolean

    Methods

    • Conflate this message with another message of the same type.

      This method always returns true.

      Parameters

      Returns boolean