com.unblu.coresdk

Class UnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

java.lang.Object

com.unblu.coresdk.internal.InternalUnbluCoreApi<T>

com.unblu.coresdk.UnbluCoreApi<T>

Direct Known Subclasses:

com.unblu.agentsdk.internal.InternalUnbluAgentApi, com.unblu.visitorsdk.internal.InternalUnbluVisitorApi

public abstract class UnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>
extends com.unblu.coresdk.internal.InternalUnbluCoreApi<T>

The base Api of UnbluVisitorApi and UnbluAgentApi. Use one of those always and not this class directly.

Field Summary

Fields

Modifier and Type	Field and Description
static long	ANIMATION_TIME The time used for the fade in and fade out animation when showing/hiding the UI
static boolean	enableCapturingPerformanceLogging Enables logging of capturing performance (e.g.
static boolean	enableDebugOutput Enables the debug output of the Unblu SDK.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnbluCoreApi(T apiDelegate)

Method Summary

Modifier and Type	Method and Description
void	addPrivateView(int id) Adds the view with the given id to the set of private views.
void	configureApi(UnbluCoreApiConfiguration configuration) Configures the unblu api.
void	deinitApi(IUnbluApiSuccessVoidCallback success, IUnbluDeinitializeExceptionCallback failure) Deinitializes the unblu API.
android.app.Application	getApplication() Returns the application context object
IUnbluCustomLoadingViewCreator	getCustomLoadingViewCreator() Returns the currently configured loading view creator
static LogLevel	getLogLevel() Returns the log level of the Unblu SDK.
java.lang.String	getOpenConversationId() Returns the id of the currently opened conversation inside the UI. Null if no conversation is open
PersonInfo	getPersonInfo() Returns the info of the current person
int	getUiBottomMargin() Returns the current bottom margin of the unblu Ui
int	getUiTopMargin() Returns the current top margin of the unblu Ui
int	getUnreadMessagesCount() Returns the number of unread messages
void	initApi(IUnbluApiSuccessfullyInitializedCallback success, IUnbluApiInitializeExceptionCallback failure) Inits the unblu API.
static <D extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate> UnbluCoreApi<D>	internalGetCoreInstance()
void	isCallActive(IUnbluApiSuccessCallback<java.lang.Boolean> success, IUnbluApiNotInitializedExceptionCallback failure) Returns if there is currently a call or not.
void	isCallUiOpen(IUnbluApiSuccessCallback<java.lang.Boolean> success, IUnbluApiNotInitializedExceptionCallback failure) Checks if the call UI for an audio/video call is open or not.
boolean	isInErrorState()
boolean	isInitialized()
boolean	isMobileCoBrowsingActive() Checks if mobile co-browsing is active
boolean	isNotificationsEnabled()
boolean	isUiVisible() Checks if the UI is visible or not
void	openConversation(java.lang.String conversationId, IUnbluApiSuccessVoidCallback success, IUnbluApiOpenConversationExceptionCallback failure) Opens the conversation for the given id. The unblu UI must have been visible at least once.
void	openConversationOverview(IUnbluApiSuccessVoidCallback success, IUnbluApiOpenConversationOverviewExceptionCallback failure) Opens the overview over all conversations. The unblu UI must have been visible at least once.
void	preloadUi(IUnbluApiSuccessVoidCallback success, IUnbluApiNotInitializedExceptionCallback failure) Starts pre loading the chat ui.
void	removePrivateArea(java.lang.String id) Removes the private area for the given id which was previously added via setPrivateArea(String, int, int, int, int).
void	removePrivateView(int id) Removes the view with the given id from the set of private views.
void	setAutoHideUiOnBack(boolean autoHideUiOnBack) 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.
void	setBackButtonCallback(IBackButtonCallback backButtonCallback) 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.
void	setCustomCookies(java.util.Map<java.lang.String,java.lang.String> customCookies) Sets the given cookies for the configured unblu base url.
void	setCustomLoadingViewCreator(IUnbluCustomLoadingViewCreator customLoadingViewCreator) Sets a custom loading view creator.
static void	setLogLevel(LogLevel logLevel) Sets the log level of the Unblu SDK.
void	setNamedArea(java.lang.String namedArea) Sets or updates the named area.
PrivateArea	setPrivateArea(java.lang.String id, int x, int y, int width, int height) Adds or updates a private area with the given size and position.
void	setScreenCapturer(com.unblu.coresdk.internal.module.capturing.IScreenCapturer screenCapturer) Set the screenCapturer to be used
void	setUiMargins(int top, int bottom) 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.
void	showUi(boolean show, boolean animate, IUnbluApiSuccessVoidCallback success, IUnbluShowUiExceptionCallback failure) This will show/hide the UI.
void	showUi(boolean show, IUnbluApiSuccessVoidCallback success, IUnbluShowUiExceptionCallback failure) This will show/hide the UI. This will animate the show/hide of the UI.
void	startAudioCall(java.lang.String conversationId, IUnbluApiSuccessVoidCallback success, IUnbluApiStartAudioCallExceptionCallback failure) Opens a conversation for the given conversation id and starts an audio call. The unblu UI must have been visible at least once.
void	startVideoCall(java.lang.String conversationId, IUnbluApiSuccessVoidCallback success, IUnbluApiStartVideoCallExceptionCallback failure) Opens a conversation for the given conversation id and starts a video call. The unblu UI must have been visible at least once.
void	stopMobileCoBrowsing(IUnbluApiSuccessVoidCallback success, IUnbluApiStopMobileCoBrowsingExceptionCallback failure) Stops mobile co-browsing

Methods inherited from class com.unblu.coresdk.internal.InternalUnbluCoreApi

destroy, getApiDelegate, requestUiVisibilityIfNotOpen, setApplication

Methods inherited from class java.lang.Object

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

Field Detail

enableDebugOutput

public static boolean enableDebugOutput

Enables the debug output of the Unblu SDK. This contains additional information on log messages and is independent of the log level defined with setLogLevel(LogLevel).

enableCapturingPerformanceLogging

public static boolean enableCapturingPerformanceLogging

Enables logging of capturing performance (e.g. FPS)

IMPORTANT: This only has effect, if enableDebugOutput is set to true and the log level is set to LogLevel.DEBUG via setLogLevel(LogLevel)!

ANIMATION_TIME

public static final long ANIMATION_TIME

The time used for the fade in and fade out animation when showing/hiding the UI

See Also:

Constant Field Values

Constructor Detail

UnbluCoreApi

protected UnbluCoreApi(T apiDelegate)

Method Detail

internalGetCoreInstance

public static <D extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate> UnbluCoreApi<D> internalGetCoreInstance()

Returns:

The instance of the UnbluCoreApi. Only for internal use!

Throws:

java.lang.IllegalStateException - If the core api was not initialized by either using UnbluVisitorApi or UnbluAgentApi

setLogLevel

public static void setLogLevel(LogLevel logLevel)

Sets the log level of the Unblu SDK. All messages with a lower level will not be logged.
Default is LogLevel.VERBOSE as in release builds the verbose and debug logs are stripped out via proguard.

Parameters:

logLevel - Level which should be set

See Also:

getLogLevel()

getLogLevel

public static LogLevel getLogLevel()

Returns the log level of the Unblu SDK. All messages with a lower level will not be logged

Returns:

the log level of the Unblu SDK. All messages with a lower level will not be logged

See Also:

setLogLevel(LogLevel)

getApplication

public android.app.Application getApplication()

Returns the application context object

Overrides:

getApplication in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

The application context object

configureApi

public void configureApi(UnbluCoreApiConfiguration configuration)

Configures the unblu api. Use initApi(IUnbluApiSuccessfullyInitializedCallback, IUnbluApiInitializeExceptionCallback) to be able start new conversation and use other API features.

Note:

• This should only be called once with the correct configuration.
• This method should be called from the application function of the AppDelegate class.

Overrides:

configureApi in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

configuration - The configuration for the unblu api

Throws:

java.lang.IllegalStateException - Thrown if the api was already initialized. The api needs to be deinitialized to configure it.

initApi

public void initApi(@Nullable
                    IUnbluApiSuccessfullyInitializedCallback success,
                    @Nullable
                    IUnbluApiInitializeExceptionCallback failure)

Inits the unblu API.

This is an asynchronous call. Any further calls can be done inside the success callback or after the IUnbluEventApi.ApiIsInitialized event.

Connects to the unblu server and makes the API ready for further calls.

Consecutive calls (without deinitializing in between) will be ignored, but the callbacks will also be triggered, as soon as there is a result.

Overrides:

initApi in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

success - Optional callback that will be called once the API has been successfully initialized and also provides a callback if the pre loading chat ui was loaded (if preloading was enabled)

failure - Optional callback that will be called if the initialization of the API fails.

deinitApi

public void deinitApi(@Nullable
                      IUnbluApiSuccessVoidCallback success,
                      @Nullable
                      IUnbluDeinitializeExceptionCallback failure)

Deinitializes the unblu API.

This is an asynchronous call. Use the callbacks to check for success / failure.

Calling this method will free all resources allocated by the unblu API.

Consecutive calls (without initializing in between) will be ignored, but the callbacks will also be triggered, as soon as there is a result.

Overrides:

deinitApi in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

success - Optional callback that will be called once the API has been successfully deinitialized.

failure - Optional callback that will be called if the deinitialization of the API fails.

isInitialized

public boolean isInitialized()

Overrides:

isInitialized in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

true if the API was initialized and the initialization of the API was successful. false if api is not initialized or in error state.

isNotificationsEnabled

public boolean isNotificationsEnabled()

Overrides:

isNotificationsEnabled in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

true if push notifications are configured to be enabled. false if push notifications are disabled.

isInErrorState

public boolean isInErrorState()

Overrides:

isInErrorState in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

true if the API is in error state. false otherwise.

preloadUi

public void preloadUi(@Nullable
                      IUnbluApiSuccessVoidCallback success,
                      @Nullable
                      IUnbluApiNotInitializedExceptionCallback failure)

Starts pre loading the chat ui. Can be called as soon as the api is initialized. It will load the page, which is needed later for chat.
If preloadChatUiAfterApiInitEnabled of configureApi(UnbluCoreApiConfiguration) is set to true, this call is not needed

This is an asynchronous call. Use the callbacks to check for success / failure.

Overrides:

preloadUi in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

success - Optional callback that will be called once the preloading is finished.

failure - Optional callback that will be called if the api was not initialized.

addPrivateView

public void addPrivateView(int id)

Adds the view with the given id to the set of private views.

Private views are only visible on the mobile device and won't be transmitted when co-browsing. The views will be covered before they are transmitted and therefore won't be visible on the agent side.

Note:

Do not add to many ids simultaneously, because each private view will need extra performance while capturing the UI. The best practice is to dynamically make views private, when they are displayed in the app UI and remove them from the private view list when they are not visible anymore.

Multiple calls with the same id do not have any effect.

Overrides:

addPrivateView in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

id - Id of the view that should be made private.

removePrivateView

public void removePrivateView(int id)

Removes the view with the given id from the set of private views.

Multiple calls with the same id do not have any effect.

Overrides:

removePrivateView in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

id - Id of the view that should removed from the private views.

See Also:

addPrivateView(int)

setPrivateArea

public PrivateArea setPrivateArea(java.lang.String id,
                                  int x,
                                  int y,
                                  int width,
                                  int height)

Adds or updates a private area with the given size and position.

Private areas are only visible on the mobile device and won't be transmitted when co-browsing. The area will be covered before the captured screen is transmitted and therefore won't be visible on the agent side.

To update a private area either call this function with the same id again, or modify the returned PrivateArea.
Changes to the returned private area or using this function will directly be applied, even if co-browsing is already active.

Note:

Try to reduce the number of private areas to a minimum as this will impact performance during co-browsing.

Overrides:

setPrivateArea in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

id - The unique id of the private area which can be used to update the values or to remove the private area again

x - The x position on the screen for the private area

y - The y position on the screen for the private area

width - The width of the private area

height - The height of the private area

Returns:

a PrivateArea which can be updated instead of using this API function

See Also:

removePrivateArea(String)

removePrivateArea

public void removePrivateArea(java.lang.String id)

Removes the private area for the given id which was previously added via setPrivateArea(String, int, int, int, int).

Multiple calls with the id do not have any effect.

Overrides:

removePrivateArea in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

id - of the area that should removed from the private areas.

See Also:

setPrivateArea(String, int, int, int, int)

setCustomCookies

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

Sets the given cookies for the configured unblu base url. This can be called independent of the state of the api. If the api was already initialized and cookies were already placed, it will overwrite cookies with the same key. Others will not be touched. All cookies will be removed when deinitApi(IUnbluApiSuccessVoidCallback, IUnbluDeinitializeExceptionCallback) was called. When initApi(IUnbluApiSuccessfullyInitializedCallback, IUnbluApiInitializeExceptionCallback) is called again the last cookies set will be used again.

Overrides:

setCustomCookies in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

customCookies - The cookies which will be send with request to the configured base url

setAutoHideUiOnBack

public void setAutoHideUiOnBack(boolean autoHideUiOnBack)

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.

Overrides:

setAutoHideUiOnBack in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

autoHideUiOnBack - True to enabled hiding the UI when back button is pressed, false to disable it

setNamedArea

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

Sets or updates the named area. This can be called independent of the state of the api, but has different effects depending on the current state. If the api is not initialized when calling this function, the configuration of the named area is loaded as soon as the api gets initialized. If this function is called and the api is already initialized, it can only be used on the agent desk to filter incoming requests in the queue. No specific configuration is loaded for it. If a conversation is already active, this function has no effect until the api is either initialized again (what would load the configuration of the named area) or a new conversation is started (filtering named area in the queue).

Overrides:

setNamedArea in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

namedArea - The named area meta tag id which is configured on the agent desk.

setBackButtonCallback

public void setBackButtonCallback(@Nullable
                                  IBackButtonCallback backButtonCallback)

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. In this case it will navigate up inside the webView or, if setAutoHideUiOnBack(boolean) is true, it will hide the UI when the top level of the UI is reached.

Overrides:

setBackButtonCallback in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

backButtonCallback - The listener which handles the back button press

isCallUiOpen

public void isCallUiOpen(@NonNull
                         IUnbluApiSuccessCallback<java.lang.Boolean> success,
                         @Nullable
                         IUnbluApiNotInitializedExceptionCallback failure)

Checks if the call UI for an audio/video call is open or not. If the call UI is minized, the result is also false.
If you need to check if a call is active or not. Use the isCallActive(IUnbluApiSuccessCallback, IUnbluApiNotInitializedExceptionCallback) function.

This is an asynchronous call. Use the callbacks to check for success / failure.

Overrides:

isCallUiOpen in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

success - Optional callback that will be called with the result if the UI is open or not

failure - Optional callback that will be called if the api was not initialized

showUi

public void showUi(boolean show,
                   @Nullable
                   IUnbluApiSuccessVoidCallback success,
                   @Nullable
                   IUnbluShowUiExceptionCallback failure)

This will show/hide the UI.
This will animate the show/hide of the UI.

Parameters:

show - True to show the UI. False to hide it.

success - Called after the UI is shown/hidden. Triggered after the animation.

failure - Called if there is an issue showing the UI

showUi

public void showUi(boolean show,
                   boolean animate,
                   @Nullable
                   IUnbluApiSuccessVoidCallback success,
                   @Nullable
                   IUnbluShowUiExceptionCallback failure)

This will show/hide the UI.

Overrides:

showUi in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

show - True to show the UI. False to hide it.

animate - True to animation the show/hide of the UI.

success - Called after the UI is shown/hidden. Triggered after the animation.

failure - Called if there is an issue showing the UI

isUiVisible

public boolean isUiVisible()

Checks if the UI is visible or not

Overrides:

isUiVisible in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

True if the UI is visible. False otherwise

setUiMargins

public void setUiMargins(int top,
                         int bottom)

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. Otherwise it is from the bottom of the screen (navigation bar is transparent above the content or gesture navigation is used.

Overrides:

setUiMargins in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

top - The amount of margin in pixel at the top

bottom - The amount of margin in pixel at the bottom

getUiTopMargin

public int getUiTopMargin()

Returns the current top margin of the unblu Ui

Overrides:

getUiTopMargin in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

The current top margin of the unblu Ui

getUiBottomMargin

public int getUiBottomMargin()

Returns the current bottom margin of the unblu Ui

Overrides:

getUiBottomMargin in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

The current bottom margin of the unblu Ui

openConversation

public void openConversation(@NonNull
                             java.lang.String conversationId,
                             @Nullable
                             IUnbluApiSuccessVoidCallback success,
                             @Nullable
                             IUnbluApiOpenConversationExceptionCallback failure)

Opens the conversation for the given id.
The unblu UI must have been visible at least once. You can call this after a call to showUi(boolean, IUnbluApiSuccessVoidCallback, IUnbluShowUiExceptionCallback) (wait for the success callback).

Overrides:

openConversation in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

conversationId - The id of the conversation which should be opened.

success - Called after the conversation was opened

failure - Called if there was an error opening the conversation

startAudioCall

public void startAudioCall(@NonNull
                           java.lang.String conversationId,
                           @Nullable
                           IUnbluApiSuccessVoidCallback success,
                           @Nullable
                           IUnbluApiStartAudioCallExceptionCallback failure)

Opens a conversation for the given conversation id and starts an audio call.
The unblu UI must have been visible at least once. You can call this after a call to showUi(boolean, IUnbluApiSuccessVoidCallback, IUnbluShowUiExceptionCallback) (wait for the success callback).

Overrides:

startAudioCall in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

conversationId - The id of the conversation in which the audio call should be started

success - Called after the conversation was opened and the call has been started

failure - Called if there was an error opening the conversation and starting the call

startVideoCall

public void startVideoCall(@NonNull
                           java.lang.String conversationId,
                           @Nullable
                           IUnbluApiSuccessVoidCallback success,
                           @Nullable
                           IUnbluApiStartVideoCallExceptionCallback failure)

Opens a conversation for the given conversation id and starts a video call.
The unblu UI must have been visible at least once. You can call this after a call to showUi(boolean, IUnbluApiSuccessVoidCallback, IUnbluShowUiExceptionCallback) (wait for the success callback).

Overrides:

startVideoCall in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

conversationId - The id of the conversation in which the video call should be started.

success - Called after the conversation was opened and the call has been started

failure - Called if there was an error opening the conversation and starting the call

openConversationOverview

public void openConversationOverview(@Nullable
                                     IUnbluApiSuccessVoidCallback success,
                                     @Nullable
                                     IUnbluApiOpenConversationOverviewExceptionCallback failure)

Opens the overview over all conversations.
The unblu UI must have been visible at least once. You can call this after a call to showUi(boolean, IUnbluApiSuccessVoidCallback, IUnbluShowUiExceptionCallback) (wait for the success callback).

Overrides:

openConversationOverview in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

success - Called when the overview was opened

failure - Called if there was an error opening the overview

getOpenConversationId

public java.lang.String getOpenConversationId()

Returns the id of the currently opened conversation inside the UI.
Null if no conversation is open

Overrides:

getOpenConversationId in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

The id of the currently opened conversation or null

Throws:

java.lang.IllegalStateException - if the API is not initialized or if the UI was never shown.

isCallActive

public void isCallActive(@Nullable
                         IUnbluApiSuccessCallback<java.lang.Boolean> success,
                         @Nullable
                         IUnbluApiNotInitializedExceptionCallback failure)

Returns if there is currently a call or not.

Overrides:

isCallActive in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

success - Called with the state of a call

failure - Called if the api was not initialized first

getUnreadMessagesCount

public int getUnreadMessagesCount()

Returns the number of unread messages

Overrides:

getUnreadMessagesCount in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

the number of unread messages

getPersonInfo

public PersonInfo getPersonInfo()

Returns the info of the current person

Overrides:

getPersonInfo in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

the info of the current person

Throws:

java.lang.IllegalStateException - if the API is not initialized

UnsupportedCollaborationServerVersionException - if the used collaboration server is not of version 5.x newer than 5.17 or newer than 6.3

isMobileCoBrowsingActive

public boolean isMobileCoBrowsingActive()

Checks if mobile co-browsing is active

Overrides:

isMobileCoBrowsingActive in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

true if mobile co-browsing is active

Throws:

UnsupportedCollaborationServerVersionException - if the used collaboration server is not of version 5.x newer than 5.17 or newer than 6.3

stopMobileCoBrowsing

public void stopMobileCoBrowsing(@Nullable
                                 IUnbluApiSuccessVoidCallback success,
                                 @Nullable
                                 IUnbluApiStopMobileCoBrowsingExceptionCallback failure)

Stops mobile co-browsing

Overrides:

stopMobileCoBrowsing in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

success - if mobile co-browsing was successfully stopped or if it was not active

failure - if stopping mobile co-browsing failed

Throws:

UnsupportedCollaborationServerVersionException - if the used collaboration server is not of version 5.x newer than 5.17 or newer than 6.3

setScreenCapturer

public void setScreenCapturer(@NonNull
                              com.unblu.coresdk.internal.module.capturing.IScreenCapturer screenCapturer)

Set the screenCapturer to be used

Overrides:

setScreenCapturer in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

screenCapturer - The IScreenCapturer class which must implement it.

setCustomLoadingViewCreator

public void setCustomLoadingViewCreator(@Nullable
                                        IUnbluCustomLoadingViewCreator customLoadingViewCreator)

Sets a custom loading view creator.

Overrides:

setCustomLoadingViewCreator in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Parameters:

customLoadingViewCreator - The loading view creator which should be used whenever a loading view is displayed

getCustomLoadingViewCreator

@Nullable
public IUnbluCustomLoadingViewCreator getCustomLoadingViewCreator()

Returns the currently configured loading view creator

Overrides:

getCustomLoadingViewCreator in class com.unblu.coresdk.internal.InternalUnbluCoreApi<T extends com.unblu.coresdk.internal.IUnbluCoreApiDelegate>

Returns:

the currently configured loadingView creator