Constructors

Properties

Methods

Constructors

  • Parameters

    • id: string
    • data: Record<string, unknown> = {}

      The serialized key-value data object to assign to this user.

    Returns RemoteUser

    Throws

    If identifier is not supplied.

Properties

data: Record<string, unknown> = {}

The serialized key-value data object to assign to this user.

id: string

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 Remote user ID.

    Returns string

    The id

  • Serialize all the data about this room, excluding the room ID.

    Returns Record<string, unknown>

    The serialised data

  • Set an arbitrary bridge-specific data value for this room.

    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