iAdvize Mobile SDK/com.iadvize.conversation.sdk/IAdvizeSDK

IAdvizeSDK

object IAdvizeSDK

The iAdvize SDK lets you provide a unique conversational experience to your users.

You access the SDK through this IAdvizeSDK instance.

Start by configuring the SDK using initiate, then you can authenticate a visitor through activate.

You can then rely on the provided controllers to configure and monitor the various parts of the conversational experience:

The targetingController lets you control the targeting process.
The defaultFloatingButtonController lets you configure the chat button.
The chatboxController lets you configure the chatbox.
The notificationController lets you configure push notifications.
The conversationController lets you monitor the ongoing conversation.
The transactionController lets you register transactions.
The visitorController lets you register custom data related to the visitor.

Types

ActivationStatus

enum ActivationStatus : Enum<IAdvizeSDK.ActivationStatus>

Activation state of the SDK.

interface Callback

Callback used in various SDK public APIs with asynchronous results.

sealed class Error : Exception

Properties

activationStatus

var activationStatus: IAdvizeSDK.ActivationStatus

Activation state of the SDK.

chatboxController

val chatboxController: ChatboxController

Controller in charge of the chatbox configuration & update.

conversationController

val conversationController: ConversationController

Controller in charge of the conversation.

defaultFloatingButtonController

val defaultFloatingButtonController: DefaultFloatingButtonController

Controller in charge of the chat button configuration.

var logLevel: Logger.Level

Level of the iAdvize Conversation SDK console logger.

notificationController

val notificationController: NotificationController

Controller in charge of push notifications.

targetingController

val targetingController: TargetingController

Controller in charge of the targeting process.

transactionController

val transactionController: TransactionController

Controller in charge of transactions.

visitorController

val visitorController: VisitorController

Controller in charge of visitor custom data.

Functions

fun activate(projectId: Int, authenticationOption: AuthenticationOption, gdprOption: GDPROption = GDPROption.Disabled, callback: IAdvizeSDK.Callback? = null): Job

Activate the iAdvize Conversation SDK for a visitor.

fun debugInfo(): String

Returns a JSON String containing detailed information about the state of the iAdvize SDK.

fun initiate(application: Application, callback: IAdvizeSDK.Callback? = null): Job

Initiate the iAdvize conversation SDK for your app. This will register a callback on activities lifecycle to help through SDK usage in the app. This must be done as soon as possible.

fun logout(callback: IAdvizeSDK.Callback? = null): Job

Logout the user from the SDK. This hides the chat button, disables push notifications and clears all the locally stored visitor data. You will need to call activate again if the user needs to start a new conversation.