com.whitepages.proapi.api.client

Class Client

java.lang.Object

com.whitepages.proapi.api.client.Client

public class Client
extends java.lang.Object

The Client class is the starting point for interaction with the Whitepages API, serving as the starting place for making requests and getting results.

The key steps for use of the Client are:

1. Instantiation of a Client,
2. Creation of a Query, and
3. Execution of the Query via the find methods on the Client.

For example:

 Client client = new Client("yourapikey");

 PersonQuery personQuery = new PersonQuery("Rory", null, "Williams");
 Response<Person> = client.findPeople(personQuery);

 List<Person> results = Response.getResults();
 for( Person p : results ) {
     System.out.println(p.getBestName());
 }
 
 

In production applications, it is typically preferable to instantiate a single Client instance per thread, repeatedly using it for sequential requests to the API.

See Also:

Config, Query, Response

Constructor Summary

Constructors

Constructor and Description
Client(Config config) Creates a Client instance with the given Config instance.
Client(java.lang.String apiKey) Creates a Client instance configured with the given API Key.

Method Summary

Methods

Modifier and Type	Method and Description
Response<Business>	findBusinesses(BusinessQuery query) Executes the given query and returns the response.
Response<Location>	findLocations(LocationQuery query) Executes the given query and returns the response.
Response<Person>	findPeople(PersonQuery query) Executes the given query and returns the response.
Response<Phone>	findPhones(PhoneQuery query) Executes the given query and returns the response.
Config	getConfig()

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(java.lang.String apiKey)

Creates a Client instance configured with the given API Key.

Parameters:

apiKey - Your Whitepages API key.

See Also:

Config

Client

public Client(Config config)

Creates a Client instance with the given Config instance.

The Config instance is not duplicated, so alterations to it will affect all Client instances using it.

Parameters:

config - The Config instance to use.

Method Detail

getConfig

public Config getConfig()

findPeople

public Response<Person> findPeople(PersonQuery query)
                            throws FindException

Executes the given query and returns the response.

Parameters:

query - The query to perform.

Returns:

The Response object.

Throws:

FindException - Thrown if an exception occurs before a Response object could be created.

findBusinesses

public Response<Business> findBusinesses(BusinessQuery query)
                                  throws FindException

Executes the given query and returns the response.

Parameters:

query - The query to perform.

Returns:

The Response object.

Throws:

FindException - Thrown if an exception occurs before a Response object could be created.

findPhones

public Response<Phone> findPhones(PhoneQuery query)
                           throws FindException

Executes the given query and returns the response.

Parameters:

query - The query to perform.

Returns:

The Response object.

Throws:

FindException - Thrown if an exception occurs before a Response object could be created.

findLocations

public Response<Location> findLocations(LocationQuery query)
                                 throws FindException

Executes the given query and returns the response.

Parameters:

query - The query to perform.

Returns:

The Response object.

Throws:

FindException - Thrown if an exception occurs before a Response object could be created.