Package org.cleaninsights.sdk

Types

Campaign
Link copied to clipboard
data class Campaign(start: Instant, end: Instant, aggregationPeriodLength: Long, numberOfPeriods: Int, onlyRecordOnce: Boolean, eventAggregationRule: EventAggregationRule)
CampaignConsent
Link copied to clipboard
class CampaignConsent(campaignId: String, consent: Consent) : Consent
CleanInsights
Link copied to clipboard
open class CleanInsights(configuration: Configuration, store: Store)
Configuration
Link copied to clipboard
data class Configuration(server: URL, siteId: Int, campaigns: Map<String, Campaign>, timeout: Double, maxRetryDelay: Double, maxAgeOfOldData: Int, persistEveryNTimes: Int, serverSideAnonymousUsage: Boolean, debug: Boolean)
Consent
Link copied to clipboard
open class Consent(granted: Boolean, start: Instant, end: Instant)
ConsentRequestUi
Link copied to clipboard
interface ConsentRequestUi
ConsentRequestUiComplete
Link copied to clipboard
typealias ConsentRequestUiComplete = (granted: Boolean) -> Unit
ConsentRequestUiCompletionHandler
Link copied to clipboard
interface ConsentRequestUiCompletionHandler
Used for Java interop.
Consents
Link copied to clipboard
class Consents
This class keeps track of all granted or denied consents of a user.
DataPoint
Link copied to clipboard
open class DataPoint(campaignId: String, times: Int, first: Instant, last: Instant)
DebugHandler
Link copied to clipboard
interface DebugHandler
DefaultStore
Link copied to clipboard
open class DefaultStore(args: Map<String, Any>, debug: (message: String) -> Unit) : Store
Default implementation of a store.
DoneHandler
Link copied to clipboard
interface DoneHandler
Event
Link copied to clipboard
class Event(category: String, action: String, name: String?, value: Double?, campaignId: String, times: Int, first: Instant, last: Instant) : DataPoint
EventAggregationRule
Link copied to clipboard
enum EventAggregationRule : Enum<EventAggregationRule>
Feature
Link copied to clipboard
enum Feature : Enum<Feature>
FeatureConsent
Link copied to clipboard
class FeatureConsent(feature: Feature, consent: Consent) : Consent
Insights
Link copied to clipboard
class Insights(idsite: Int, lang: String?, ua: String?)
Create an Insights object according to configuration with all data from the store which is due for offloading to the server.
JavaConsentRequestUi
Link copied to clipboard
interface JavaConsentRequestUi
JavaStore
Link copied to clipboard
abstract class JavaStore @JvmOverloads() constructor(args: Map<String, Any>, debug: DebugHandler?) : Store
The store holds the user's consents to the different Features and Campaigns, and their Visit and Event measurements.
Period
Link copied to clipboard
class Period(start: Instant, end: Instant)
Store
Link copied to clipboard
abstract class Store(args: Map<String, Any>, debug: (message: String) -> Unit)
The store holds the user's consents to the different Features and Campaigns, and their Visit and Event measurements.
Visit
Link copied to clipboard
class Visit(scenePath: List<String>, campaignId: String, times: Int, first: Instant, last: Instant) : DataPoint