Class RegisterAPI

Hierarchy

Constructors

constructor

Properties

client

Methods

answer answerWaitingResponse cancel cleanPendingWithId login logout request waitAnserWithId waitAnswerWithInviteId

Constructors

constructor

Properties

Protected client

client: SignalingClient

Methods

answer

  • Send an answer to server with given data.

    Throws

    if server returns an error

    Parameters

    • type: string

      response type, i.e: 'invitation',...

    • id: string

      request id

    • payload: Body

      response data.

    Returns Promise<Record<string, any>>

answerWaitingResponse

cancel

cleanPendingWithId

login

  • Create a registry on server.

    Throws

    if server returns an error

    Returns

    resolved with created registry.

    Parameters

    • username: string

      user name to register.

    • token: string

      validation token.

    • __namedParameters: {
          deviceId?: string;
      } = {}
      • Optional deviceId?: string

    Returns Promise<unknown>

logout

request

  • Send a request to server with given data.

    Throws

    if server returns an error

    Returns

    resolved with server response.

    Parameters

    • type: string

      request type, i.e: 'createRoom', 'invitation',...

    • id: string

      request id

    • body: Body

      requested body.

    • Optional retry: number

      if specified and an id is provided, when an answer is not received for this requested id, message will be send again periodically.

    Returns Promise<Record<string, any>>

waitAnserWithId

waitAnswerWithInviteId

Settings

Member Visibility

Theme

Generated using TypeDoc