BlueConic Android SDK/com.blueconic.impl/BlueConicClientImpl

BlueConicClientImpl

class BlueConicClientImpl(activityContext: Activity) : 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(activityContext: Activity)

Types

BlueConicCallBack

interface BlueConicCallBack

Interface for callbacks.

object Companion

enum EventType : Enum<BlueConicClientImpl.EventType>

Enum for event types.

Properties

@get:Synchronized

open override val activity: Activity

Returns the current activity.

consentedObjectives

@get:Synchronized

@set:Synchronized

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

@get:Synchronized

@set:Synchronized

open override var isEnabled: Boolean

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

privacyLegislation

@get:Synchronized

@set:Synchronized

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

open override val profileId: String?

Returns the ID of the profile.

profilePropertyNames

val profilePropertyNames: Collection<String>

val propertyLabels: Map<String, Map<String, String>>?

refusedObjectives

@set:Synchronized

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

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.

open override val segments: MutableList<BlueConicClient.Segment>

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

Functions

addConsentedObjective

open override fun addConsentedObjective(objectiveId: String)

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

open override fun addProfileValue(property: String, value: String)

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

open override fun addProfileValues(property: String, values: Collection<String>)

Add property values to the profile. The values are passed as a map from the property identifier to the list of property values. 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

open override fun addRefusedObjective(objectiveId: String)

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.

fun clearProfileId()

Clear profile id, based on hostname and domain group.

open override fun createEvent(eventType: String, properties: Map<String, String?>)

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

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

Registers an event of the specified type with the given properties.

open override fun createEvent(eventType: String, properties: Map<String, String?>, callback: Runnable?)

Registers an event of the specified type with the given properties. For a "PAGEVIEW" event a screenName can be passed, so interactions can be restricted on the Where tab in BlueConic.

createEventWithData

open override fun createEventWithData(eventType: String, properties: Map<String, Any?>)

open override fun createEventWithData(eventType: String, properties: Map<String, Any?>, callback: Runnable?)

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

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

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

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.

createTimelineEvent

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

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: Runnable?)

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

open override fun destroyPlugins()

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

getProfileValue

open override fun getProfileValue(property: String?): String?

Returns the first value for a profile property.

getProfileValues

open override fun getProfileValues(property: String?): Collection<String>

Returns the values for a profile property.

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

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

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

Returns whether a profile has a segment or not.

incrementProfileValue

open override fun incrementProfileValue(property: String, value: String?)

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.

loadProfileValues

fun loadProfileValues(callback: BlueConicClientImpl.BlueConicCallBack?)

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 BlueConicClient.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 BlueConicClient.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.

fun setContext(activity: Activity)

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).

setProfileValue

open override fun setProfileValue(property: String, value: String?)

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

open override fun setProfileValues(property: String, values: Collection<String>)

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

open override fun updateProfile()

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

open override fun updateProfile(callback: Runnable?)

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.