Class QrCodeData

Data for the QR code login mechanism.

The QrCodeData can be serialized and encoded as a QR code or it can be decoded from a QR code.

Constructors

constructor

Properties

mode publicKey rendezvousUrl serverName

Methods

free toBase64 toBytes fromBase64 fromBytes

Constructors

constructor

  • new QrCodeData(
        public_key: Curve25519PublicKey,
        rendezvous_url: string,
        server_name?: string,
    ): QrCodeData

  • Create new QrCodeData from a given public key, a rendezvous URL and, optionally, a server name for the homeserver.

    If a server name is given, then the QrCodeData mode will be QrCodeMode.Reciprocate, i.e. the QR code will contain data for the existing device to display the QR code.

    If no server name is given, the QrCodeData mode will be QrCodeMode.Login, i.e. the QR code will contain data for the new device to display the QR code.

    Parameters

    Returns QrCodeData

Properties

Readonlymode

mode: QrCodeMode

Get the mode of this QrCodeData instance.

ReadonlypublicKey

publicKey: Curve25519PublicKey

Get the Curve25519 public key embedded in the QrCodeData.

This Curve25519 public key should be used to establish an ECIES (Elliptic Curve Integrated Encryption Scheme) channel with the other device.

ReadonlyrendezvousUrl

rendezvousUrl: string

Get the URL of the rendezvous server which will be used to exchange messages between the two devices.

ReadonlyserverName

serverName: undefined | string

Get the server name of the homeserver which the new device will be logged in to.

This will be only available if the existing device has generated the QR code and the new device is the one scanning the QR code.

Methods

free

  • free(): void

  • Returns void

toBase64

  • toBase64(): string

  • Encode the QrCodeData into a string using base64.

    This format can be used for debugging purposes and the [QrcodeData::from_base64()] method can be used to parse the string again.

    Returns string

toBytes

  • toBytes(): Uint8Array<ArrayBufferLike>

  • Encode the QrCodeData into a list of bytes.

    The list of bytes can be used by a QR code generator to create an image containing a QR code.

    Returns Uint8Array<ArrayBufferLike>

StaticfromBase64

  • fromBase64(data: string): QrCodeData

  • Attempt to decode a base64 encoded string into a QrCodeData object.

    Parameters

    • data: string

    Returns QrCodeData

StaticfromBytes

  • fromBytes(bytes: Uint8Array<ArrayBufferLike>): QrCodeData

  • Attempt to decode a slice of bytes into a QrCodeData object.

    The slice of bytes would generally be returned by a QR code decoder.

    Parameters

    • bytes: Uint8Array<ArrayBufferLike>

    Returns QrCodeData

Settings

Member Visibility

On This Page

Constructors
Properties
Methods