Constructors

  • Create a store event.

    Parameters

    • roomId: string

      The matrix room ID

    • eventId: string

      The matrix event ID

    • remoteRoomId: string

      The remote room ID

    • remoteEventId: string

      The remote event ID

    • _extras: Record<string, unknown> = {}

      Any extra data that may be included with the event.

    Returns StoredEvent

Properties

eventId: string

The matrix event ID

remoteEventId: string

The remote event ID

remoteRoomId: string

The remote room ID

roomId: string

The matrix room ID

Methods

  • Get the data value for the given key.

    Type Parameters

    • T

    Parameters

    • key: string

      An arbitrary bridge-specific key.

    Returns T

    Stored data for this key. May be undefined.

  • Get the unique ID.

    Returns string

    A unique ID

  • Get the matrix event ID.

    Returns string

    The event ID

  • Get the matrix room ID.

    Returns string

    The room ID

  • Get the remote event ID.

    Returns string

    The remote event ID

  • Get the remote room ID.

    Returns string

    The remote room ID

  • Serialize data about this event into a JSON object.

    Returns StoredEventDoc

  • Set an arbitrary bridge-specific data value for this event. This will be serailized under an 'extras' key.

    Parameters

    • key: string

      The key to store the data value under.

    • val: unknown

      The data value. This value should be serializable via JSON.stringify(data).

    Returns void

  • Set data about this event from a serialized data object.

    Parameters

    Returns StoredEvent

Generated using TypeDoc