Declared inVoxImplantDelegate.h

Overview

@protocol VoxImplantDelegate

Delegate for VoxImplantSDK

- onLoginSuccessfulWithDisplayName:andAuthParams:

Triggered if login attempt was successful

- (void) onLoginSuccessfulWithDisplayName: (NSString*) displayName andAuthParams: (NSDictionary*) authParams

Parameters

displayName

Full name of logged in user

authParams

Auth params. Contains token strings and expire durations in seconds as accessExpire, accessToken, refreshExpire and refreshToken.

Description

Triggered if login attempt was successful

Declared In

VoxImplantDelegate.h

- onLoginFailedWithErrorCode:

Triggered if login attempt failed

- (void) onLoginFailedWithErrorCode: (NSNumber*) errorCode

Parameters

errorCode

Numeric error code

Description

Triggered if login attempt failed

Declared In

VoxImplantDelegate.h

- onOneTimeKeyGenerated:

Returns one time key generated by the login server as a result of requestOneTimeLoginKey.

- (void) onOneTimeKeyGenerated: (NSString*) key

Parameters

key

One time key

Description

Returns one time key generated by the login server as a result of requestOneTimeLoginKey.

Declared In

VoxImplantDelegate.h

- onRefreshTokenFailed:

Triggered if token refresh failed

- (void) onRefreshTokenFailed: (NSNumber*) errorCode

Parameters

errorCode

Numeric error code

Description

Triggered if token refresh failed

Declared In

VoxImplantDelegate.h

- onRefreshTokenSuccess:

Triggered on successfull token refresh

- (void) onRefreshTokenSuccess: (NSDictionary*) authParams

Parameters

authParams

Auth params. Contains token strings and expire durations in seconds as accessExpire, accessToken, refreshExpire and refreshToken.

Description

Triggered on successfull token refresh

Declared In

VoxImplantDelegate.h

- onConnectionSuccessful

Triggered if Voximplant cloud was connected

- (void) onConnectionSuccessful

Description

Triggered if Voximplant cloud was connected

Declared In

VoxImplantDelegate.h

- onConnectionClosed

Triggered if Voximplant cloud was disconnected

- (void) onConnectionClosed

Description

Triggered if Voximplant cloud was disconnected

Declared In

VoxImplantDelegate.h

- onConnectionFailedWithError:

Triggered if Voximplant cloud was not successfully connected

- (void) onConnectionFailedWithError: (NSString*) reason

Parameters

reason

Error message

Description

Triggered if Voximplant cloud was not successfully connected

Declared In

VoxImplantDelegate.h

- onCallConnected:withHeaders:

Triggered if the call was successfully connected

- (void) onCallConnected: (NSString*) callId withHeaders: (NSDictionary*) headers

Parameters

callId

id of call

headers

Optional headers passed with event

Description

Triggered if the call was successfully connected

Declared In

VoxImplantDelegate.h

- onCallDisconnected:withHeaders:

Triggerred if the call was disconnected

- (void) onCallDisconnected: (NSString*) callId withHeaders: (NSDictionary*) headers

Parameters

callId

id of call

headers

Optional headers passed with event

Description

Triggerred if the call was disconnected

Declared In

VoxImplantDelegate.h

- onCallRinging:withHeaders:

Triggered if the call is ringing. You should start playing call progress tone now

- (void) onCallRinging: (NSString*) callId withHeaders: (NSDictionary*) headers

Parameters

callId

id of call

headers

Optional headers passed with event

Description

Triggered if the call is ringing. You should start playing call progress tone now

Declared In

VoxImplantDelegate.h

- onCallFailed:withCode:andReason:withHeaders:

Triggered if the call has failed

- (void) onCallFailed: (NSString*) callId withCode: (Int) code andReason: (NSString*) reason withHeaders: (NSDictionary*) headers

Parameters

callId

id of call

code

Status code

reason

Status message

headers

Optional headers passed with event

Description

Triggered if the call has failed

Declared In

VoxImplantDelegate.h

- onCallAudioStarted:

Triggered if call audio is started. You should stop playing progress tone when event is received

- (void) onCallAudioStarted: (NSString*) callId

Parameters

callId

id of call

Description

Triggered if call audio is started. You should stop playing progress tone when event is received

Declared In

VoxImplantDelegate.h

- onIncomingCall:caller:named:withVideo:withHeaders:

Triggered on incoming call

- (void) onIncomingCall: (NSString*) callId caller: (NSString*) from named: (NSString*) displayName withVideo: (Bool) videoCall withHeaders: (NSDictionary*) headers

Parameters

callId

id of call

from

SIP URI of caller

displayName

Displayed name of caller

videoCall

incoming video call flag

headers

Optional headers passed with event

Description

Triggered on incoming call

Declared In

VoxImplantDelegate.h

- onSIPInfoReceivedInCall:withType:andContent:withHeaders:

Triggered if info is received within a call

- (void) onSIPInfoReceivedInCall: (NSString*) callId withType: (NSString*) type andContent: (NSString*) content withHeaders: (NSDictionary*) headers

Parameters

callId

id of call

type

MIME type of info

content

Body of info message

headers

Optional headers passed with event

Description

Triggered if info is received within a call

Declared In

VoxImplantDelegate.h

- onMessageReceivedInCall:withText:withHeaders:

Triggered if the instant message is received within a call

- (void) onMessageReceivedInCall: (NSString*) callId withText: (NSString*) text withHeaders: (NSDictionary*) headers

Parameters

callId

id of call

text

Message text

headers

Optional headers passed with event

Description

Triggered if the instant message is received within a call

Declared In

VoxImplantDelegate.h

- onNetStatsReceivedInCall:withStats:

Triggered if the packet loss data is received from the VoxImplant servers

- (void) onNetStatsReceivedInCall: (NSString*) callId withStats: (Const struct VoxImplantNetworkInfo*) stats

Parameters

callId

id of call

stats

VoxImplantNetworkInfo

Description

Triggered if the packet loss data is received from the VoxImplant servers

Declared In

VoxImplantDelegate.h