Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Convergence

The Convergence class is the main entry point into the Convergence Client. It allows users to connect to the Convergence, using a variety of authentication methods and will return a ConvergenceDomain configured to work with a the Convergence Domain at the specified url.

Hierarchy

  • Convergence

Index

Methods

Static connect

  • Connects to a Convergence Domain using username / password authentication.

    Parameters

    • url: string

      The URL of the Convergence Domain to connect to.

    • username: string

      The username of the Convergence Domain User to connect as.

    • password: string

      The password for the corresponding Convergence Domain User.

    • Optional options: IConvergenceOptions

      Options that configure the behavior of the client.

    Returns Promise<ConvergenceDomain>

    A Promise which will be resolved with the ConvergenceDomain upon successful connection.

Static connectAnonymously

  • Connects to a Convergence Domain using anonymous authentication.

    Parameters

    • url: string

      The URL of the Convergence Domain to connect to.

    • Optional displayName: string

      The display name to use for the anonymous user.

    • Optional options: IConvergenceOptions

      Options that configure the behavior of the client.

    Returns Promise<ConvergenceDomain>

    A Promise which will be resolved with the ConvergenceDomain upon successful connection.

Static connectWithJwt

  • Connects to a Convergence Domain using a JSON Web Token (JWT) for authentication.

    Parameters

    • url: string

      The URL of the Convergence Domain to connect to.

    • jwt: string

      A valid JSON Web Token (JWT) indicating the Domain User to connect as.

    • Optional options: IConvergenceOptions

      Options that configure the behavior of the client.

    Returns Promise<ConvergenceDomain>

    A Promise which will be resolved with the ConvergenceDomain upon successful connection.

Static reconnect

  • Reconnects to the specified domain using a previously generated reconnect token.

    Parameters

    • url: string

      The URL of the Convergence Domain to connect to.

    • token: string

      The reconnect token to use for authentication.

    • Optional options: IConvergenceOptions

      Options that configure the behavior of the client.

    Returns Promise<ConvergenceDomain>

    A Promise which will be resolved with the ConvergenceDomain upon successful connection.