com.unblu.coresdk

Class UnbluCoreApiConfiguration<C extends UnbluCoreApiConfiguration>

java.lang.Object

com.unblu.coresdk.UnbluCoreApiConfiguration<C>

Direct Known Subclasses:

UnbluAgentApiConfiguration, UnbluVisitorApiConfiguration

public abstract class UnbluCoreApiConfiguration<C extends UnbluCoreApiConfiguration>
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(UnbluCoreApiConfiguration) call. There is a base configuration which needs to be given when constructing it. All other configurations are optional.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnbluCoreApiConfiguration(java.lang.String unbluBaseUrl, java.lang.String apiKey) Constructs an api configuration.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiKey() Returns the currently configured api key.
java.util.Map<java.lang.String,java.lang.String>	getCustomCookies() Returns a copy of the currently configured custom cookies.
UnbluDownloadListener	getDownloadListener() 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.lang.String	getLoginPassword() Deprecated. This should no longer be used at all! If the person should be logged in, use setCustomCookies(Map) with authentication cookies instead
java.lang.String	getLoginUsername() Deprecated. This should no longer be used at all! If the person should be logged in, use setCustomCookies(Map) with authentication cookies instead
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	isCameraUploadsEnabled()
boolean	isNotificationsEnabled()
boolean	isPreloadUiAfterApiInitEnabled() Returns true if currently the pre loading of the UI is enabled.
C	setApiKey(java.lang.String apiKey) Changes the api key inside this configuration to the given value.
C	setCameraUploadsEnabled(boolean cameraUploadsEnabled) If set to false, uploads directly via the camera app are disabled.
C	setCustomCookies(java.util.Map<java.lang.String,java.lang.String> customCookies) Configures a set of cookies which will be set on the configured base url.
C	setDownloadListener(UnbluDownloadListener downloadListener) Defines the listener for downloads.
C	setEntryPath(java.lang.String entryPath) Sets the entry path inside self configuration to the given value.
C	setExternalLinkPatternWhitelist(java.util.List<java.util.regex.Pattern> externalLinkPatternWhitelist) Sets the list of link patterns that may be opened in the system browser.
C	setInternalUrlPatternWhitelist(java.util.List<java.util.regex.Pattern> internalUrlPatternWhitelist) Sets the list of URL patterns that may be accessed by the WebView.
C	setLanguage(java.lang.String language) Sets the language which will be send to the server to define the language used inside the UI.
C	setLoginInformation(java.lang.String username, java.lang.String password) Deprecated. This should no longer be used at all! If the person should be logged in, use setCustomCookies(Map) with authentication cookies instead
C	setNamedArea(java.lang.String namedArea) Sets the named area for which the configuration is loaded as soon as the api is initializing.
C	setNotificationsEnabled(boolean notificationsEnabled) Configures if notifications via unblu are enabled or not
C	setPreferencesStorage(UnbluPreferencesStorage preferencesStorage) Defines the storage implementation to save and retrieve preferences of the SDK. If it is null, the preferences of the SDK are stored inside the SharedPreferences of the app with Context.MODE_PRIVATE.
C	setPreloadUiAfterApiInitEnabled(boolean preloadUiAfterApiInitEnabled) Enables/disables if the UI should be preloaded, after the unblu api was initialized once.
C	setUnbluBaseUrl(java.lang.String unbluBaseUrl) Changes the base url inside this configuration to the given value

Methods inherited from class java.lang.Object

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

Constructor Detail

UnbluCoreApiConfiguration

protected UnbluCoreApiConfiguration(@NonNull
                                    java.lang.String unbluBaseUrl,
                                    @NonNull
                                    java.lang.String apiKey)

Constructs an api configuration.

Parameters:

unbluBaseUrl - The url to the unblu server. (full URL: http(s)://domain:port)

apiKey - Your unblu API key (can be retrieved / created on the unblu agent desk).

Method Detail

setUnbluBaseUrl

public C setUnbluBaseUrl(@NonNull
                         java.lang.String unbluBaseUrl)

Changes the base url inside this configuration to the given value

Parameters:

unbluBaseUrl - The url to the unblu server. (full URL: http(s)://domain:port)

Returns:

The configuration to chain multiple calls.

getUnbluBaseUrl

@NonNull
public java.lang.String getUnbluBaseUrl()

Returns the currently configured base url.

Returns:

The currently configured base url.

setApiKey

public C setApiKey(@NonNull
                   java.lang.String apiKey)

Changes the api key inside this configuration to the given value.

Parameters:

apiKey - Your unblu API key (can be retrieved / created on the unblu agent desk).

Returns:

The configuration to chain multiple calls.

getApiKey

@NonNull
public java.lang.String getApiKey()

Returns the currently configured api key.

Returns:

The currently configured api key.

setInternalUrlPatternWhitelist

public C setInternalUrlPatternWhitelist(@NonNull
                                        java.util.List<java.util.regex.Pattern> internalUrlPatternWhitelist)

Sets the list of URL patterns that may be accessed by the WebView.

This restricts access to:

• URLs loaded in the WebView
• all assets (css, js, images, ...)
• AJAX requests

The configured baseURL will be automatically added to the list. This is mainly required if you use redirects from the initial base url to a different domain or if resources like web fonts are loaded from other locations.

Parameters:

internalUrlPatternWhitelist - List of url patterns which may be accessed by the WebView

Returns:

The configuration to chain multiple calls.

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

setExternalLinkPatternWhitelist

public C setExternalLinkPatternWhitelist(@NonNull
                                         java.util.List<java.util.regex.Pattern> externalLinkPatternWhitelist)

Sets the list of link patterns that may be opened in the system browser.

Those are typical links from the chat which are clicked by the user.

The following patterns are added per default, and will be overridden by calling this function.

• ^\Qhttps://\E.*
• ^\Qmailto://\E.*
• ^\Qtel:\E.*

If a link does not match one of those patterns, clicking on it, will not do anything with it.

Parameters:

externalLinkPatternWhitelist - List of url patterns which may be opened in the system browser

Returns:

The configuration to chain multiple calls.

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.

setEntryPath

public C setEntryPath(@NonNull
                      java.lang.String entryPath)

Sets the entry path inside self configuration to the given value. Default is "/unblu".
Do not miss the leading slash!

Parameters:

entryPath - The entry path used to connect to the unblu server. Typicall value is "/unblu" or "/co-unblu".

Returns:

The configuration to chain multiple calls

getEntryPath

@NonNull
public java.lang.String getEntryPath()

Returns the currently configured entry path

Returns:

The currently configured entry path

setPreloadUiAfterApiInitEnabled

public C setPreloadUiAfterApiInitEnabled(boolean preloadUiAfterApiInitEnabled)

Enables/disables if the UI should be preloaded, after the unblu api was initialized once.

Parameters:

preloadUiAfterApiInitEnabled - If set to true, the UI will be pre loaded after the api was initialized successfully. Otherwise the UI will be loaded, when it is requested to be shown. If you want to do a pre load of the UI manually, use UnbluCoreApi.preloadUi(IUnbluApiSuccessVoidCallback, IUnbluApiNotInitializedExceptionCallback).

Returns:

The configuration to chain multiple calls

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.

setCustomCookies

public C setCustomCookies(@NonNull
                          java.util.Map<java.lang.String,java.lang.String> customCookies)

Configures a set of cookies which will be set on the configured base url. It will store only a copy of the given map.

Parameters:

customCookies - The cookies which will later be used on the configured base url.

Returns:

The configuration to chain multiple calls.

getCustomCookies

public java.util.Map<java.lang.String,java.lang.String> getCustomCookies()

Returns a copy of the currently configured custom cookies.

Returns:

A map of the currently configured custom cookies.

setLanguage

public C setLanguage(@Nullable
                     java.lang.String language)

Sets the language which will be send to the server to define the language used inside the UI. If the language is not explicitly defined, the system language of the device is used.

Parameters:

language - The language which is set to the server.

Returns:

The configuration to chain multiple calls.

getLanguage

public java.lang.String getLanguage()

Returns the currently configured language.

Returns:

The currently configured language.

setNamedArea

public C setNamedArea(@Nullable
                      java.lang.String namedArea)

Sets the named area for which the configuration is loaded as soon as the api is initializing. When sessions are started and are put into the queue on the agent desk, they can be filtered by the defined named area. The named area must be configured inside the agent desk.

Parameters:

namedArea - The named area meta tag id configured in the agent desk.

Returns:

The configuration to chain multiple calls.

getNamedArea

public java.lang.String getNamedArea()

Returns the currently configured named area.

Returns:

The currently configured named area.

setNotificationsEnabled

public C setNotificationsEnabled(boolean notificationsEnabled)

Configures if notifications via unblu are enabled or not

Parameters:

notificationsEnabled: - if true, notifications are enabled. Otherwise they are disabled

Returns:

The configuration to chain multiple calls

isNotificationsEnabled

public boolean isNotificationsEnabled()

setCameraUploadsEnabled

public C setCameraUploadsEnabled(boolean cameraUploadsEnabled)

If set to false, uploads directly via the camera app are disabled. Default is true.
The images captured via the camera app are stored in a temporary file inside the external storage folder, where they could be accessed by other apps with the permission Manifest.permission.READ_EXTERNAL_STORAGE. It could be considered as unsafe for security reasons.

Parameters:

cameraUploadsEnabled - If set to true, uploads directly via the camera app are enabled.

Returns:

The configuration to chain multiple calls

isCameraUploadsEnabled

public boolean isCameraUploadsEnabled()

setLoginInformation

@Deprecated
public C setLoginInformation(@Nullable
                                         java.lang.String username,
                                         @Nullable
                                         java.lang.String password)

Deprecated. This should no longer be used at all! If the person should be logged in, use setCustomCookies(Map) with authentication cookies instead

Configures the api to use the following login credentials when starting the api. The username and password should match a user which exists on the unblu collaboration server. If either username or password is null, the login information are not used.

Parameters:

username - The username which should be used to login

password - The password which should be used to login

Returns:

The configuration to chain multiple calls

getLoginUsername

@Deprecated
 @Nullable
public java.lang.String getLoginUsername()

Deprecated. This should no longer be used at all! If the person should be logged in, use setCustomCookies(Map) with authentication cookies instead

Returns the username which is used to login against the unblu collaboration server.

Returns:

The username which is used to login against the unblu collaboration server.

getLoginPassword

@Deprecated
 @Nullable
public java.lang.String getLoginPassword()

Deprecated. This should no longer be used at all! If the person should be logged in, use setCustomCookies(Map) with authentication cookies instead

Returns the password which is used to login against the unblu collaboration server.

Returns:

The password which is used to login against the unblu collaboration server.

setPreferencesStorage

public C setPreferencesStorage(@Nullable
                               UnbluPreferencesStorage preferencesStorage)

Defines the storage implementation to save and retrieve preferences of the SDK.
If it is null, the preferences of the SDK are stored inside the SharedPreferences of the app with Context.MODE_PRIVATE.

Parameters:

preferencesStorage - The storage where the SDK will safe its preferences to.

Returns:

The configuration to chain multiple calls

getPreferencesStorage

@Nullable
public UnbluPreferencesStorage getPreferencesStorage()

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

Returns:

The configured storage. Null if the default is used.

setDownloadListener

public C setDownloadListener(@Nullable
                             UnbluDownloadListener downloadListener)

Defines the listener for downloads. This listener then has to handle the download completely.
If it is null, a default implementation is used which stores the files into the public downloads directory.

Parameters:

downloadListener - The listener which handles all file downloads

Returns:

The configuration to chain multiple calls

getDownloadListener

@Nullable
public UnbluDownloadListener getDownloadListener()

Returns the listener which is used to handle file downloads.

Returns:

The configured download listener. Null if the default is used.