Connect Android SDK: initialization and configuration

The page describes the primary methods that you can use to manage and configure the Connect Android SDK.

Platform: Android 8-16
Languages: Kotlin and Java
Declared in: Connect

Library management

Connect.init

Initializes the Connect library.

Connect.init(application: Application)

Parameters:

• application (required) — the Android Application instance. Call this before Connect.enable().

Connect.enable

Enables the Connect library.

Connect.enable(appKey: String?, postMessageUrl: String?)

Parameters:

• appKey (required) — the application key generated for your mobile app. If null, the value is read from ConnectBasicConfig.properties.
• postMessageUrl (required) — the Connect domain assigned to your organization. If null, the value is read from ConnectBasicConfig.properties.

Connect.disable

Disables the Connect library.

Connect.disable(): Boolean

Connect.isEnabled

Check if the Connect library is enabled.

Connect.isEnabled(): Boolean

Connect.getLibraryVersion

Returns the library version.

Connect.getLibraryVersion(): String

Connect.push

Returns the push notification API.

Connect.push: PushApi

Use this property to access push notification methods such as isPushAccepted(). See Enable push notifications in an Android app (Firebase) or Enable push notifications in an Android app (Huawei).

Session management

Connect.startSession

Starts a new Connect session.

Connect.startSession(sessionID: String?): Boolean

Parameters:

• sessionID (optional) — the ID to assign to the session.

Connect.getCurrentSessionId

Returns the ID of the current session.

Connect.getCurrentSessionId(): String

Connect.setCurrentSessionId

Sets the current session ID.

Connect.setCurrentSessionId(sessionId: String?)

Parameters:

• sessionId (required) — the ID to assign to the current Connect session.

Connect.createSessionId

Creates a new session ID.

Connect.createSessionId(): String?

Connect.getTimestampFromSession

Returns the timestamp of the current session.

Connect.getTimestampFromSession(): Long

Identification

Connect.logIdentificationEvent

Sends an identification signal to Connect.

Connect.logIdentificationEvent(
    identifierName: String,
    identifierValue: String,
    url: String = "http://acoustic.co/test",
    signalType: String = "pageView",
    additionalParameters: Map<String, String> = emptyMap()
): Boolean

Parameters:

• identifierName (required) — the contact attribute name in Connect. Must match exactly, including capitalization and spacing.
• identifierValue (required) — the value of the identifier.
• url (optional) — the screen context for the signal. Defaults to "http://acoustic.co/test".
• signalType (required) — the signal type. Pass "loggedIn" for sign-in events or "accountRegistered" for registration events.
• additionalParameters (optional) — additional key-value pairs to include with the signal.

Returns false without throwing if either identifierName or identifierValue is blank.

Property and device management

Connect.getPropertyName

Returns the property name from a view.

Connect.getPropertyName(view: View?): PropertyName

Connect.getDeviceId

Returns the device ID.

Connect.getDeviceId(): String

Connect.setDeviceId

Sets the device ID.

Connect.setDeviceId(deviceId: String?): Boolean

Config management

Connect.getConfigItemInt

Returns an integer config item.

Connect.getConfigItemInt(
    key: String,
    module: EOLifecycleObjectName
): Int

Connect.getConfigItemLong

Returns a long integer config item.

Connect.getConfigItemLong(
    key: String,
    module: EOLifecycleObjectName
): Long

Connect.getConfigItemDouble

Returns a double config item.

Connect.getConfigItemDouble(
    key: String,
    module: EOLifecycleObjectName
): Double

Connect.getConfigItemBoolean

Returns a boolean config item.

Connect.getConfigItemBoolean(
    key: String,
    module: EOLifecycleObjectName
): Boolean

Connect.getConfigItemString

Returns a string config item.

Connect.getConfigItemString(
    key: String,
    module: EOLifecycleObjectName
): String?

Connect.getConfigItemLongMSFromMinute

Returns a long integer value in milliseconds from minutes.

Connect.getConfigItemLongMSFromMinute(
    key: String,
    module: EOLifecycleObjectName
): Long

Connect.updateConfig

Updates a configuration item.

Connect.updateConfig(
    key: String,
    value: String,
    module: EOLifecycleObjectName
): Boolean

Connect.getConfig

Returns the configuration for a module.

Connect.getConfig(
    module: EOLifecycleObjectName
): Map<String, String>?

Connect.appendConfig

Appends configuration from a file.

Connect.appendConfig(
    module: EOLifecycleObjectName,
    fileName: String
): Boolean

Connect.updateConfig (JSONObject overload)

Updates configuration using a JSONObject.

Connect.updateConfig(
    module: EOLifecycleObjectName,
    configurationObject: JSONObject
): Boolean

Lifecycle object management

Connect.getLifecycleObject

Returns a lifecycle object by name.

Connect.getLifecycleObject(name: String): EOLifecycleObject?

Environmental Data Service

Connect.getEnvironmentalDataService

Returns the environmental data service.

Connect.getEnvironmentalDataService(): EnvironmentalDataService?