Enumeration Events

Events enum Events dispatched by VoxImplant.Client instance. See VoxImplant.getInstance.

Index

Enumeration members

AuthResult

AuthResult:

Event dispatched after login , loginWithOneTimeKey, requestOneTimeLoginKey or loginWithCode function call

Optional code

code: number

Auth error code, possible values are:

code description
301 'code' auth type was sent
302 'onetimekey' auth type received
401 invalid password or token
404 invalid username
403 user account is frozen
500 internal error
701 token expired

Optional displayName

displayName: string

Authorized user's display name

Optional key

key: string

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

Optional options

options: Object

Application options

result

result: boolean

True in case of successful authorization, false - otherwise

Optional tokens

tokens: LoginTokens

Tokens for automated login

ConnectionClosed

ConnectionClosed:

Event dispatched if connection to VoxImplant Cloud was closed because of network problems. See connect function

ConnectionEstablished

ConnectionEstablished:

Event dispatched after connection to VoxImplant Cloud was established successfully. See connect function

ConnectionFailed

ConnectionFailed:

Event dispatched if connection to VoxImplant Cloud couldn't be established. See connect function

message

message: string

Failure reason description

IncomingCall

IncomingCall:

Event dispatched when there is a new incoming call to current user

call

call: Call

Incoming call instance. See VoxImplant.Call function for details

Optional headers

headers: Object

Optional SIP headers received with the message

Optional video

video: boolean

True if the caller initiated video call

MicAccessResult

MicAccessResult:

Event dispatched after user interaction with the mic access dialog.

result

result: boolean

True is access was allowed, false - otherwise

stream

stream: MediaStream

MediaStream object

NetStatsReceived

NetStatsReceived:

Event dispatched when packet loss data received from VoxImplant servers

stats

Network info object

PlaybackFinished

PlaybackFinished:

Event dispatched after sound playback was stopped. See playToneScript and stopPlayback functions

RefreshTokenResult

RefreshTokenResult:

Refresh tokens by LoginTokens.refreshToken

Optional code

code: number

Refresh token error code, possible values are:

code description
401 invalid token
404 invalid username
500 internal error
701 refresh token expired

result

result: boolean

True in case of successful refresh, false - otherwise

Optional tokens

tokens: LoginTokens

New tokens structure

SDKReady

SDKReady:

Event dispatched after SDK was successfully initialized after init function call

version

version: string

SDK version

SourcesInfoUpdated

SourcesInfoUpdated:

Event dispatched when audio and video sources information was updated. See audioSources and videoSources for details