BlueConic Android SDK/com.blueconic.impl/BlueConicClientImpl

BlueConicClientImpl

class BlueConicClientImpl : BlueConicClient

Implementation of the BlueConic client, handling the profile retrieval and storage. This may be from cache, persistent storage on the client or direct requests to the BlueConic server.

Constructors

BlueConicClientImpl

constructor()

Properties

activity

@get:Synchronized

open override val activity: Activity?

Returns the current activity.

configuration

open lateinit override var configuration: BlueConicConfiguration

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

context

@get:Synchronized

open override val context: Context?

Returns the current context.

eventManager

open override val eventManager: BlueConicEventManager

BlueConic event manager used to publish Listener and Dialogue events.

isEnabled

@get:Synchronized

@set:Synchronized

open override var isEnabled: Boolean

Determines whether this client is enabled.

profile

open override val profile: Profile

BlueConic profile used for various profile operations.

screenName

open override 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

open override val segments: MutableList<Segment>

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

Functions

createClickEvent

@Synchronized

open override fun createClickEvent(interactionId: String, properties: Map<String, Any?>, context: Activity?, callback: Callback?)

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

createConversionEvent

@Synchronized

open override fun createConversionEvent(interactionId: String, properties: Map<String, Any?>, context: Activity?, callback: Callback?)

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

createEvent

@Synchronized

open override fun createEvent(eventType: String, properties: Map<String, Any?>, context: Activity?, callback: Callback?)

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

@Synchronized

open override fun createPageViewEvent(screenName: String, context: Activity, properties: Map<String, Any?>, callback: Callback?)

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

createProfile

open override fun createProfile(callback: Callback?)

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

createTimelineEvent

open override fun createTimelineEvent(eventType: String, eventDate: Date, properties: Map<String, Any?>, callback: Callback?)

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

createTimelineEventById

open override fun createTimelineEventById(eventId: String, eventType: String, eventDate: Date, properties: Map<String, Any?>, callback: Callback?)

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

createViewEvent

@Synchronized

open override fun createViewEvent(interactionId: String, properties: Map<String, Any?>, context: Activity?, callback: Callback?)

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

deleteProfile

open override fun deleteProfile(callback: Callback?)

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

open override fun destroyPlugins()

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

getView

@Synchronized

open override fun getView(expression: String?): View?

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

hasSegment

open override fun hasSegment(segmentId: String?): Boolean

Returns whether a profile has a segment or not.

initialize

@Synchronized

open override fun initialize(configuration: BlueConicConfiguration, callback: Callback?)

Initializes the BlueConic client with the given configuration.

loadProfileValues

fun loadProfileValues(callback: Callback?)

Refreshes profile properties from the server. When the retrieval failed, the onError() method is invoked on the callback object. When successful the onSuccess() method is invoked. Before loading the values from the server the client sends his changed values to the server.

loadPropertyLabels

fun ~~loadPropertyLabels~~()

Loads the profile property labels.

onConnectivityChanged

fun onConnectivityChanged(isConnected: Boolean)

Callback when the connectivity status is changed.

registerPluginClass

open override 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.

open override 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.

setContext

fun setContext(activity: Activity)

setLocale

@Synchronized

open override fun setLocale(locale: String)

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

setPlatformInformation

fun setPlatformInformation(platformName: String, platformVersion: String)

Sets the platform information. Only use this method when you want to use it in combination with a BlueConic plugin (ex.: React Native).

setSimulatorData

open override fun setSimulatorData(userName: String, mobileSessionId: String)

Set the simulator data for the BlueConic client.

updateProfile

@Synchronized

open override fun updateProfile(callback: Callback?)

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.