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

IAdvizeSDK

object IAdvizeSDK

iAdvize Conversation SDK main entry point. Manage all the setup and initialization and gather access to sub-controllers.

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 Chatbox configuration & update.

conversationController

val conversationController: ConversationController

Controller in charge of the conversation.

defaultFloatingButtonController

val defaultFloatingButtonController: DefaultFloatingButtonController

Controller in charge of default floating button configuration.

var logLevel: Logger.Level

Level of the iAdvize Conversation SDK console logger.

notificationController

val notificationController: NotificationController

Controller in charge of notifications.

targetingController

val targetingController: TargetingController

Controller in charge of 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.

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. Once this call succeeds, the iAdvize Conversation SDK is deactivated and you will need to call activate again if the user needs to start a new conversation.