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

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.

createProfile

abstract fun createProfile(callback: Callback? = null)

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

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.

deleteProfile

abstract fun deleteProfile(callback: Callback? = null)

Removes the profile from the BlueConic servers. The profile ID will be removed from the BlueConic client. A new profile ID will be generated.

destroyPlugins

abstract fun destroyPlugins()

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

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.

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.

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.