BlueConic Android SDK/com.blueconic/BlueConicClient

BlueConicClient

interface BlueConicClient

Interface for the BlueConic client.

Inheritors

BlueConicClientImpl

Types

Companion

object Companion

Properties

activity

abstract val activity: Activity?

Returns the current activity.

configuration

abstract var configuration: BlueConicConfiguration

The configuration of the BlueConic client SDK. Not available before initialization.

consentedObjectives

abstract var consentedObjectives: Collection<String>?

The consented objectives IDs of this profile in a list, e.g. {"tracking", "advertising"}. Passing a property that was already set with values will cause the old values to be removed.

eventManager

abstract val eventManager: BlueConicEventManager

BlueConic event manager used to publish Listener and Dialogue events.

isEnabled

abstract var isEnabled: Boolean

Returns true when the BlueConicClient is enabled. You are able to enable/ disable the BlueConicClient.

privacyLegislation

abstract var privacyLegislation: String?

The privacy legislation for this profile, e.g. "GDPR". Passing a property that was already set with values will cause the old values to be removed.

profileId

abstract val profileId: String?

Returns the ID of the profile.

refusedObjectives

abstract var refusedObjectives: Collection<String>?

The refused objectives IDs of this profile in a list, e.g. {"tracking", "advertising"}. Passing a property that was already set with values will cause the old values to be removed.

screenName

abstract var screenName: String

Returns the screen name. When the screen name is set with a call to createEvent in the Activity's onResume method it will return that screen name. Otherwise it will return the Activity's title. This method is typically used in Plugins.

segments

abstract val segments: MutableList<Segment>

Returns all segments for the profile. The segments are retrieved by each PAGEVIEW event.

Functions

addConsentedObjective

abstract fun addConsentedObjective(objectiveId: String, callback: Callback? = null)

Adds a single objective ID to the consented objectives for this profile. If there are already values for a property the new value will be added. Values for a property need to be unique; passing the same value multiple times will have no effect.

addProfileValue

abstract fun addProfileValue(property: String, value: String, callback: Callback? = null)

Adds a single property value to the profile. If there are already values for a property the new value will be added. Values for a property need to be unique; passing the same value multiple times will have no effect.

addProfileValues

abstract fun addProfileValues(property: String, values: Collection<String>, callback: Callback? = null)

Adds property values to the profile. The values from the collection are added to the profile. If there are already values for a property the new values will be added. Values for a property need to be unique; passing the same values multiple times will have no effect.

addRefusedObjective

abstract fun addRefusedObjective(objectiveId: String, callback: Callback? = null)

Adds a single objective ID to the refused objectives for this profile. If there are already values for a property the new value will be added. Values for a property need to be unique; passing the same value multiple times will have no effect.

clearProfileId

abstract fun clearProfileId(callback: Callback? = null)

Clears the profile ID from the BlueConic client locally (cache). A new profile ID will be generated.

createClickEvent

abstract fun createClickEvent(interactionId: String, properties: Map<String, Any?> = mutableMapOf(), context: Activity? = null, callback: Callback? = null)

Registers a CLICK event with the given interaction ID, properties and context.

createConversionEvent

abstract fun createConversionEvent(interactionId: String, properties: Map<String, Any?> = mutableMapOf(), context: Activity? = null, callback: Callback? = null)

Registers a CONVERSION event with the given interaction ID, properties and context.

createEvent

abstract fun createEvent(eventType: String, properties: Map<String, Any?> = mutableMapOf(), context: Activity? = null, callback: Callback? = null)

Registers an event of the specified type with the given data. The data object can contain a nested structure to sent over custom events and/or with Timeline context in order to register timeline events.

createPageViewEvent

abstract fun createPageViewEvent(screenName: String, context: Activity, properties: Map<String, Any?> = mutableMapOf(), callback: Callback? = null)

Registers a PAGEVIEW event with the given screen name, properties and context.

createTimelineEvent

abstract fun createTimelineEvent(eventType: String, eventDate: Date, properties: Map<String, Any?>, callback: Callback? = null)

Registers an event on the timeline of the profile with the given properties.

createTimelineEventById

abstract fun createTimelineEventById(eventId: String, eventType: String, eventDate: Date, properties: Map<String, Any?>, callback: Callback? = null)

Registers an event on the timeline of the profile with the given properties.

createViewEvent

abstract fun createViewEvent(interactionId: String, properties: Map<String, Any?> = mutableMapOf(), context: Activity? = null, callback: Callback? = null)

Registers a VIEW event with the given interaction ID, properties and context.

destroyPlugins

abstract fun destroyPlugins()

Triggers a call to onDestroy on every plugin that was retrieved at the last PAGEVIEW.

getProfileValue

abstract fun getProfileValue(property: String?): String?

Returns the first value for a given profile property.

getProfileValues

abstract fun getProfileValues(property: String?): Collection<String>

Returns the values for a given profile property. For example, it can return all the values in a list of hobbies, e.g. {"tennis", "soccer"}.

getView

abstract fun getView(expression: String?): View?

Returns a view component based on the given identifier or null if no match is found.

hasSegment

abstract fun hasSegment(segmentId: String?): Boolean

Returns whether a profile has a segment or not.

incrementProfileValue

abstract fun incrementProfileValue(property: String, value: String?, callback: Callback? = null)

Increments a single property value to the profile. If there are already values for a property the new value will be the sum of all values.

initialize

abstract fun initialize(configuration: BlueConicConfiguration, callback: Callback? = null)

Initializes the BlueConic client with the given configuration.

registerPluginClass

abstract fun registerPluginClass(pluginClass: Class<out Plugin>)

Register a plugin class. This is optional. Can be used to mark and define which Plugin classes to use for BlueConic when a page view is registered.

abstract fun registerPluginClass(pluginClass: Class<out Plugin>, className: String)

Register a plugin class with a specific name. This is optional. Can be used to mark and define which Plugin classes to use for BlueConic when a page view is registered.

setLocale

abstract fun setLocale(locale: String)

Sets the locale to get parameters for. By default, the default locale configured in BlueConic is used.

setProfileValue

abstract fun setProfileValue(property: String, value: String?, callback: Callback? = null)

Sets a value on the profile. Passing a property that was already set with values will cause for the old values to be removed.

setProfileValues

abstract fun setProfileValues(property: String, values: Collection<String>, callback: Callback? = null)

Sets values on the profile. Passing a property that was already set with values will cause for the old values to be removed.

setSimulatorData

abstract fun setSimulatorData(userName: String, mobileSessionId: String)

Set the simulator data for the BlueConic client.

updateProfile

abstract fun updateProfile(callback: Callback? = null)

Update the profile to sync over the data from the Mobile app to the BlueConic servers and; also pull in the data that has changed on the BlueConic side.