pillarbox-analytics/ch.srgssr.pillarbox.analytics.commandersact/CommandersAct

CommandersAct

interface CommandersAct

Interface for interacting with the Commanders Act SDK.

This interface provides methods for sending data to Commanders Act, such as page views, events, and TCMediaEvents. It also allows for managing permanent data and consent services.

Functions

Link copied to clipboard
open fun enableRunningInBackground()

Enables the tracking to continue running in the background.

Link copied to clipboard
abstract fun getPermanentDataLabel(label: String): String?

Retrieves a permanent data label associated with the given label.

Link copied to clipboard
abstract fun putPermanentData(labels: Map<String, String>)

Puts the provided labels as permanent data.

Link copied to clipboard
abstract fun removePermanentData(label: String)

Removes permanent data associated with the given label.

Link copied to clipboard
abstract fun sendEvent(event: CommandersActEvent)

Sends an event.

Link copied to clipboard
abstract fun sendPageView(pageView: CommandersActPageView)

Sends a page view event.

Link copied to clipboard
abstract fun sendTcMediaEvent(event: TCMediaEvent)

Sends a TCMediaEvent.

Link copied to clipboard
abstract fun setConsentServices(consentServices: List<String>)

Sets the list of consent services.