BroadpeakSmartLibInitializationData

data class BroadpeakSmartLibInitializationData(val applicationContext: Context, val analyticsHostNames: BroadpeakAnalyticsHost = BroadpeakAnalyticsHost.None, val domainHostNames: BroadpeakCDN = BroadpeakCDN.None, val loggerLevel: Int = BroadpeakLoggerLevel.LOG_VERBOSE, val uuid: UUID? = null, val deviceType: String? = null, val userAgent: String? = null, val gdprPreference: Int? = null, val sessionKeepAliveFrequencyMs: Int? = null)

Data class holding the necessary information for initializing the Broadpeak SmartLib SDK. This data is used to configure the SDK with essential parameters like application context, server addresses, and domain names required for its operation.

Constructors

Link copied to clipboard
constructor(applicationContext: Context, analyticsHostNames: BroadpeakAnalyticsHost = BroadpeakAnalyticsHost.None, domainHostNames: BroadpeakCDN = BroadpeakCDN.None, loggerLevel: Int = BroadpeakLoggerLevel.LOG_VERBOSE, uuid: UUID? = null, deviceType: String? = null, userAgent: String? = null, gdprPreference: Int? = null, sessionKeepAliveFrequencyMs: Int? = null)

Properties

Link copied to clipboard

Address of the Analytics Engine (i.e. "https://server-host") or an Analytics Engines list (i.e. "http://server-host,https://server-host-2, http://server-host-3") or BroadpeakAnalyticsHost.None for no Analytics Engine. Add "nocache=" as prefix to prevent caching failed reports (i.e. "nocache=http://server-host:8080")

Link copied to clipboard

The application's context.

Link copied to clipboard
val deviceType: String? = null

Overrides the default device type detected by the SmartLib.

Link copied to clipboard

The domain names list used to identify Broadpeak sessions (i.e "cdn.broadpeak.com" ,"cdn2.broadpeak.com") or BroadpeakCDN.All is used to declare that all sessions are using a Broadpeak CDN or BroadpeakCDN.None is used to declare that all given url are not hosted on a Broadpeak CDN.

Link copied to clipboard
val gdprPreference: Int? = null

The General Data Protection Regulation aka (GDPR) preference for the Broadpeak Analytics. Possible values:

Link copied to clipboard

The logger level for debugging. Possible values:

Link copied to clipboard

Overrides the default SmartLib keepalive frequency (5000ms). The value can be within 5000ms to 10000ms.

Link copied to clipboard
val userAgent: String? = null

The user agent to use when firing Broadpeak analytics ad tracking beacons.

Link copied to clipboard
val uuid: UUID? = null

A unique user identifier or any other information which can be used to uniquely identify a user, an account or a group of users. This information collection, storage and use must be done in accordance with GDPR regulation in effect in your country. For more information about GDPR: https://en.wikipedia.org/wiki/General_Data_Protection_Regulation