Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MatrixRoom

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional name

name: undefined | string

Readonly roomId

roomId: string

The room ID

Optional topic

topic: undefined | string

Accessors

extras

  • get extras(): Record<string, unknown>

Methods

deserialize

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

serialize

set

  • set(key: string, val: unknown): void
  • Set an arbitrary bridge-specific data value for this room. 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

Generated using TypeDoc