Rate this page:

ClientEventTypes

Constants

AuthResult

Copy URL

Parameters

  • code:

    number

    Auth result error code

  • displayName:

    string

    Authorized user's display name

  • key:

    string

    This parameter is used to calculate hash parameter for [Client.loginWithOneTimeKey method. AuthResult with the key dispatched after Client.requestOneTimeLoginKey method was called.

  • name:

    string

    Name of the event

  • result:

    boolean

    True in case of success, false - otherwise

  • New tokens structure

ConnectionClosed

Copy URL

Parameters

  • name:

    string

    Name of the event

ConnectionEstablished

Copy URL

Parameters

  • name:

    string

    Name of the event

ConnectionFailed

Copy URL

Parameters

  • message:

    string

    Failure reason description

  • name:

    string

    Name of the event

IncomingCall

Copy URL

Parameters

  • call:

    Call

    Incoming call instance. See Call methods for details

  • headers:

    object

    Optional SIP headers received with the event

  • name:

    string

    Name of the event

  • video:

    boolean

    True if the caller initiated video call

RefreshTokenResult

Copy URL

Parameters

  • code:

    number

    Auth result error code

  • name:

    string

    Name of the event

  • result:

    boolean

    True in case of success, false - otherwise

  • New tokens structure