Banafo listing contacts search criteria. More...

#include <BanafoContactSearchCriteria.h>

Inheritance diagram for ZDK_NET::BanafoContactSearchCriteria:

Public Member Functions
	BanafoContactSearchCriteria (ZDK::Shared::BanafoContactSearchCriteria src)

virtual long long	Handle () override

virtual void	Initialize () override

virtual void	ReleaseReference () override

Public Attributes
ZDK::IBanafoContactSearchCriteria *	cppRef = nullptr

Properties
System::String^	ContactId `[get]`
	Contact ID of the required contact. More...

System::String^	Provider `[get]`
	Contacts provider to be searched for. More...

System::String^	Search `[get]`
	Word to search for. More...

List< ZDK_NET::ContactType >^	Types `[get]`
	List of types to filter by. More...

System::String^	Phone `[get]`
	Phone number to search for. More...

System::String^	NationalNumber `[get]`
	National number for improved phone number searches. More...

bool	ReverseLookup `[get]`
	Reverse phone lookup. More...

System::String^	Region `[get]`
	Region code. More...

int	Start `[get]`
	Starting offset. More...

int	Limit `[get]`
	Number of retrieved contacts limit. More...

System::String^	PageId `[get]`
	Next page ID. More...

Detailed Description

Banafo listing contacts search criteria.

Describes the search criteria used for listing Banafo contacts.

Property Documentation

◆ ContactId

System:: String^ ZDK_NET::BanafoContactSearchCriteria::ContactId

get

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 ZDK_NET::BanafoContactSearchCriteria::Limit

get

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

System:: String^ ZDK_NET::BanafoContactSearchCriteria::NationalNumber

get

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

System:: String^ ZDK_NET::BanafoContactSearchCriteria::PageId

get

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 D

◆ Phone

System:: String^ ZDK_NET::BanafoContactSearchCriteria::Phone

get

Phone number to search for.

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

Returns: The phone number to search for

◆ Provider

System:: String^ ZDK_NET::BanafoContactSearchCriteria::Provider

get

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

System:: String^ ZDK_NET::BanafoContactSearchCriteria::Region

get

Region code.

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

Returns: The region code

◆ ReverseLookup

bool ZDK_NET::BanafoContactSearchCriteria::ReverseLookup

get

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

System:: String^ ZDK_NET::BanafoContactSearchCriteria::Search

get

Word to search for.

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

Returns: The word to search for

◆ Start

int ZDK_NET::BanafoContactSearchCriteria::Start

get

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

List< ZDK_NET:: ContactType>^ ZDK_NET::BanafoContactSearchCriteria::Types

get

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 class was generated from the following file:

BanafoContactSearchCriteria.h

Public Member Functions

Public Attributes

Properties