com.unblu.sdk.core

Class UnbluApiConfiguration

java.lang.Object

com.unblu.sdk.core.UnbluApiConfiguration

public class UnbluApiConfiguration
extends java.lang.Object

Configuration for the unblu api. Changes to an instance are not considered after the configuration was already given to the UnbluCoreApi.configureApi(UnbluApiConfiguration) 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 and Description
static class	UnbluApiConfiguration.Builder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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
java.util.List<java.util.regex.Pattern>	getExternalLinkPatternWhitelist() 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.List<UnbluModule>	getModules() Returns a list of all configured modules
java.lang.String	getNamedArea() Returns the currently configured named area.
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	isPreloadUiAfterApiInitEnabled() Returns true if currently the pre loading of the UI is enabled.
boolean	isVideoUploadsEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

UnbluApiConfiguration

protected UnbluApiConfiguration()

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.

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

getExternalLinkPatternWhitelist

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

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.

getEntryPath

@NonNull
public java.lang.String getEntryPath()

Returns the currently configured entry path

Returns:

The currently configured entry path

isPreloadUiAfterApiInitEnabled

public boolean isPreloadUiAfterApiInitEnabled()

Returns true if currently the pre loading of the UI is enabled.

Returns:

True if currently the pre loading of the UI is enabled.

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.List<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.