Declared in VoxImplantDelegate.h

Overview

@protocol VoxImplantDelegate

Delegate for VoxImplantSDK

– onLoginSuccessfulWithDisplayName: required method

Triggered if login attempt was successful

- (void)onLoginSuccessfulWithDisplayName:(NSString *)displayName

Parameters

displayName

Full name of logged in user

Discussion

Triggered if login attempt was successful

Declared In

VoxImplantDelegate.h

– onLoginFailedWithErrorCode: required method

Triggered if login attempt failed

- (void)onLoginFailedWithErrorCode:(NSNumber *)errorCode

Parameters

errorCode

Numeric error code

Discussion

Triggered if login attempt failed

Declared In

VoxImplantDelegate.h

– onConnectionSuccessful required method

Connection with cloud established

- (void)onConnectionSuccessful

Discussion

Connection with cloud established

Declared In

VoxImplantDelegate.h

– onConnectionClosed required method

Connection with cloud closed

- (void)onConnectionClosed

Discussion

Connection with cloud closed

Declared In

VoxImplantDelegate.h

– onConnectionFailedWithError: required method

Connection with cloud failed

- (void)onConnectionFailedWithError:(NSString *)reason

Parameters

reason

Error message

Discussion

Connection with cloud failed

Declared In

VoxImplantDelegate.h

– onCallConnected:withHeaders: required method

Call established

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

Parameters

callId

id of call

headers

Optional headers passed with event

Discussion

Call established

Declared In

VoxImplantDelegate.h

– onCallDisconnected:withHeaders: required method

Call terminated

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

Parameters

callId

id of call

headers

Optional headers passed with event

Discussion

Call terminated

Declared In

VoxImplantDelegate.h

– onCallRinging:withHeaders: required method

Call 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

Discussion

Call ringing. You should start playing call progress tone now

Declared In

VoxImplantDelegate.h

– onCallFailed:withCode:andReason:withHeaders: required method

Call 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

Discussion

Call failed

Declared In

VoxImplantDelegate.h

– onCallAudioStarted: required method

Call audio started. You should stop playing progress tone when event is received

- (void)onCallAudioStarted:(NSString *)callId

Parameters

callId

id of call

headers

Optional headers passed with event

Discussion

Call audio started. You should stop playing progress tone when event is received

Declared In

VoxImplantDelegate.h

– onIncomingCall:From:Named:withVideo:withHeaders: required method

Incoming call arrives

- (void)onIncomingCall:(NSString *)callId From:(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

Discussion

Incoming call arrives

Declared In

VoxImplantDelegate.h

– onSIPInfoReceivedInCall:withType:andContent:withHeaders: required method

Info received inside 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

Discussion

Info received inside a call

Declared In

VoxImplantDelegate.h

– onMessageReceivedInCall:withText:withHeaders: required method

Instant message received inside 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

Discussion

Instant message received inside a call

Declared In

VoxImplantDelegate.h