Package org.cleaninsights.sdk

Types

data class Campaign( val start: Calendar, val end: Calendar, val aggregationPeriodLength: Long, val numberOfPeriods: Int = 1, val onlyRecordOnce: Boolean = false, val eventAggregationRule: EventAggregationRule = EventAggregationRule.Sum, val strengthenAnonymity: Boolean = false)

CampaignConsent

class CampaignConsent(val campaignId: String, consent: Consent) : Consent

CleanInsights

open class CleanInsights(val configuration: Configuration, store: Store)

Configuration

data class Configuration( val server: URL, val siteId: Int, val campaigns: Map<String, Campaign>, val timeout: Double = 5.0, val maxRetryDelay: Double = 3600.0, val maxAgeOfOldData: Int = 100, val persistEveryNTimes: Int = 10, val serverSideAnonymousUsage: Boolean = false, val debug: Boolean = false)

Consent

open class Consent( val granted: Boolean, val start: Calendar = CleanInsights.now(), val end: Calendar = CleanInsights.now())

ConsentRequestUi

interface ConsentRequestUi

ConsentRequestUiComplete

typealias ConsentRequestUiComplete = (granted: Boolean) -> Unit

ConsentRequestUiCompletionHandler

interface ConsentRequestUiCompletionHandler

Used for Java interop.

Consents

class Consents

This class keeps track of all granted or denied consents of a user.

DataPoint

open class DataPoint( val campaignId: String, var times: Int = 1, val first: Calendar = CleanInsights.now(), val last: Calendar = CleanInsights.now())

DebugHandler

interface DebugHandler

DefaultStore

open class DefaultStore(args: Map<String, Any> = HashMap(), debug: (message: String) -> Unit = fun(_){}) : Store

Default implementation of a store. Stores the data in JSON format in a given folder.

DoneHandler

interface DoneHandler

Event

class Event( val category: String, val action: String, val name: String?, var value: Double?, val campaignId: String, var times: Int = 1, val first: Calendar = CleanInsights.now(), val last: Calendar = CleanInsights.now()) : DataPoint

EventAggregationRule

enum EventAggregationRule : Enum<EventAggregationRule>

Feature

enum Feature : Enum<Feature>

FeatureConsent

class FeatureConsent(val feature: Feature, consent: Consent) : Consent

Insights

class Insights( val idsite: Int, val lang: String?, val ua: String?)

Create an Insights object according to configuration with all data from the store which is due for offloading to the server.

JavaConsentRequestUi

interface JavaConsentRequestUi

JavaStore

abstract class JavaStore @JvmOverloads constructor(args: Map<String, Any> = HashMap(), debug: DebugHandler? = null) : Store

The store holds the user's consents to the different Features and Campaigns, and their Visit and Event measurements.

Period

class Period(val start: Calendar, val end: Calendar)

Store

abstract class Store(args: Map<String, Any> = HashMap(), debug: (message: String) -> Unit = fun(_){})

The store holds the user's consents to the different Features and Campaigns, and their Visit and Event measurements.

Visit

class Visit( val scenePath: List<String>, val campaignId: String, var times: Int = 1, val first: Calendar = CleanInsights.now(), val last: Calendar = CleanInsights.now()) : DataPoint

Functions

autoTrack

fun CleanInsights.Companion.autoTrack( context: Context, server: URL, siteId: Int, campaigns: Map<String, Campaign>? = null): CleanInsights

Instantiates a singleton CleanInsights object with a default configuration and a default campaign named "visits" which never expires.

Properties

autoTrackCi

val CleanInsights.Companion.autoTrackCi: CleanInsights?