com.unblu.visitorsdk

Class UnbluVisitorApiConfiguration

java.lang.Object

com.unblu.coresdk.UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>

com.unblu.visitorsdk.UnbluVisitorApiConfiguration

public class UnbluVisitorApiConfiguration
extends UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>

Configuration for the UnbluVisitorApi. Changes to an instance are not considered after the configuration was already given to the UnbluVisitorApi.configureApi(UnbluVisitorApiConfiguration) call. There is a base configuration which needs to be given when constructing it. All other configurations are optional.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLoginPassword() IMPORTANT: this is currently only a unblu cloud feature! Returns the password which is used to login agains the unblu collaboration server.
java.lang.String	getLoginUsername() IMPORTANT: this is currently only a unblu cloud feature! Returns the username which is used to login agains the unblu collaboration server.
UnbluVisitorApiConfiguration	setLoginInformation(java.lang.String username, java.lang.String password) IMPORTANT: this is currently only a unblu cloud feature! Configures the api to use the following login credentials when starting the api.

Methods inherited from class com.unblu.coresdk.UnbluCoreApiConfiguration

getApiKey, getCustomCookies, getDownloadListener, getEntryPath, getExternalLinkPatternWhitelist, getInternalUrlPatternWhitelist, getLanguage, getNamedArea, getPreferencesStorage, getUnbluBaseUrl, isCameraUploadsEnabled, isNotificationsEnabled, isPreloadUiAfterApiInitEnabled, setApiKey, setCameraUploadsEnabled, setCustomCookies, setDownloadListener, setEntryPath, setExternalLinkPatternWhitelist, setInternalUrlPatternWhitelist, setLanguage, setNamedArea, setNotificationsEnabled, setPreferencesStorage, setPreloadUiAfterApiInitEnabled, setUnbluBaseUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

UnbluVisitorApiConfiguration

public UnbluVisitorApiConfiguration(@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

setLoginInformation

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

IMPORTANT: this is currently only a unblu cloud feature!
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.

Overrides:

setLoginInformation in class UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>

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

@Nullable
public java.lang.String getLoginUsername()

IMPORTANT: this is currently only a unblu cloud feature!
Returns the username which is used to login agains the unblu collaboration server.

Overrides:

getLoginUsername in class UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>

Returns:

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

getLoginPassword

@Nullable
public java.lang.String getLoginPassword()

IMPORTANT: this is currently only a unblu cloud feature!
Returns the password which is used to login agains the unblu collaboration server.

Overrides:

getLoginPassword in class UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>

Returns:

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