Class MatrixUser

constructor

• new MatrixUser(
      userId: string,
      _data?: Record<string, unknown>,
      escape?: boolean,
  ): MatrixUser

  Construct a Matrix user.

  Parameters

  • userId: string

    The userId of the user.
  • _data: Record<string, unknown> = {}
  • escape: boolean = MatrixUser.ESCAPE_DEFAULT

    Escape the user's localpart. Modify ~ESCAPE_DEFAULT to change the default value.

  Returns MatrixUser

Readonlyhost

userId

StaticESCAPE_DEFAULT

localpart

• get localpart(): string

  Returns string

escapeUserId

• escapeUserId(): void

  Make a userId conform to the matrix spec using QP escaping. Grammar taken from: https://matrix.org/docs/spec/appendices.html#identifier-grammar

  Returns void

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.

getDisplayName

• getDisplayName(): null | string

  Get the display name for this Matrix user.

  Returns null | string

  The display name.

getId

• getId(): string

  Get the matrix user's ID.

  Returns string

  The user ID

serialize

• serialize(): { localpart: string }

  Serialize all the data about this user, excluding the user ID.

  Returns { localpart: string }

  The serialised data

set

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

  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

setDisplayName

• setDisplayName(name: string): void

  Set the display name for this Matrix user.

  Parameters

  • name: string

    The Matrix display name.

  Returns void