<ZDKBanafoEventsHandler> Protocol Reference

Inheritance diagram for <ZDKBanafoEventsHandler>:

Instance Methods
(void)	- onServiceState:
	Banafo Service state changed. More...
(void)	- onRequestState:state:
	Banafo Service request state changed. More...
(void)	- onEvent:state:
	Banafo Service event state changed. More...
(void)	- onContactList:searchCriteria:state:pagination:contactsList:
	Banafo contact list received. More...
(void)	- onIntegrationList:state:integrationsList:
	Banafo integrations list received. More...
(void)	- onProfile:profile:
	Banafo profile received. More...
(void)	- onTranscriptionLanguageList:state:languageList:
	Banafo transcription language list received. More...
(NSString *)	- handlesDescription
Instance Methods inherited from <ZDKEventHandle>
(long int)	- eventHandle
(NSString *)	- handlesDescription

Method Documentation

handlesDescription

- (NSString *) handlesDescription

optional

Reimplemented from <ZDKEventHandle>.

onContactList:searchCriteria:state:pagination:contactsList:

- (void) onContactList: (long int)  requestId searchCriteria: (id< ZDKBanafoContactSearchCriteria > _Nullable)  searchCriteria state: (id< ZDKBanafoRequestState > _Nullable)  state pagination: (id< ZDKPagination > _Nullable)  pagination contactsList: (NSArray *_Nullable)  contactsList

optional

Banafo contact list received.

This callback is invoked when the Banafo Contact list is being received after zdkBanafoManager::ListContacts() request

Parameters

[in]	requestId	The list contact request ID
[in]	searchCriteria	The search criteria used for obtaining the contact list
[in]	state	The current full state of the Banafo Contact Search request
[in]	pagination	The pagination used by the Banafo server for paged searching
[in]	contactsList	Result of the contacts search

See also

ZDKBanafoContactSearchCriteria, ZDKBanafoRequestState, ZDKPagination, ZDKBanafoContact

onEvent:state:

- (void) onEvent: (ZDKBanafoEventType)  event state: (id< ZDKBanafoEventState > _Nullable)  state

optional

Banafo Service event state changed.

This callback is used to monitor an internally created Banafo Service request state.

Parameters

[in]	event	The ZDK event triggered internally created the Banafo Service request
[in]	state	The state of the Banafo Service event

See also

BanafoEventType, ZDKBanafoEventState

onIntegrationList:state:integrationsList:

- (void) onIntegrationList: (long int)  requestId state: (id< ZDKBanafoRequestState >)  state integrationsList: (NSArray *_Nullable)  integrationsList

optional

Banafo integrations list received.

This callback is invoked when the Banafo Integrations list is being received after ZDKBanafoManager::ListIntegrations request

Parameters

[in]	requestId	The list integrations request ID
[in]	state	The current full state of the Banafo Integration List request
[in]	integrationsList	List of Banafo CRM integrations

See also

ZDKBanafoManager, ZDKBanafoIntegration

onProfile:profile:

- (void) onProfile: (long int)  requestId profile: (id< ZDKBanafoProfile > _Nullable)  profile

optional

Banafo profile received.

This callback is invoked when the Banafo profile is being received after ZDKBanafoManager::GetProfile request

Parameters

[in]	requestId	The profile request ID
[in]	profile	The Banafo profile data

See also

ZDKBanafoManager, ZDKBanafoProfile

onRequestState:state:

- (void) onRequestState: (long int)  requestId state: (id< ZDKBanafoRequestState > _Nullable)  state

optional

Banafo Service request state changed.

This callback is used to monitor a Banafo Service request state.

Parameters

[in]	requestId	The Banafo Service request handler this state change corresponds to
[in]	state	The new state of the Banafo request

See also

ZDKBanafoRequestState

onServiceState:

- (void) onServiceState: (id< ZDKBanafoServiceState > _Nullable)  state

optional

Banafo Service state changed.

This callback is used to monitor a Banafo Service state. It is called whenever the state changes.

Parameters

[in]

state

The new state of the Banafo Service

See also

ZDKBanafoServiceState

onTranscriptionLanguageList:state:languageList:

- (void) onTranscriptionLanguageList: (long int)  requestId state: (id< ZDKBanafoRequestState >)  state languageList: (NSArray *_Nullable)  languageList

optional

Banafo transcription language list received.

This callback is invoked when the Banafo transcription language list is being received after WrapperContext::BanafoListTranscriptLanguages request

Parameters

[in]	requestId	The transcription language list request ID
[in]	state	The current full state of the Banafo Transcription Language List request
[in]	languageList	List of Banafo transcription languages

See also

ZDKBanafoManager, ZDKTranscriptLanguage

---

The documentation for this protocol was generated from the following file:

• EventHandlers/ZDKBanafoEventsHandler.h