Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StoredEvent

Hierarchy

  • StoredEvent

Index

Constructors

Properties

Methods

Constructors

constructor

  • new StoredEvent(roomId: string, eventId: string, remoteRoomId: string, remoteEventId: string, _extras?: Record<string, unknown>): StoredEvent

  • 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

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

      Any extra data that may be included with the event.

    Returns StoredEvent

Properties

eventId

eventId: string

The matrix event ID

remoteEventId

remoteEventId: string

The remote event ID

remoteRoomId

remoteRoomId: string

The remote room ID

roomId

roomId: string

The matrix room ID

Methods

get

  • get<T>(key: string): T

  • 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.

getId

  • getId(): string

getMatrixEventId

  • getMatrixEventId(): string

getMatrixRoomId

  • getMatrixRoomId(): string

getRemoteEventId

  • getRemoteEventId(): string

getRemoteRoomId

  • getRemoteRoomId(): string

serialize

set

  • set(key: string, val: unknown): void

  • 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

Static deserialize

Generated using TypeDoc