com.baasbox.android

Class BaasBox.Builder

java.lang.Object

com.baasbox.android.BaasBox.Builder

Enclosing class:

BaasBox

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

Builder for BaasBox client

Since:

0.7.4

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context) Creates a new builder

Method Summary

Modifier and Type	Method and Description
<O extends Plugin.Options> BaasBox.Builder	addPlugin(Plugin<O> plugin, O opt)
BaasBox.Builder	addPlugin(Plugin<Plugin.Options.Empty> plugin)
BaasBox	init() Initializes a BaasBox client based on this builder
BaasBox.Builder	setApiBasepath(java.lang.String basepath) Sets the api basePath prefix
BaasBox.Builder	setApiDomain(java.lang.String domain) Sets the host this client will connect to
BaasBox.Builder	setAppCode(java.lang.String code) Sets the app code for this client
BaasBox.Builder	setAuthentication(BaasBox.Config.AuthType auth) Sets the authentication type, defaults to BaasBox.Config.AuthType.SESSION_TOKEN
BaasBox.Builder	setExceptionHandler(ExceptionHandler handler)
BaasBox.Builder	setHttpCharset(java.lang.String charset) Sets the charset to use defaults to 'UTF-8'.
BaasBox.Builder	setHttpConnectionTimeout(int timeout) Sets the connection timeout for this client
BaasBox.Builder	setHttpSocketTimeout(int timeout) Sets the read timeout for this client
BaasBox.Builder	setPort(int port) Sets the port this client will connect to
BaasBox.Builder	setPushSenderId(java.lang.String... senderIds) Sets gcm sender id to use for notifications
BaasBox.Builder	setRestClient(RestClient client)
BaasBox.Builder	setSessionTokenExpires(boolean expires) Sets if the session token will expire, defaults to false.
BaasBox.Builder	setUseHttps(boolean useHttps)
BaasBox.Builder	setWorkerThreads(int workers)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context)

Creates a new builder

Parameters:

context - s

Method Detail

setSessionTokenExpires

public BaasBox.Builder setSessionTokenExpires(boolean expires)

Sets if the session token will expire, defaults to false.

Parameters:

expires - true if you want the session token not to be refreshed

Returns:

this builder

setPushSenderId

public BaasBox.Builder setPushSenderId(java.lang.String... senderIds)

Sets gcm sender id to use for notifications

Parameters:

senderIds - the senderIds to use

Returns:

this builder

setHttpCharset

public BaasBox.Builder setHttpCharset(java.lang.String charset)

Sets the charset to use defaults to 'UTF-8'.

Parameters:

charset -

Returns:

this builder

setExceptionHandler

public BaasBox.Builder setExceptionHandler(ExceptionHandler handler)

setAuthentication

public BaasBox.Builder setAuthentication(BaasBox.Config.AuthType auth)

Sets the authentication type, defaults to BaasBox.Config.AuthType.SESSION_TOKEN

Parameters:

auth -

Returns:

this builder

setPort

public BaasBox.Builder setPort(int port)

Sets the port this client will connect to

Parameters:

port -

Returns:

this builder

setApiBasepath

public BaasBox.Builder setApiBasepath(java.lang.String basepath)

Sets the api basePath prefix

Parameters:

basepath -

Returns:

this builder

setHttpConnectionTimeout

public BaasBox.Builder setHttpConnectionTimeout(int timeout)

Sets the connection timeout for this client

Parameters:

timeout -

Returns:

this builder

setHttpSocketTimeout

public BaasBox.Builder setHttpSocketTimeout(int timeout)

Sets the read timeout for this client

Parameters:

timeout -

Returns:

this builder

setApiDomain

public BaasBox.Builder setApiDomain(java.lang.String domain)

Sets the host this client will connect to

Parameters:

domain -

Returns:

this builder

setAppCode

public BaasBox.Builder setAppCode(java.lang.String code)

Sets the app code for this client

Parameters:

code -

Returns:

this builder

setUseHttps

public BaasBox.Builder setUseHttps(boolean useHttps)

setWorkerThreads

public BaasBox.Builder setWorkerThreads(int workers)

setRestClient

public BaasBox.Builder setRestClient(RestClient client)

init

public BaasBox init()

Initializes a BaasBox client based on this builder

Returns:

a singleton BaasBox client

addPlugin

public <O extends Plugin.Options> BaasBox.Builder addPlugin(Plugin<O> plugin,
                                                            O opt)

addPlugin

public BaasBox.Builder addPlugin(Plugin<Plugin.Options.Empty> plugin)