public class UnbluVisitorApiConfiguration extends UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>
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 and Description |
---|
UnbluVisitorApiConfiguration(java.lang.String unbluBaseUrl,
java.lang.String apiKey)
Constructs an api configuration.
|
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. |
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
public UnbluVisitorApiConfiguration(@NonNull java.lang.String unbluBaseUrl, @NonNull java.lang.String apiKey)
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).public UnbluVisitorApiConfiguration setLoginInformation(@Nullable java.lang.String username, @Nullable java.lang.String password)
setLoginInformation
in class UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>
username
- The username which should be used to loginpassword
- The password which should be used to login@Nullable public java.lang.String getLoginUsername()
getLoginUsername
in class UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>
@Nullable public java.lang.String getLoginPassword()
getLoginPassword
in class UnbluCoreApiConfiguration<UnbluVisitorApiConfiguration>