com.tapkey.mobile

Class TapkeyServiceFactoryBuilder

java.lang.Object

com.tapkey.mobile.TapkeyServiceFactoryBuilder

public class TapkeyServiceFactoryBuilder
extends Object

This class is used to build a TapkeyServiceFactory.

The example below illustrates a default use of this class and will cover most use cases:

 TapkeyServiceFactoryBuilder b = new TapkeyServiceFactoryBuilder();
 TapkeyServiceFactory tapkeyServiceFactory = b.build(this);
 

See Also:

TapkeyServiceFactory

Constructor Summary

Constructors

Constructor and Description
TapkeyServiceFactoryBuilder(android.app.Application application) Constructs a Tapkey service factory builder.

Method Summary

Modifier and Type	Method and Description
TapkeyServiceFactoryBuilder	addDataContextMigrationListener(net.tpky.mc.dao.DataContextMigrationListener dataContextMigrationListener) Reserved for internal use.
TapkeyServiceFactory	build() Builds the service factory.
TapkeyServiceFactoryBuilder	setCloudMessagingManager(net.tpky.mc.manager.CloudMessagingManager cloudMessagingManager) Reserved for internal use.
TapkeyServiceFactoryBuilder	setConfig(TapkeyEnvironmentConfig config) Overrides the default Tapkey environment configuration with the specified one.
TapkeyServiceFactoryBuilder	setDiagnosticsHandler(net.tpky.mc.diagnostics.DiagnosticsHandler diagnosticsHandler) Reserved for internal use.
TapkeyServiceFactoryBuilder	setHttpRequestExecutor(net.tpky.mc.rest.AsyncHttpRequestExecutor httpRequestExecutor) Reserved for internal use.
TapkeyServiceFactoryBuilder	setServerClock(net.tpky.mc.time.ServerClock serverClock) Overrides the internal server clock used by various components of the SDK.
TapkeyServiceFactoryBuilder	setTokenRefreshHandler(TokenRefreshHandler tokenRefreshHandler) Sets the application's token refresh handler.
TapkeyServiceFactoryBuilder	setWebSocketFactory(net.tpky.mc.relay.WebSocketFactory webSocketFactory) Reserved for internal use.

Methods inherited from class java.lang.Object

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

Constructor Detail

TapkeyServiceFactoryBuilder

public TapkeyServiceFactoryBuilder(android.app.Application application)

Constructs a Tapkey service factory builder.

Parameters:

application - the app's application instance.

Method Detail

setConfig

public TapkeyServiceFactoryBuilder setConfig(TapkeyEnvironmentConfig config)

Overrides the default Tapkey environment configuration with the specified one. Must only be used if suggested by Tapkey.

Parameters:

config - the custom Tapkey environment configuration.

Returns:

the TapkeyServiceFactoryBuilder instance for chaining.

setHttpRequestExecutor

public TapkeyServiceFactoryBuilder setHttpRequestExecutor(net.tpky.mc.rest.AsyncHttpRequestExecutor httpRequestExecutor)

Reserved for internal use.

setWebSocketFactory

public TapkeyServiceFactoryBuilder setWebSocketFactory(net.tpky.mc.relay.WebSocketFactory webSocketFactory)

Reserved for internal use.

setDiagnosticsHandler

public TapkeyServiceFactoryBuilder setDiagnosticsHandler(net.tpky.mc.diagnostics.DiagnosticsHandler diagnosticsHandler)

Reserved for internal use.

setCloudMessagingManager

public TapkeyServiceFactoryBuilder setCloudMessagingManager(net.tpky.mc.manager.CloudMessagingManager cloudMessagingManager)

Reserved for internal use.

setTokenRefreshHandler

public TapkeyServiceFactoryBuilder setTokenRefreshHandler(TokenRefreshHandler tokenRefreshHandler)

Sets the application's token refresh handler. The SDK will call this handler to request renewal of access tokens.

Parameters:

tokenRefreshHandler - the TokenRefreshHandler

Returns:

the TapkeyServiceFactoryBuilder instance for chaining.

See Also:

TokenRefreshHandler

addDataContextMigrationListener

public TapkeyServiceFactoryBuilder addDataContextMigrationListener(net.tpky.mc.dao.DataContextMigrationListener dataContextMigrationListener)

Reserved for internal use.

setServerClock

public TapkeyServiceFactoryBuilder setServerClock(net.tpky.mc.time.ServerClock serverClock)

Overrides the internal server clock used by various components of the SDK. If applications require access to the server clock, they must use this method to override the SDK's internal server clock and keep hold of the reference for later use.

Parameters:

serverClock - the ServerClock to be used by the SDK.

Returns:

the TapkeyServiceFactoryBuilder instance for chaining.

build

public TapkeyServiceFactory build()

Builds the service factory.

Returns:

the TapkeyServiceFactory with the configured properties.

See Also:

TapkeyServiceFactory