com.urbanairship.api.client

Class UrbanAirshipClient.Builder

java.lang.Object

com.urbanairship.api.client.UrbanAirshipClient.Builder

Enclosing class:

UrbanAirshipClient

public static class UrbanAirshipClient.Builder
extends java.lang.Object

UrbanAirshipClient builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
UrbanAirshipClient	build() Build an UrbanAirshipClient object.
UrbanAirshipClient.Builder	setBaseUri(java.lang.String baseUri) Changes base URI.
UrbanAirshipClient.Builder	setBearerToken(java.lang.String bearerToken) Set the bearer token.
UrbanAirshipClient.Builder	setClient(RequestClient client) Set a custom client.
UrbanAirshipClient.Builder	setKey(java.lang.String key) Set the app key.
UrbanAirshipClient.Builder	setOAuthBaseUri(java.lang.String oAuthBaseUri) Set an oAuthBaseUri.
UrbanAirshipClient.Builder	setOAuthCredentials(OAuthCredentials oAuthCredentials) Set the oAuthCredentials.
UrbanAirshipClient.Builder	setSecret(java.lang.String appSecret) Set the app secret.
UrbanAirshipClient.Builder	setUseEuropeanSite(boolean useEuropeanSite) Set useEuropeanSite.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setKey

public UrbanAirshipClient.Builder setKey(java.lang.String key)

Set the app key.

Parameters:

key - String app key

Returns:

Builder

setUseEuropeanSite

public UrbanAirshipClient.Builder setUseEuropeanSite(boolean useEuropeanSite)

Set useEuropeanSite.

Parameters:

useEuropeanSite - Boolean

Returns:

Builder

setSecret

public UrbanAirshipClient.Builder setSecret(java.lang.String appSecret)

Set the app secret.

Parameters:

appSecret - String app secret

Returns:

Builder

setBaseUri

public UrbanAirshipClient.Builder setBaseUri(java.lang.String baseUri)

Changes base URI. Without changing URI, it defaults to https://go.urbanairship.com. To send to European Servers use UrbanAirshipClient.EU_URI

Parameters:

baseUri - String baseUri used for requests

Returns:

Builder

setBearerToken

public UrbanAirshipClient.Builder setBearerToken(java.lang.String bearerToken)

Set the bearer token.

Parameters:

bearerToken - String bearer token

Returns:

Builder

setOAuthCredentials

public UrbanAirshipClient.Builder setOAuthCredentials(OAuthCredentials oAuthCredentials)

Set the oAuthCredentials.

Parameters:

oAuthCredentials - String

Returns:

Builder

setOAuthBaseUri

public UrbanAirshipClient.Builder setOAuthBaseUri(java.lang.String oAuthBaseUri)

Set an oAuthBaseUri.

Parameters:

oAuthBaseUri - String

Returns:

Builder

setClient

public UrbanAirshipClient.Builder setClient(RequestClient client)

Set a custom client.

Parameters:

client - RequestClient client

Returns:

Builder

build

public UrbanAirshipClient build()

Build an UrbanAirshipClient object. Will fail if any of the following preconditions are not met.

 1. App key or client must be set.
 2. App secret or bearer token must be set if no client is provided.
 3. The base URI has been overridden but not set.
 4. Max for non-POST 5xx retries must be set, already defaults to 10 when using the default client.
 5. HTTP client config builder must be set in the default client, already defaults to a new builder.
 

Returns:

UrbanAirshipClient