Skip navigation links
A C D E G H I J L N O P R S T U V 

A

addPrivateView(int) - Method in class com.unblu.coresdk.UnbluCoreApi
Adds the view with the given id to the set of private views.
ANIMATION_TIME - Static variable in class com.unblu.coresdk.UnbluCoreApi
The time used for the fade in and fade out animation when showing/hiding the UI

C

calculateUiBottomMargin(int, int, Activity) - Static method in class com.unblu.coresdk.ui.UnbluUiButton
Helper to calculate the bottom margin of the Unblu UI if there is an UnbluUiButton.
com.unblu.agentsdk - package com.unblu.agentsdk
 
com.unblu.coresdk - package com.unblu.coresdk
 
com.unblu.coresdk.model - package com.unblu.coresdk.model
 
com.unblu.coresdk.ui - package com.unblu.coresdk.ui
 
com.unblu.visitorsdk - package com.unblu.visitorsdk
 
configureApi(UnbluAgentApiConfiguration) - Method in class com.unblu.agentsdk.UnbluAgentApi
Configures the unblu api.
configureApi(UnbluCoreApiConfiguration) - Method in class com.unblu.coresdk.UnbluCoreApi
Configures the unblu api.
configureApi(UnbluVisitorApiConfiguration) - Method in class com.unblu.visitorsdk.UnbluVisitorApi
Configures the unblu api.
ConversationType - Enum in com.unblu.visitorsdk
The type of a conversation.
createLoadingView(Context) - Method in interface com.unblu.coresdk.ui.IUnbluCustomLoadingViewCreator
Called whenever a loading view is presented

D

deinitApi(IUnbluApiSuccessVoidCallback, IUnbluDeinitializeExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Deinitializes the unblu API.
displayName - Variable in class com.unblu.coresdk.model.PersonInfo
The displayed name of the person

E

enableCapturingPerformanceLogging - Static variable in class com.unblu.coresdk.UnbluCoreApi
Enables logging of capturing performance (e.g.
enableDebugOutput - Static variable in class com.unblu.coresdk.UnbluCoreApi
Enables the debug output of the Unblu SDK.

G

get(String) - Method in interface com.unblu.coresdk.UnbluPreferencesStorage
A preference should be read from the storage
getApiKey() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the currently configured api key.
getApplication() - Method in class com.unblu.coresdk.UnbluCoreApi
Returns the application context object
getButtonColor() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the current color of the button
getButtonElevation() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the current elevation of button
getCloseUiIconId() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the resource id of the icon which is displayed to close the UI
getCustomCookies() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns a copy of the currently configured custom cookies.
getCustomLoadingViewCreator() - Method in class com.unblu.coresdk.UnbluCoreApi
Returns the currently configured loading view creator
getDownloadListener() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the listener which is used to handle file downloads.
getEntryPath() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the currently configured entry path
getExternalLinkPatternWhitelist() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the currently configured URL patterns which may be opened in the system browser.
getHeight() - Method in class com.unblu.coresdk.model.PrivateArea
 
getIconColor() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the color of the icon which is on the button
getInstance() - Static method in class com.unblu.agentsdk.UnbluAgentApi
 
getInstance() - Static method in class com.unblu.visitorsdk.UnbluVisitorApi
 
getInternalUrlPatternWhitelist() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the currently configured URL patterns which may be accessed by the WebView
getLanguage() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the currently configured language.
getLoginPassword() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Deprecated.
This should no longer be used at all! If the person should be logged in, use UnbluCoreApiConfiguration.setCustomCookies(Map) with authentication cookies instead
getLoginPassword() - Method in class com.unblu.visitorsdk.UnbluVisitorApiConfiguration
IMPORTANT: this is currently only a unblu cloud feature!
Returns the password which is used to login agains the unblu collaboration server.
getLoginUsername() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Deprecated.
This should no longer be used at all! If the person should be logged in, use UnbluCoreApiConfiguration.setCustomCookies(Map) with authentication cookies instead
getLoginUsername() - Method in class com.unblu.visitorsdk.UnbluVisitorApiConfiguration
IMPORTANT: this is currently only a unblu cloud feature!
Returns the username which is used to login agains the unblu collaboration server.
getLogLevel() - Static method in class com.unblu.coresdk.UnbluCoreApi
Returns the log level of the Unblu SDK.
getNamedArea() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the currently configured named area.
getNotificationsBadgeColor() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the current color of the notification badge
getNotificationsBadgeElevation() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the current elevation of the notification badge
getNotificationsBadgeTextColor() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the color of the text of the notification badge
getOpenConversationId() - Method in class com.unblu.coresdk.UnbluCoreApi
Returns the id of the currently opened conversation inside the UI.
Null if no conversation is open
getOpenUiIconId() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the resource id of the icon which is displayed to open the UI
getOverlayColor() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns the current color of the overlay
getPersonInfo() - Method in class com.unblu.coresdk.UnbluCoreApi
Returns the info of the current person
getPreferencesStorage() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the storage in which unblu saves and restores the preferences of the SDK
getUiBottomMargin() - Method in class com.unblu.coresdk.UnbluCoreApi
Returns the current bottom margin of the unblu Ui
getUiTopMargin() - Method in class com.unblu.coresdk.UnbluCoreApi
Returns the current top margin of the unblu Ui
getUnbluBaseUrl() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns the currently configured base url.
getUnreadMessagesCount() - Method in class com.unblu.coresdk.UnbluCoreApi
Returns the number of unread messages
getWidth() - Method in class com.unblu.coresdk.model.PrivateArea
 
getX() - Method in class com.unblu.coresdk.model.PrivateArea
 
getY() - Method in class com.unblu.coresdk.model.PrivateArea
 

H

handlePress(boolean) - Method in interface com.unblu.coresdk.IBackButtonCallback
Called whenever the back button is pressed while the Unblu UI is displayed

I

IBackButtonCallback - Interface in com.unblu.coresdk
Callback for back button presses while the Unblu UI is displayed.
id - Variable in class com.unblu.coresdk.model.PersonInfo
The person id of that person
initApi(IUnbluApiSuccessfullyInitializedCallback, IUnbluApiInitializeExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Inits the unblu API.
internalGetCoreInstance() - Static method in class com.unblu.coresdk.UnbluCoreApi
 
isAddOverlayToParentView() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns true of adding of an overlay is enabled.
isAgentAvailable(IUnbluApiSuccessCallback<Boolean>, IUnbluApiNotInitializedExceptionCallback) - Method in class com.unblu.visitorsdk.UnbluVisitorApi
Checks if at least one agent is available for co-browsing / chat.
isAutoMaximizeOnCallUiVisible() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Checks if the flag to automatically maximize the call UI.
isAutoUpdateUiBottomMargin() - Method in class com.unblu.coresdk.ui.UnbluUiButton
Returns true if the auto updating of the bottom margin is enabled.
isCallActive(IUnbluApiSuccessCallback<Boolean>, IUnbluApiNotInitializedExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Returns if there is currently a call or not.
isCallUiOpen(IUnbluApiSuccessCallback<Boolean>, IUnbluApiNotInitializedExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Checks if the call UI for an audio/video call is open or not.
isCameraUploadsEnabled() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
 
isInErrorState() - Method in class com.unblu.coresdk.UnbluCoreApi
 
isInitialized() - Method in class com.unblu.coresdk.UnbluCoreApi
 
isLowerThen(LogLevel) - Method in enum com.unblu.coresdk.LogLevel
Compares another log level with this log level.
Lower log level means, that the other log level is less verbose.
isMobileCoBrowsingActive() - Method in class com.unblu.coresdk.UnbluCoreApi
Checks if mobile co-browsing is active
isNotificationsEnabled() - Method in class com.unblu.coresdk.UnbluCoreApi
 
isNotificationsEnabled() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
 
isPreloadUiAfterApiInitEnabled() - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Returns true if currently the pre loading of the UI is enabled.
isUiVisible() - Method in class com.unblu.coresdk.UnbluCoreApi
Checks if the UI is visible or not
isUnbluNotification(Map<String, String>) - Static method in class com.unblu.coresdk.UnbluNotificationApi
Checks if the data of a notification belong to an unblu notification or not
isUnbluNotification(Intent) - Static method in class com.unblu.coresdk.UnbluNotificationApi
Checks if the intent with its data of a notification belongs to an unblu notification or not
IUnbluApiConversationExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur when there was an issue with a conversation interaction
IUnbluApiInitializeExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur while initializing the UnbluCoreApi
IUnbluApiNotInitializedExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur when the api is not initialized
IUnbluApiOpenConversationExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur when it failed to open a conversation
IUnbluApiOpenConversationOverviewExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur when it failed to open the conversation overview
IUnbluApiStartAudioCallExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur when starting an audio call failed
IUnbluApiStartVideoCallExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur when starting an video call failed
IUnbluApiStopMobileCoBrowsingExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur when trying to stop mobile co-browsing
IUnbluApiSuccessCallback<T> - Interface in com.unblu.coresdk
Callback which is triggered if an operation succeeded.
IUnbluApiSuccessfullyInitializedCallback - Interface in com.unblu.coresdk
Callback for successfully initializing the unblu api.
IUnbluApiSuccessVoidCallback - Interface in com.unblu.coresdk
Empty callback which signalizes a success when it is called
IUnbluCustomLoadingViewCreator - Interface in com.unblu.coresdk.ui
Defines a creator to create a custom loading UI when the unblu UI is displayed.
IUnbluDeinitializeExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur on deinitialization of the UnbluCoreApi
IUnbluEventApi - Interface in com.unblu.coresdk
Defines all events which are fired from unblu api by using broadcasts.
IUnbluEventApi.ApiIsInitialized - Class in com.unblu.coresdk
Fired when the unblu api is (de)initialized.
IUnbluEventApi.CallActiveChanged - Class in com.unblu.coresdk
Fired when there starts or stops a call.
IUnbluEventApi.Error - Class in com.unblu.coresdk
Fired when an internal error occurs.
IUnbluEventApi.MobileCoBrowsingChanged - Class in com.unblu.coresdk
Fired when mobile co-browsing switch from inactive to active or vice-versa.
This is only triggered when the used collaboration server is of version 5.x newer than 5.17 or newer than 6.3
IUnbluEventApi.Notification - Class in com.unblu.coresdk
Fired if any notification is send
IUnbluEventApi.PersonChanged - Class in com.unblu.coresdk
Fired when the current person changes.
This is only triggered when the used collaboration server is of version 5.x newer than 5.17 or newer than 6.3
IUnbluEventApi.UiPreloaded - Class in com.unblu.coresdk
Fired when the ui is preloaded
IUnbluEventApi.UiReady - Class in com.unblu.coresdk
Fired when the ui is completely finished and useable
IUnbluEventApi.UnreadMessagesCountChanged - Class in com.unblu.coresdk
Fired when the number of unread messages changes.
IUnbluEventApiVisitor - Interface in com.unblu.visitorsdk
Defines all events which are fired from unblu visitor api by using broadcasts.
IUnbluEventApiVisitor.AgentAvailable - Class in com.unblu.visitorsdk
Fired when the agent availability changes
IUnbluShowUiExceptionCallback - Interface in com.unblu.coresdk
Callback for exceptions which can occur when showing/hidding the unblu UI
IUnbluUiEventApi - Interface in com.unblu.coresdk.ui
Defines all ui events which are fired from the unblu ui api by using broadcasts.
IUnbluUiEventApi.CallUiOpenChanged - Class in com.unblu.coresdk.ui
Fired when the call ui is opened or closed.
IUnbluUiEventApi.IsVisible - Class in com.unblu.coresdk.ui
Fired when the UI is either changing to visible or invisible.
IUnbluUiEventApi.OpenConversationChanged - Class in com.unblu.coresdk.ui
Fired when open conversation changes
IUnbluUiEventApi.UiHideRequest - Class in com.unblu.coresdk.ui
Fired whenever the Unblu ui needs to be hidden.
IUnbluUiEventApi.UiVisibilityRequest - Class in com.unblu.coresdk.ui
Fired whenever the unblu ui needs to be displayed.
IUnbluUiEventApi.VisibilityTransition - Class in com.unblu.coresdk.ui
Fired when ever the visibility of the UI starts to change and when the transition of the change is finished.

J

joinConversation(String, IUnbluApiSuccessCallback<String>, IUnbluApiInitConversationExceptionCallback) - Method in class com.unblu.visitorsdk.UnbluVisitorApi
Joins an unblu co-browsing session that was started by an agent.

L

LogLevel - Enum in com.unblu.coresdk
Level of log messages

N

NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.ApiIsInitialized
NAME of the event
NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.CallActiveChanged
NAME of the event
NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.Error
NAME of the event
NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.MobileCoBrowsingChanged
NAME of the event
NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.Notification
NAME of the event
NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.PersonChanged
NAME of the event
NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.UiPreloaded
NAME of the event
NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.UiReady
NAME of the event
NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.UnreadMessagesCountChanged
NAME of the event
NAME - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.CallUiOpenChanged
NAME of the event.
NAME - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.IsVisible
NAME of the event.
NAME - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.OpenConversationChanged
NAME of the event.
NAME - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.UiHideRequest
NAME of the event.
NAME - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.UiVisibilityRequest
NAME of the event.
NAME - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.VisibilityTransition
NAME of the event.
NAME - Static variable in class com.unblu.visitorsdk.IUnbluEventApiVisitor.AgentAvailable
NAME of the event

O

onAgentAvailable(boolean) - Method in class com.unblu.visitorsdk.UnbluVisitorEventReceiver
onApiIsInitialized(boolean) - Method in class com.unblu.coresdk.UnbluEventReceiver
onCallActiveChanged(boolean) - Method in class com.unblu.coresdk.UnbluEventReceiver
onCallUiOpenChanged(boolean) - Method in class com.unblu.coresdk.ui.UnbluUiEventReceiver
onConfigurationChanged(Configuration) - Method in class com.unblu.coresdk.UnbluCoreApplication
 
onConfigurationChanged(Configuration) - Static method in class com.unblu.coresdk.UnbluCoreApplicationHelper
Needs to be called when Application.onConfigurationChanged(Configuration) is invoked
onConfigureNotCalled() - Method in interface com.unblu.coresdk.IUnbluApiInitializeExceptionCallback
Error when the UnbluCoreApi.configureApi(UnbluCoreApiConfiguration) function was not called
onCreate() - Method in class com.unblu.agentsdk.UnbluAgentApplication
 
onCreate(Application) - Static method in class com.unblu.agentsdk.UnbluAgentApplicationHelper
Needs to be called when Application.onCreate() is invoked
onCreate(Application, UnbluCoreApi) - Static method in class com.unblu.coresdk.UnbluCoreApplicationHelper
Needs to be called when Application.onCreate() is invoked
onCreate() - Method in class com.unblu.visitorsdk.UnbluVisitorApplication
 
onCreate(Application) - Static method in class com.unblu.visitorsdk.UnbluVisitorApplicationHelper
Needs to be called when Application.onCreate() is invoked
onDeinitFailed(String) - Method in interface com.unblu.coresdk.IUnbluDeinitializeExceptionCallback
General error which caused the api not to start.
onDownloadStart(String, String, String, String, long, String) - Method in interface com.unblu.coresdk.UnbluDownloadListener
Triggered whenever a download is started.
onError(UnbluApiErrorType, String) - Method in class com.unblu.coresdk.UnbluEventReceiver
onFailedToOpen(UnbluOpenConversationErrorType, String) - Method in interface com.unblu.coresdk.IUnbluApiOpenConversationExceptionCallback
Error while opening the conversation.
onFailedToOpenOverview(UnbluOpenConversationOverviewErrorType, String) - Method in interface com.unblu.coresdk.IUnbluApiOpenConversationOverviewExceptionCallback
Error while opening the conversation overview.
onFailedToStartAudioCall(UnbluStartAudioCallErrorType, String) - Method in interface com.unblu.coresdk.IUnbluApiStartAudioCallExceptionCallback
Error while starting an audio call.
onFailedToStartVideoCall(UnbluStartVideoCallErrorType, String) - Method in interface com.unblu.coresdk.IUnbluApiStartVideoCallExceptionCallback
Error while starting an video call.
onInErrorState() - Method in interface com.unblu.coresdk.IUnbluApiInitializeExceptionCallback
UnbluApi is in error state and should be deinitialized first, before initializing it
onInitFailed(UnbluApiErrorType, String) - Method in interface com.unblu.coresdk.IUnbluApiInitializeExceptionCallback
General error which caused the api not to start.
onMobileCoBrowsingChanged(boolean) - Method in class com.unblu.coresdk.UnbluEventReceiver
onNoActiveActivity() - Method in interface com.unblu.coresdk.IUnbluShowUiExceptionCallback
Triggered when trying to show the UI, but there is currently no activity active
onNotification(String, String, UnbluNotificationTag) - Method in class com.unblu.coresdk.UnbluEventReceiver
onNotInitialized() - Method in interface com.unblu.coresdk.IUnbluApiNotInitializedExceptionCallback
Api is not initialized.
onOpenConversationChanged(String) - Method in class com.unblu.coresdk.ui.UnbluUiEventReceiver
onPersonChanged(PersonInfo) - Method in class com.unblu.coresdk.UnbluEventReceiver
onPreloadSuccess() - Method in interface com.unblu.coresdk.IUnbluApiSuccessfullyInitializedCallback
If preloading chat ui was enabled, this is called after the preloading succeeded
onReceive(Context, Intent) - Method in class com.unblu.coresdk.ui.UnbluUiEventReceiver
 
onReceive(Context, Intent) - Method in class com.unblu.coresdk.UnbluEventReceiver
 
onReceive(Context, Intent) - Method in class com.unblu.visitorsdk.UnbluVisitorEventReceiver
 
onStopFailed(UnbluStopMobileCoBrowsingErrorType, String) - Method in interface com.unblu.coresdk.IUnbluApiStopMobileCoBrowsingExceptionCallback
Error while stopping mobile co-browsing.
onSuccess(T) - Method in interface com.unblu.coresdk.IUnbluApiSuccessCallback
Called after the called operation was successfully executed
onSuccess(Void) - Method in interface com.unblu.coresdk.IUnbluApiSuccessfullyInitializedCallback
Called after the unblu api finished initializing
onTerminate() - Method in class com.unblu.coresdk.UnbluCoreApplication
 
onTerminate() - Static method in class com.unblu.coresdk.UnbluCoreApplicationHelper
Needs to be called when Application.onTerminate() is invoked.
IMPORTANT: Needs to be called before the super call to Application.onTerminate()
onUiHideRequest(UnbluUiHideRequestReason, String) - Method in class com.unblu.coresdk.ui.UnbluUiEventReceiver
onUiIsVisible(boolean) - Method in class com.unblu.coresdk.ui.UnbluUiEventReceiver
onUiPreloaded() - Method in class com.unblu.coresdk.UnbluEventReceiver
onUIReady() - Method in class com.unblu.coresdk.UnbluEventReceiver
onUiVisibilityRequest(UnbluUiRequestReason, String) - Method in class com.unblu.coresdk.ui.UnbluUiEventReceiver
onUiVisibilityTransition(UnbluUiVisibilityTransition) - Method in class com.unblu.coresdk.ui.UnbluUiEventReceiver
onUiWasNeverShown() - Method in interface com.unblu.coresdk.IUnbluApiConversationExceptionCallback
The ui must be at least shown once after initialization, otherwise this error is thrown.
onUnknownEventReceive(Intent) - Method in class com.unblu.coresdk.ui.UnbluUiEventReceiver
Triggered if an unknown event is received.
onUnknownEventReceive(Intent) - Method in class com.unblu.coresdk.UnbluEventReceiver
Triggered if an unknown event is received.
onUnreadMessagesCountChanged(int) - Method in class com.unblu.coresdk.UnbluEventReceiver
onWebViewDestroy() - Method in interface com.unblu.coresdk.UnbluDownloadListener
Called whenever the webView is destroyed.
onWebViewInitialize() - Method in interface com.unblu.coresdk.UnbluDownloadListener
Called whenever the webView is initialized.
openConversation(String, IUnbluApiSuccessVoidCallback, IUnbluApiOpenConversationExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Opens the conversation for the given id.
The unblu UI must have been visible at least once.
openConversationOverview(IUnbluApiSuccessVoidCallback, IUnbluApiOpenConversationOverviewExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Opens the overview over all conversations.
The unblu UI must have been visible at least once.

P

PersonInfo - Class in com.unblu.coresdk.model
Information about a person
PersonInfo(String, String) - Constructor for class com.unblu.coresdk.model.PersonInfo
Constructs a new PersonInfo
preloadUi(IUnbluApiSuccessVoidCallback, IUnbluApiNotInitializedExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Starts pre loading the chat ui.
PrivateArea - Class in com.unblu.coresdk.model
Class used to update manual private areas for overlaying views while co-browsing
PrivateArea(int, int, int, int) - Constructor for class com.unblu.coresdk.model.PrivateArea
 
put(String, String) - Method in interface com.unblu.coresdk.UnbluPreferencesStorage
A preference should be stored in the storage

R

removePrivateArea(String) - Method in class com.unblu.coresdk.UnbluCoreApi
Removes the private area for the given id which was previously added via UnbluCoreApi.setPrivateArea(String, int, int, int, int).
removePrivateView(int) - Method in class com.unblu.coresdk.UnbluCoreApi
Removes the view with the given id from the set of private views.

S

setAddOverlayToParentView(boolean) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Enables/Disables if an overlay should be added to the parent view of the button, as soon as the UI opens.
setApiKey(String) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Changes the api key inside this configuration to the given value.
setAutoHideUiOnBack(boolean) - Method in class com.unblu.coresdk.UnbluCoreApi
If set to true, the unblu UI will hide automatically if the user presses the back button and there is no more navigation inside the unblu UI.
Also this option has no effect if there is a IBackButtonCallback configured which handles the back presses by itself.
setAutoMaximizeOnCallUiVisible(boolean) - Method in class com.unblu.coresdk.ui.UnbluUiButton
If true the UI is maximized when the call UI is shown.
setAutoUpdateUiBottomMargin(boolean) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Enables/Disables if the bottom margin of the UI from unblu should be updated according to the position of the UnbluUiButton and its top margin.
setBackButtonCallback(IBackButtonCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Defines the callback for back button presses while the Unblu UI is displayed.
If it is null, the SDK will handle all back button presses itself.
setButtonColor(int) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the color of the button
setButtonElevation(float) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the elevation of the button.
setCameraUploadsEnabled(boolean) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
If set to false, uploads directly via the camera app are disabled.
setCloseUiIconId(int) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the id of the icon which is displayed to close the UI
setCustomCookies(Map<String, String>) - Method in class com.unblu.coresdk.UnbluCoreApi
Sets the given cookies for the configured unblu base url.
setCustomCookies(Map<String, String>) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Configures a set of cookies which will be set on the configured base url.
setCustomLoadingViewCreator(IUnbluCustomLoadingViewCreator) - Method in class com.unblu.coresdk.UnbluCoreApi
Sets a custom loading view creator.
setDownloadListener(UnbluDownloadListener) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Defines the listener for downloads.
setEntryPath(String) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Sets the entry path inside self configuration to the given value.
setExternalLinkPatternWhitelist(List<Pattern>) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Sets the list of link patterns that may be opened in the system browser.
setHeight(int) - Method in class com.unblu.coresdk.model.PrivateArea
 
setIconColor(int) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the icon color which is on the button
setInternalUrlPatternWhitelist(List<Pattern>) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Sets the list of URL patterns that may be accessed by the WebView.
setLanguage(String) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Sets the language which will be send to the server to define the language used inside the UI.
setLoginInformation(String, String) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Deprecated.
This should no longer be used at all! If the person should be logged in, use UnbluCoreApiConfiguration.setCustomCookies(Map) with authentication cookies instead
setLoginInformation(String, String) - Method in class com.unblu.visitorsdk.UnbluVisitorApiConfiguration
IMPORTANT: this is currently only a unblu cloud feature!
Configures the api to use the following login credentials when starting the api.
setLogLevel(LogLevel) - Static method in class com.unblu.coresdk.UnbluCoreApi
Sets the log level of the Unblu SDK.
setNamedArea(String) - Method in class com.unblu.coresdk.UnbluCoreApi
Sets or updates the named area.
setNamedArea(String) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Sets the named area for which the configuration is loaded as soon as the api is initializing.
setNotificationsBadgeColor(int) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the color of the notification badge
setNotificationsBadgeElevation(float) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the elevation of the notification badge.
setNotificationsBadgeTextColor(int) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the color of the text of the notification badge
setNotificationsEnabled(boolean) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Configures if notifications via unblu are enabled or not
setOnClickListener(View.OnClickListener) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets a click listener to button
setOpenUiIconId(int) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the id of the icon which is displayed to open the UI
setOverlayColor(int) - Method in class com.unblu.coresdk.ui.UnbluUiButton
Sets the color of the overlay.
setPreferencesStorage(UnbluPreferencesStorage) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
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.
setPreloadUiAfterApiInitEnabled(boolean) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Enables/disables if the UI should be preloaded, after the unblu api was initialized once.
setPrivateArea(String, int, int, int, int) - Method in class com.unblu.coresdk.UnbluCoreApi
Adds or updates a private area with the given size and position.
setScreenCapturer(IScreenCapturer) - Method in class com.unblu.coresdk.UnbluCoreApi
Set the screenCapturer to be used
setUiMargins(int, int) - Method in class com.unblu.coresdk.UnbluCoreApi
Sets a margins of the UI.
This can be used, if there should be a an open/close fab button or some menu at the top.
The top margin starts bellow the status bar.
The bottom margin starts above the navigation bar, if navigation bar is visible.
setUnbluBaseUrl(String) - Method in class com.unblu.coresdk.UnbluCoreApiConfiguration
Changes the base url inside this configuration to the given value
setWidth(int) - Method in class com.unblu.coresdk.model.PrivateArea
 
setX(int) - Method in class com.unblu.coresdk.model.PrivateArea
 
setY(int) - Method in class com.unblu.coresdk.model.PrivateArea
 
showUi(boolean, IUnbluApiSuccessVoidCallback, IUnbluShowUiExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
This will show/hide the UI.
This will animate the show/hide of the UI.
showUi(boolean, boolean, IUnbluApiSuccessVoidCallback, IUnbluShowUiExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
This will show/hide the UI.
startAudioCall(String, IUnbluApiSuccessVoidCallback, IUnbluApiStartAudioCallExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Opens a conversation for the given conversation id and starts an audio call.
The unblu UI must have been visible at least once.
startConversation(ConversationType, IUnbluApiSuccessCallback<String>, IUnbluApiInitConversationExceptionCallback) - Method in class com.unblu.visitorsdk.UnbluVisitorApi
Starts a new conversation with the given conversation type.
startVideoCall(String, IUnbluApiSuccessVoidCallback, IUnbluApiStartVideoCallExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Opens a conversation for the given conversation id and starts a video call.
The unblu UI must have been visible at least once.
stopMobileCoBrowsing(IUnbluApiSuccessVoidCallback, IUnbluApiStopMobileCoBrowsingExceptionCallback) - Method in class com.unblu.coresdk.UnbluCoreApi
Stops mobile co-browsing

T

toString() - Method in class com.unblu.coresdk.model.PersonInfo
 
toString() - Method in class com.unblu.coresdk.model.PrivateArea
 

U

UNBLU_ACTION_PREFIX - Static variable in interface com.unblu.coresdk.IUnbluEventApi
Prefix of all Unblu events
UNBLU_UI_ACTION_PREFIX - Static variable in interface com.unblu.coresdk.ui.IUnbluUiEventApi
Prefix of all unblu events
UnbluAgentApi - Class in com.unblu.agentsdk
The API to use to access unblu suite functionality like chat, co-browsing etc.
UnbluAgentApiConfiguration - Class in com.unblu.agentsdk
Configuration for the UnbluAgentApi.
UnbluAgentApiConfiguration(String, String) - Constructor for class com.unblu.agentsdk.UnbluAgentApiConfiguration
Constructs an api configuration.
UnbluAgentApplication - Class in com.unblu.agentsdk
Please ensure, that your application uses the UnbluAgentApplication or a subclass of it in the manifest.
UnbluAgentApplication() - Constructor for class com.unblu.agentsdk.UnbluAgentApplication
 
UnbluAgentApplicationHelper - Class in com.unblu.agentsdk
Helper which can be used instead of inherit from UnbluAgentApplication.
All functions of this helper need to be called in your Application implementation.
UnbluAgentApplicationHelper() - Constructor for class com.unblu.agentsdk.UnbluAgentApplicationHelper
 
UnbluApiErrorType - Enum in com.unblu.coresdk
Errors which can occur during interaction with the unblu api Created by Denis on 03.06.2017.
UnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate> - Class in com.unblu.coresdk
The base Api of UnbluVisitorApi and UnbluAgentApi.
UnbluCoreApi(T) - Constructor for class com.unblu.coresdk.UnbluCoreApi
 
UnbluCoreApiConfiguration<C extends UnbluCoreApiConfiguration> - Class in com.unblu.coresdk
Configuration for the unblu api.
UnbluCoreApiConfiguration(String, String) - Constructor for class com.unblu.coresdk.UnbluCoreApiConfiguration
Constructs an api configuration.
UnbluCoreApplication - Class in com.unblu.coresdk
Base class of UnbluVisitorApplication and UnbluAgentApplication.
UnbluCoreApplication() - Constructor for class com.unblu.coresdk.UnbluCoreApplication
 
UnbluCoreApplicationHelper - Class in com.unblu.coresdk
Helper which can be used instead of inherit from UnbluCoreApplication (and its visitor/agent implementation).
All functions of this helper need to be called in your Application implementation.
UnbluCoreApplicationHelper() - Constructor for class com.unblu.coresdk.UnbluCoreApplicationHelper
 
UnbluDownloadListener - Interface in com.unblu.coresdk
Listener for downloads.
UnbluEventReceiver - Class in com.unblu.coresdk
This unblu event receiver can be used to listen to unblu API events.
UnbluEventReceiver(Context) - Constructor for class com.unblu.coresdk.UnbluEventReceiver
 
UnbluEventReceiver(Context, IntentFilter) - Constructor for class com.unblu.coresdk.UnbluEventReceiver
 
UnbluInitConversationErrorType - Enum in com.unblu.coresdk
Error type thrown when initializing (starting, joining) a conversation fails
UnbluNotificationApi - Class in com.unblu.coresdk
Api helper to check mainly if notifications are from unblu or not

Unblu will display/handle notifications as shown in the following table.
UnbluNotificationTag - Enum in com.unblu.coresdk
Possible values of the notification event tag.
UnbluOpenConversationErrorType - Enum in com.unblu.coresdk
Error type thrown when opening a conversation fails
UnbluOpenConversationOverviewErrorType - Enum in com.unblu.coresdk
Error type thrown when opening the conversation overview fails
UnbluPreferencesStorage - Interface in com.unblu.coresdk
Interface which can be implemented to store the preferences of Unblu at a custom location.
This is useful if encryption should used.
UnbluStartAudioCallErrorType - Enum in com.unblu.coresdk
Error type thrown when starting an audio call fails
UnbluStartVideoCallErrorType - Enum in com.unblu.coresdk
Error type thrown when starting a video call fails
UnbluStopLayerErrorType - Enum in com.unblu.coresdk
Error type thrown when stopping a layer
UnbluStopMobileCoBrowsingErrorType - Enum in com.unblu.coresdk
Error type thrown when stopping mobile co-browsing
UnbluSwitchLayerErrorType - Enum in com.unblu.coresdk
Error type thrown when switching a layer
UnbluUiButton - Class in com.unblu.coresdk.ui
Button to control the visibility of the default unblu UI generated by unblu.
UnbluUiButton(Context) - Constructor for class com.unblu.coresdk.ui.UnbluUiButton
Creates a new UnbluUiButton with the given context.
UnbluUiButton(Context, AttributeSet) - Constructor for class com.unblu.coresdk.ui.UnbluUiButton
Creates a new UnbluUiButton with the given context and the given attribute set.
UnbluUiButton(Context, AttributeSet, int) - Constructor for class com.unblu.coresdk.ui.UnbluUiButton
Creates a new UnbluUiButton with the given context and the given attribute set.
UnbluUiButton(Context, AttributeSet, int, int) - Constructor for class com.unblu.coresdk.ui.UnbluUiButton
Creates a new UnbluUiButton with the given context, the given attribute set and default style attributes.
UnbluUiEventReceiver - Class in com.unblu.coresdk.ui
This unblu ui event receiver can be used to listen to unblu ui API events.
UnbluUiEventReceiver(Context) - Constructor for class com.unblu.coresdk.ui.UnbluUiEventReceiver
 
UnbluUiEventReceiver(Context, IntentFilter) - Constructor for class com.unblu.coresdk.ui.UnbluUiEventReceiver
 
UnbluUiHideRequestReason - Enum in com.unblu.coresdk.ui
UnbluUiRequestReason - Enum in com.unblu.coresdk.ui
UnbluUiVisibilityTransition - Enum in com.unblu.coresdk.ui
The different states when showing hiding the UI.
UnbluVisitorApi - Class in com.unblu.visitorsdk
The API to use to access unblu suite functionality like chat, co-browsing etc.
UnbluVisitorApiConfiguration - Class in com.unblu.visitorsdk
Configuration for the UnbluVisitorApi.
UnbluVisitorApiConfiguration(String, String) - Constructor for class com.unblu.visitorsdk.UnbluVisitorApiConfiguration
Constructs an api configuration.
UnbluVisitorApplication - Class in com.unblu.visitorsdk
Please ensure, that your application uses the UnbluVisitorApplication or a subclass of it in the manifest.
UnbluVisitorApplication() - Constructor for class com.unblu.visitorsdk.UnbluVisitorApplication
 
UnbluVisitorApplicationHelper - Class in com.unblu.visitorsdk
Helper which can be used instead of inherit from UnbluVisitorApplication.
All functions of this helper need to be called in your Application implementation.
UnbluVisitorApplicationHelper() - Constructor for class com.unblu.visitorsdk.UnbluVisitorApplicationHelper
 
UnbluVisitorEventReceiver - Class in com.unblu.visitorsdk
This unblu event receiver can be used to listen to unblu visitor API events.
UnbluVisitorEventReceiver(Context) - Constructor for class com.unblu.visitorsdk.UnbluVisitorEventReceiver
 
UnbluVisitorEventReceiver(Context, IntentFilter) - Constructor for class com.unblu.visitorsdk.UnbluVisitorEventReceiver
 
UnsupportedCollaborationServerVersionException - Exception in com.unblu.coresdk
Exception thrown if an api is not supported because of the collaboration server
UnsupportedCollaborationServerVersionException() - Constructor for exception com.unblu.coresdk.UnsupportedCollaborationServerVersionException
Constructs a new exception without any additional information
UnsupportedCollaborationServerVersionException(String) - Constructor for exception com.unblu.coresdk.UnsupportedCollaborationServerVersionException
Constructs a new exception with a detailed message
UnsupportedCollaborationServerVersionException(String, Throwable) - Constructor for exception com.unblu.coresdk.UnsupportedCollaborationServerVersionException
Constructs a new exception with a detailed message and a cause
UnsupportedCollaborationServerVersionException(Throwable) - Constructor for exception com.unblu.coresdk.UnsupportedCollaborationServerVersionException
Constructs a new exception with a cause

V

VALUE_ACCOUNT_ID - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.UiVisibilityRequest
The id of the account for which the UI should be displayed
VALUE_ACTIVE - Static variable in class com.unblu.coresdk.IUnbluEventApi.CallActiveChanged
True if a call is active, false otherwise
VALUE_ACTIVE - Static variable in class com.unblu.coresdk.IUnbluEventApi.MobileCoBrowsingChanged
True of mobile co-browsing is active; False otherwise
VALUE_BODY - Static variable in class com.unblu.coresdk.IUnbluEventApi.Notification
Content of the notification
VALUE_CONVERSATION_ID - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.OpenConversationChanged
Id of the current open conversation.
VALUE_CONVERSATION_ID - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.UiHideRequest
The id of the conversation from which this request was done if there is a corresponding conversation
VALUE_COUNT - Static variable in class com.unblu.coresdk.IUnbluEventApi.UnreadMessagesCountChanged
Number of unread messages
VALUE_DISPLAY_NAME - Static variable in class com.unblu.coresdk.IUnbluEventApi.PersonChanged
Display name of the current person
VALUE_ID - Static variable in class com.unblu.coresdk.IUnbluEventApi.PersonChanged
Id of the current person
VALUE_IS_AVAILABLE - Static variable in class com.unblu.visitorsdk.IUnbluEventApiVisitor.AgentAvailable
type: Boolean
VALUE_IS_INITIALIZED - Static variable in class com.unblu.coresdk.IUnbluEventApi.ApiIsInitialized
type: Boolean
VALUE_IS_VISIBLE - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.IsVisible
type: Boolean
VALUE_MESSAGE - Static variable in class com.unblu.coresdk.IUnbluEventApi.Error
May not localized message for the error
VALUE_OPEN - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.CallUiOpenChanged
Id of the current open conversation.
VALUE_REASON - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.UiHideRequest
Reason for the UI hide request.
VALUE_REASON - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.UiVisibilityRequest
Reason for the UI request.
VALUE_TAG - Static variable in class com.unblu.coresdk.IUnbluEventApi.Notification
Tag is one of UnbluNotificationTag values.
VALUE_TITLE - Static variable in class com.unblu.coresdk.IUnbluEventApi.Notification
Title of the notification
VALUE_TRANSITION - Static variable in class com.unblu.coresdk.ui.IUnbluUiEventApi.VisibilityTransition
VALUE_TYPE - Static variable in class com.unblu.coresdk.IUnbluEventApi.Error
Type of the error.
valueOf(String) - Static method in enum com.unblu.coresdk.LogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.ui.UnbluUiHideRequestReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.ui.UnbluUiRequestReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.ui.UnbluUiVisibilityTransition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluApiErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluInitConversationErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluNotificationTag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluOpenConversationErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluOpenConversationOverviewErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluStartAudioCallErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluStartVideoCallErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluStopLayerErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluStopMobileCoBrowsingErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.coresdk.UnbluSwitchLayerErrorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.unblu.visitorsdk.ConversationType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.unblu.coresdk.LogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.ui.UnbluUiHideRequestReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.ui.UnbluUiRequestReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.ui.UnbluUiVisibilityTransition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluApiErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluInitConversationErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluNotificationTag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluOpenConversationErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluOpenConversationOverviewErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluStartAudioCallErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluStartVideoCallErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluStopLayerErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluStopMobileCoBrowsingErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.coresdk.UnbluSwitchLayerErrorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.unblu.visitorsdk.ConversationType
Returns an array containing the constants of this enum type, in the order they are declared.
A C D E G H I J L N O P R S T U V 
Skip navigation links