Package com.unblu.sdk.core.configuration

Class UnbluClientConfiguration

java.lang.Object

com.unblu.sdk.core.configuration.UnbluClientConfiguration

public class UnbluClientConfiguration
extends java.lang.Object

Configuration for the UnbluClient. The UnbluClientConfiguration.Builder creates an immutable instance of the class that's then passed to the Unblu.createAgentClient(Application, UnbluClientConfiguration, UnbluNotificationApi, InitializeSuccessCallback, InitializeExceptionCallback) or Unblu.createVisitorClient(Application, UnbluClientConfiguration, UnbluNotificationApi, InitializeSuccessCallback, InitializeExceptionCallback) call.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnbluClientConfiguration.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnbluClientConfiguration()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAccessToken()
java.lang.String	getApiKey()
java.util.Set<UnbluCookie>	getCustomCookies()
UnbluDownloadHandler	getDownloadHandler()
java.lang.String	getEntryPath()
UnbluExternalLinkHandler	getExternalLinkHandler()
java.util.List<java.util.regex.Pattern>	getInternalUrlPatternWhitelist()
java.lang.String	getLanguage()
java.util.HashSet<UnbluModule>	getModules()
java.lang.String	getNamedArea()
NotificationInterceptor	getNotificationInterceptor()
java.lang.String	getOauthToken()
UnbluPreferencesStorage	getPreferencesStorage()
java.lang.String	getUnbluBaseUrl()
UnbluClientCertRequestData	getUnbluClientCertRequestData()
boolean	isAudioUploadsEnabled()
boolean	isCameraUploadsEnabled()
boolean	isNotificationsEnabled()
boolean	isPhotoUploadsEnabled()
boolean	isVideoUploadsEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

UnbluClientConfiguration

protected UnbluClientConfiguration()

Method Detail

getUnbluBaseUrl

@NonNull
public java.lang.String getUnbluBaseUrl()

Returns:

The currently configured base URL

getApiKey

@NonNull
public java.lang.String getApiKey()

Returns:

The currently configured Unblu API key

getUnbluClientCertRequestData

@Nullable
public UnbluClientCertRequestData getUnbluClientCertRequestData()

Returns:

The current clientCertRequestData required for a client certificate request in the Unblu SDK

getAccessToken

public java.lang.String getAccessToken()

Returns:

The currently configured access token value, a JSON Web Token

getInternalUrlPatternWhitelist

@NonNull
public java.util.List<java.util.regex.Pattern> getInternalUrlPatternWhitelist()

Returns:

The currently configured URL patterns which may be accessed by the WebView

getExternalLinkHandler

@NonNull
public UnbluExternalLinkHandler getExternalLinkHandler()

Returns:

The currently configured URL patterns which may be opened in the system browser

getOauthToken

public java.lang.String getOauthToken()

Returns:

The currently configured OAuth 2.0 token, received from an identity provider

getEntryPath

@Nullable
public java.lang.String getEntryPath()

Returns:

The currently configured entry path

getCustomCookies

@NonNull
public java.util.Set<UnbluCookie> getCustomCookies()

Returns:

A Set containing a copy of the currently configured custom cookies.

getLanguage

@Nullable
public java.lang.String getLanguage()

Returns:

A String representing the currently configured language

getNamedArea

@Nullable
public java.lang.String getNamedArea()

Returns:

The currently configured named area

isNotificationsEnabled

public boolean isNotificationsEnabled()

Returns:

true if notifications via Unblu are enabled in the current configuration, false otherwise

isCameraUploadsEnabled

public boolean isCameraUploadsEnabled()

Returns:

true if one or both of photo or video uploads is enabled in the current configuration, false if both are disabled

isPhotoUploadsEnabled

public boolean isPhotoUploadsEnabled()

Returns:

true if photo uploads are enabled in the current configuration, false otherwise

isVideoUploadsEnabled

public boolean isVideoUploadsEnabled()

Returns:

true if video uploads are enabled in the current configuration, false otherwise

isAudioUploadsEnabled

public boolean isAudioUploadsEnabled()

Returns:

true if audio uploads are enabled in the current configuration, false otherwise

getPreferencesStorage

@NonNull
public UnbluPreferencesStorage getPreferencesStorage()

Returns:

The currently configured storage where Unblu saves and restores the SDK's preferences

getModules

@NonNull
public java.util.HashSet<UnbluModule> getModules()

Returns:

A list of all currently configured modules

getDownloadHandler

@NonNull
public UnbluDownloadHandler getDownloadHandler()

Returns:

The currently configured listener used to handle file downloads

getNotificationInterceptor

public NotificationInterceptor getNotificationInterceptor()

Returns:

The currently configured notification interceptor that transforms notifications before they're displayed