Class UserId

A Matrix user ID.

Constructors

constructor

Accessors

localpart serverName

Methods

isHistorical toString

Constructors

constructor

  • new UserId(id): UserId

  • Parse/validate and create a new UserId.

    Parameters

    • id: string

    Returns UserId

Accessors

localpart

  • get localpart(): string

  • Returns the user's localpart.

    Returns string

serverName

  • get serverName(): ServerName

  • Returns the server name of the user ID.

    Returns ServerName

Methods

isHistorical

  • isHistorical(): boolean

  • Whether this user ID is a historical one.

    A historical user ID is one that doesn't conform to the latest specification of the user ID grammar but is still accepted because it was previously allowed.

    Returns boolean

toString

  • toString(): string

  • Return the user ID as a string.

    Returns string

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods