com.squareup.square

Interface Configuration

All Known Subinterfaces:

SquareClientInterface

All Known Implementing Classes:

SquareClient

public interface Configuration

Configuration Interface for the library.

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() OAuth 2.0 Access Token.
Headers	getAdditionalHeaders() Additional headers to add to each API request.
String	getBaseUri() Get base URI by current environment.
String	getBaseUri(Server server) Get base URI by current environment.
String	getCustomUrl() Sets the base URL requests are made to.
Environment	getEnvironment() Current API environment.
ReadonlyHttpClientConfiguration	getHttpClientConfig() Http Client Configuration instance.
String	getSquareVersion() Square Connect API versions.
String	getUserAgentDetail() Additional detail which can be appended with User-Agent header.
long	timeout() The timeout to use for making HTTP requests.

Method Detail

getEnvironment

Environment getEnvironment()

Current API environment.

Returns:

a copy of environment

getCustomUrl

String getCustomUrl()

Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`

Returns:

a copy of customUrl

getSquareVersion

String getSquareVersion()

Square Connect API versions.

Returns:

a copy of squareVersion

getHttpClientConfig

ReadonlyHttpClientConfiguration getHttpClientConfig()

Http Client Configuration instance.

Returns:

a copy of httpClientConfig

getAdditionalHeaders

Headers getAdditionalHeaders()

Additional headers to add to each API request.

Returns:

a copy of additionalHeaders

getUserAgentDetail

String getUserAgentDetail()

Additional detail which can be appended with User-Agent header.

Returns:

a copy of userAgentDetail

timeout

long timeout()

The timeout to use for making HTTP requests. The timeout to use for making HTTP requests.

Returns:

a copy of timeout

getAccessToken

String getAccessToken()

OAuth 2.0 Access Token.

Returns:

accessToken

getBaseUri

String getBaseUri(Server server)

Get base URI by current environment.

Parameters:

server - Server for which to get the base URI

Returns:

Processed base URI

getBaseUri

String getBaseUri()

Get base URI by current environment.

Returns:

Processed base URI