Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserId

A Matrix [user ID].

Hierarchy

  • UserId

Index

Constructors

Properties

Methods

Constructors

constructor

  • new UserId(id: string): UserId

  • Parse/validate and create a new UserId.

    Parameters

    • id: string

    Returns UserId

Properties

Readonly localpart

localpart: string

Returns the user's localpart.

Readonly serverName

serverName: ServerName

Returns the server name of the user ID.

Methods

clone

  • Create a clone of this UserId.

    This can be useful when passing a UserId instance to methods such as OlmMachine.updateTrackedUsers which destroy the instance.

    Returns UserId

free

  • free(): void

  • Returns void

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

Generated using TypeDoc