Gini Bank API Library for Android/net.gini.android.core.api.internal/GiniCoreAPIBuilder

GiniCoreAPIBuilder

public abstract class GiniCoreAPIBuilder<DM extends DocumentManager<DR, E>, G extends GiniCoreAPI<DM, DR, E>, DR extends DocumentRepository<E>, E extends ExtractionsContainer>

The GiniCoreAPIBuilder allows you to build and configure a GiniCoreAPI instance.

Parameters

context

your application's Context instance (Android)

clientId

your application's client ID for the Gini Health API

clientSecret

your application's client secret for the Gini Health API

emailDomain

the email domain which is used for created Gini users

sessionManager

if not null, then the SessionManager instance will be used for session management. If null, then anonymous Gini users will be used.

Constructors

GiniCoreAPIBuilder

public GiniCoreAPIBuilder<DM, G, DR, E> GiniCoreAPIBuilder(Context context, String clientId, String clientSecret, String emailDomain, SessionManager sessionManager)

Initializes a new builder instance.

Types

Companion

public class Companion

Functions

build

public abstract G build()

Builds an instance with the configuration settings of the builder instance.

getGiniApiType

public abstract GiniApiType getGiniApiType()

Differentiate between different types of GiniApi's.

getSessionManager

@Synchronized()

public SessionManager getSessionManager()

Return the SessionManager set via #setSessionManager. If no SessionManager has been set, default to AnonymousSessionManager.

setApiBaseUrl

public GiniCoreAPIBuilder<DM, G, DR, E> setApiBaseUrl(String newUrl)

Set the base URL of the Gini API. Handy for tests. Usually, you do not use this method.

setCache

public GiniCoreAPIBuilder<DM, G, DR, E> setCache(Cache cache)

Set the cache implementation to use with OkHttp caching. If no cache is set, no caching will be used.

setConnectionTimeoutInMs

public GiniCoreAPIBuilder<DM, G, DR, E> setConnectionTimeoutInMs(Integer connectionTimeoutInMs)

Sets the (initial) timeout for each request. A timeout error will occur if nothing is received from the underlying socket in the given time span. The initial timeout will be altered depending on the #backoffMultiplier and failed retries.

setCredentialsStore

public GiniCoreAPIBuilder<DM, G, DR, E> setCredentialsStore(CredentialsStore credentialsStore)

Set the credentials store which is used by the library to store user credentials. If no credentials store is set, the net.gini.android.core.api.authorization.SharedPreferencesCredentialsStore is used by default.

setDebuggingEnabled

public final GiniCoreAPIBuilder<DM, G, DR, E> setDebuggingEnabled(Boolean enabled)

Enable or disable debugging.

setNetworkSecurityConfigResId

public GiniCoreAPIBuilder<DM, G, DR, E> setNetworkSecurityConfigResId(@XmlRes() Integer networkSecurityConfigResId)

Set the resource id for the network security configuration xml to enable public key pinning.

setTrustManager

public GiniCoreAPIBuilder<DM, G, DR, E> setTrustManager(TrustManager trustManager)

Set a custom TrustManager implementation to have full control over which certificates to trust.

setUserCenterApiBaseUrl

public GiniCoreAPIBuilder<DM, G, DR, E> setUserCenterApiBaseUrl(String newUrl)

Set the base URL of the Gini User Center API. Handy for tests. Usually, you do not use this method.

Inheritors

GiniBankAPIBuilder