<ZDKBanafoContactSearchCriteria> Protocol Reference

Banafo listing contacts search criteria. More...

#import <ZDKBanafoContactSearchCriteria.h>

Inheritance diagram for <ZDKBanafoContactSearchCriteria>:

Instance Methods
(NSString *)	- handlesDescription
Instance Methods inherited from <ZDKZHandle>
(long int)	- handle
(void)	- initialize
(void)	- releaseReference
(NSString *)	- handlesDescription

Properties
NSString *_Nullable	contactId
	Contact ID of the required contact. More...
NSString *_Nullable	provider
	Contacts provider to be searched for. More...
NSString *_Nullable	search
	Word to search for. More...
NSArray< NSNumber * > *_Nullable	types
	List of types to filter by. More...
NSString *_Nullable	phone
	Phone number to search for. More...
NSString *_Nullable	nationalNumber
	National number for improved phone number searches. More...
BOOL	reverseLookup
	Reverse phone lookup. More...
NSString *_Nullable	region
	Region code. More...
int	start
	Starting offset. More...
int	limit
	Number of retrieved contacts limit. More...
NSString *_Nullable	pageId
	Next page ID. More...

Detailed Description

Banafo listing contacts search criteria.

Describes the search criteria used for listing Banafo contacts.

Method Documentation

handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

Property Documentation

contactId

- (NSString* _Nullable) contactId

readnonatomicassign

Contact ID of the required contact.

Contact ID of the required contact. If set, a search for specific contact will be made. In that case 'Provider()' MUST also be set and 'Types()' MUST have a single type filled in. All other parameters will be discarded!

Returns

The contact ID of the required contact

limit

- (int) limit

readnonatomicassign

Number of retrieved contacts limit.

Number of contacts per page (if limit is not provided, the maximum limit per provider will be used), pagination will only work if the provider is specified. Example: 10

Returns

The number of retrieved contacts limit

nationalNumber

- (NSString* _Nullable) nationalNumber

readnonatomicassign

National number for improved phone number searches.

National number for improved phone number searches, taken into account only when 'Phone()' is also present. Example: 1900321555

Returns

The national number for improved phone number searches

pageId

- (NSString* _Nullable) pageId

readnonatomicassign

Next page ID.

Unique next page id, required by some CRMs to get next page results (PageId could be found in pagination object of the previous page request's response). Example: eu4hru34hrfu43irh3

Returns

The next page ZDKD

phone

- (NSString* _Nullable) phone

readnonatomicassign

Phone number to search for.

Phone number to search for. Example: +61 1900 321 555

Returns

The phone number to search for

provider

- (NSString* _Nullable) provider

readnonatomicassign

Contacts provider to be searched for.

Slug that specifies the provider contacts desired, could be set to "banafo" for local contacts, if not specified contacts for all active providers will be returned. Example: zoho

Returns

The provider which contacts to be searched for

region

- (NSString* _Nullable) region

readnonatomicassign

Region code.

Two-letter region code for parsing phone numbers without county code. Example: AU

Returns

The region code

reverseLookup

- (BOOL) reverseLookup

readnonatomicassign

Reverse phone lookup.

Indicates whether the search will be a Reverse Lookup or normal Contact Listing. In case is set to 'true', 'Region()' and 'Phone()' MUST be set while all other parameters will be discarded!

Returns

• 0 - disabled
• 1 - enabled

search

- (NSString* _Nullable) search

readnonatomicassign

Word to search for.

Word to search for - name, company name, email, phone, etc. Example: John

Returns

The word to search for

start

- (int) start

readnonatomicassign

Starting offset.

The number of contacts wished to be skipped before selecting records (if start is not provide, start will be set to 0 as a default), pagination will only work if the provider is specified. Example: 0

Returns

The starting offset

types

- (NSArray<NSNumber*>* _Nullable) types

readnonatomicassign

List of types to filter by.

List of types to filter by. If not specified it looks for all supported types by the provider. Example: ContactType::Lead, ContactType::Account

Returns

The list of types to filter by

---

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

• ZDKBanafoContactSearchCriteria.h