com.unblu.sdk.agent

Class UnbluAgentApi

java.lang.Object

com.unblu.sdk.core.internal.InternalUnbluCoreApi<T>

com.unblu.sdk.core.UnbluCoreApi<com.unblu.sdk.agent.internal.AgentApiDelegate>

com.unblu.sdk.agent.internal.InternalUnbluAgentApi

com.unblu.sdk.agent.UnbluAgentApi

public class UnbluAgentApi
extends com.unblu.sdk.agent.internal.InternalUnbluAgentApi

The API to use to access unblu suite functionality like chat, co-browsing etc.

Before using the API, ensure that in your app manifest file points you use either the class UnbluAgentApplication or a custom subclass of it for the application. Check its class documentation for further details.

If you want to use audio/video sessions, please ensure the following permissions are added to your manifest.xml

 <uses-permission android:name="android.permission.RECORD_AUDIO" />
 <uses-permission android:name="android.permission.CAMERA" />
 <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
 

Before calling any other function configureApi(UnbluApiConfiguration) should be called inside main activity Activity.onCreate(Bundle).

The constants of IUnbluEventApi can be used to register for events via a BroadcastReceiver and access their values. The easier way is to subclass the UnbluEventReceiver and override the methods according to the events which you want to listen for.

A typical flow for the usage would be:

Activity.onCreate(Bundle) {
UnbluAgentApi.getInstance().UnbluCoreApi.configureApi(UnbluApiConfiguration)
//register for general errors and/or also other events
unbluBroadcastReceiver = new UnbluEventReceiver(getApplicationContext()) {
...

//start the api. This could also be done later when it is needed, but it will take a while until the api is ready.
UnbluAgentApi.getInstance().UnbluCoreApi.initApi(IUnbluApiSuccessfullyInitializedCallback, IUnbluApiInitializeExceptionCallback)(success: {<success handling>}, failure: {<error handling>}))
...
}

showUnblUi {
//the unblu UI should be shown
UnbluAgentApi.UnbluCoreApi.showUi(boolean, IUnbluApiSuccessVoidCallback, IUnbluShowUiExceptionCallback)(true, success: {<success handling>}, failure: {<error handling>});
}


Nested Class Summary

Nested classes/interfaces inherited from class com.unblu.sdk.core.internal.InternalUnbluCoreApi

com.unblu.sdk.core.internal.InternalUnbluCoreApi.InternalUnbluEventReceiver

Field Summary

Fields inherited from class com.unblu.sdk.core.UnbluCoreApi

ANIMATION_TIME, enableCapturingPerformanceLogging, enableDebugOutput

Fields inherited from class com.unblu.sdk.core.internal.InternalUnbluCoreApi

apiDelegate, customBackgroundColor

Method Summary

Modifier and Type	Method and Description
void	configureApi(UnbluApiConfiguration configuration) Configures the unblu api.
protected void	destroy()
static UnbluAgentApi	getInstance()

Methods inherited from class com.unblu.sdk.core.UnbluCoreApi

deinitApi, getApplication, getCustomLoadingViewCreator, getLogLevel, getNotificationApi, getOpenConversationId, getPersonInfo, getUiBottomMargin, getUiTopMargin, getUnreadMessagesCount, initApi, initApi, internalGetCoreInstance, isCallUiOpen, isInErrorState, isInitialized, isUiVisible, openConversation, openConversationOverview, preloadUi, setApplicationContext, setAutoHideUiOnBack, setBackButtonCallback, setCustomBackgroundColor, setCustomCookies, setCustomLoadingViewCreator, setLogLevel, setNamedArea, setUiMargins, showUi, showUi, startAudioCall, startVideoCall

Methods inherited from class com.unblu.sdk.core.internal.InternalUnbluCoreApi

getApiDelegate, getCustomBackgroundColor, getModule, requestUiVisibilityIfNotOpen, setApplication

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

@NonNull
public static UnbluAgentApi getInstance()

Returns:

The instance of the UnbluAgentApi. Only for internal use!

destroy

protected void destroy()

Overrides:

destroy in class com.unblu.sdk.core.internal.InternalUnbluCoreApi<com.unblu.sdk.agent.internal.AgentApiDelegate>

configureApi

public void configureApi(@NonNull
                         UnbluApiConfiguration configuration)

Configures the unblu api. Use UnbluCoreApi.initApi(IUnbluApiSuccessfullyInitializedCallback, IUnbluApiInitializeExceptionCallback) to be able start new sessions 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.sdk.agent.internal.InternalUnbluAgentApi

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.