com.zoiper.zdk

Class BanafoContactSearchCriteria

java.lang.Object

com.zoiper.zdk.BanafoContactSearchCriteria

public class BanafoContactSearchCriteria
extends java.lang.Object

Banafo listing contacts search criteria Describes the search criteria used for listing Banafo contacts.

Constructor Summary

Constructors

Constructor and Description
BanafoContactSearchCriteria(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
java.lang.String	contactId() Contact ID of the required contact Contact ID of the required contact.
protected void	finalize() Ensures the underlying native object destruction
long	handle() Gets the pointer/address to the underlying native object
int	limit() 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.
java.lang.String	nationalNumber() National number for improved phone number searches National number for improved phone number searches, taken into account only when 'Phone' is also present.
java.lang.String	pageId() 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).
java.lang.String	phone() Phone number to search for Phone number to search for.
java.lang.String	provider() 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.
java.lang.String	region() Region code Two-letter region code for parsing phone numbers without county code.
boolean	reverseLookup() Reverse phone lookup Indicates whether the search will be a Reverse Lookup or normal Contact Listing.
java.lang.String	search() Word to search for Word to search for - name, company name, email, phone, etc.
int	start() 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.
java.util.List<ContactType>	types() List of types to filter by List of types to filter by.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BanafoContactSearchCriteria

public BanafoContactSearchCriteria(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

contactId

public java.lang.String contactId()

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

provider

public java.lang.String provider()

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

search

public java.lang.String search()

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

Returns:

The word to search for

types

public java.util.List<ContactType> types()

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

phone

public java.lang.String phone()

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

Returns:

The phone number to search for

nationalNumber

public java.lang.String nationalNumber()

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

reverseLookup

public boolean reverseLookup()

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

region

public java.lang.String region()

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

Returns:

The region code

start

public int start()

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

limit

public int limit()

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

pageId

public java.lang.String pageId()

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