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. Changes to an instance are not considered after the configuration was already given to the Unblu.createAgentClient(Application, UnbluClientConfiguration, UnbluNotificationApi, InitializeSuccessCallback, InitializeExceptionCallback) / Unblu.createVisitorClient(Application, UnbluClientConfiguration, UnbluNotificationApi, InitializeSuccessCallback, InitializeExceptionCallback) call. There is a base configuration which needs to be given when constructing it. All other configurations are optional.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnbluClientConfiguration.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnbluClientConfiguration()	private constructor for immutable object creation

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAccessToken()	Returns the jsonWebToken value for SSO.
java.lang.String	getApiKey()	Returns the currently configured api key.
java.util.Set<UnbluCookie>	getCustomCookies()	Returns a copy of the currently configured custom cookies.
UnbluDownloadHandler	getDownloadHandler()	Returns the listener which is used to handle file downloads.
java.lang.String	getEntryPath()	Returns the currently configured entry path
UnbluExternalLinkHandler	getExternalLinkHandler()	Returns the currently configured URL patterns which may be opened in the system browser.
java.util.List<java.util.regex.Pattern>	getInternalUrlPatternWhitelist()	Returns the currently configured URL patterns which may be accessed by the WebView
java.lang.String	getLanguage()	Returns the currently configured language.
java.util.HashSet<UnbluModule>	getModules()	Returns a list of all configured modules
java.lang.String	getNamedArea()	Returns the currently configured named area.
NotificationInterceptor	getNotificationInterceptor()	returns Notification interceptor in order to transform the notification before its display
java.lang.String	getOauthToken()	Returns OAuth 2.0 token received from an identity provider.
UnbluPreferencesStorage	getPreferencesStorage()	Returns the storage in which Unblu saves and restores the preferences of the SDK
java.lang.String	getUnbluBaseUrl()	Returns the currently configured base url.
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()

private constructor for immutable object creation

Method Detail

getUnbluBaseUrl

@NonNull
public java.lang.String getUnbluBaseUrl()

Returns the currently configured base url.

Returns:

The currently configured base url.

getApiKey

@NonNull
public java.lang.String getApiKey()

Returns the currently configured api key.

Returns:

The currently configured api key.

getAccessToken

public java.lang.String getAccessToken()

Returns the jsonWebToken value for SSO.

Returns:

The currently configured access token value.

getInternalUrlPatternWhitelist

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

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

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.

Returns:

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

getOauthToken

public java.lang.String getOauthToken()

Returns OAuth 2.0 token received from an identity provider.

Returns:

getEntryPath

@Nullable
public java.lang.String getEntryPath()

Returns the currently configured entry path

Returns:

The currently configured entry path

getCustomCookies

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

Returns a copy of the currently configured custom cookies.

Returns:

A map of the currently configured custom cookies.

getLanguage

@Nullable
public java.lang.String getLanguage()

Returns the currently configured language.

Returns:

The currently configured language.

getNamedArea

@Nullable
public java.lang.String getNamedArea()

Returns the currently configured named area.

Returns:

The currently configured named area.

isNotificationsEnabled

public boolean isNotificationsEnabled()

isCameraUploadsEnabled

public boolean isCameraUploadsEnabled()

Returns:

true if any of the upload file types is enabled.

isPhotoUploadsEnabled

public boolean isPhotoUploadsEnabled()

isVideoUploadsEnabled

public boolean isVideoUploadsEnabled()

isAudioUploadsEnabled

public boolean isAudioUploadsEnabled()

getPreferencesStorage

@NonNull
public UnbluPreferencesStorage getPreferencesStorage()

Returns the storage in which Unblu saves and restores the preferences of the SDK

Returns:

The configured storage.

getModules

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

Returns a list of all configured modules

Returns:

A list of all configured modules

getDownloadHandler

@NonNull
public UnbluDownloadHandler getDownloadHandler()

Returns the listener which is used to handle file downloads.

Returns:

The configured download listener.

getNotificationInterceptor

public NotificationInterceptor getNotificationInterceptor()

returns Notification interceptor in order to transform the notification before its display

Returns:

the notification transformer