Class MatrixUser

Hierarchy

MatrixUser

Index

Constructors

Properties

host userId ESCAPE_DEFAULT

Accessors

Methods

escapeUserId get getDisplayName getId serialize set setDisplayName

Constructors

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 MatrixUser~ESCAPE_DEFAULT to change the default value.
Returns MatrixUser

Properties

`Readonly` host

host: string

userId

userId: string

`Static` ESCAPE_DEFAULT

ESCAPE_DEFAULT: boolean = true

Static

This is a global variable to modify the default escaping behaviour of MatrixUser.

Accessors

localpart

get localpart(): string
Returns string

Methods

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.

Returns
Stored data for this key. May be undefined.
Type Parameters
- T
Parameters
- key: string
  
  An arbitrary bridge-specific key.
Returns T

getDisplayName

getDisplayName(): null | string
Get the display name for this Matrix user.

Returns
The display name.

Returns null | string

getId

getId(): string
Get the matrix user's ID.

Returns
The user ID

Returns string

serialize

serialize(): { localpart: string }
Serialize all the data about this user, excluding the user ID.

Returns
The serialised data

Returns { localpart: string }
- localpart: string

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

Generated using TypeDoc