snowplow-android-tracker/com.snowplowanalytics.snowplow.event/ScreenView

ScreenView

class ScreenView @JvmOverloads constructor(name: String, screenId: UUID? = null) : AbstractSelfDescribing

A ScreenView event.

Parameters

name

Name of the screen.

screenId

Identifier of the screen.

Constructors

ScreenView

@JvmOverloads

constructor(name: String, screenId: UUID? = null)

Types

Companion

object Companion

Functions

activityClassName

fun activityClassName(activityClassName: String?): ScreenView

Name of the Activity subclass.

activityTag

fun activityTag(activityTag: String?): ScreenView

Tag of the Activity subclass.

contexts

fun ~~contexts~~(contexts: List<SelfDescribingJson>): AbstractEvent

Adds a list of context entities to the existing ones.

entities

fun entities(entities: List<SelfDescribingJson>): AbstractEvent

Adds a list of context entities to the existing ones.

fragmentClassName

fun fragmentClassName(fragmentClassName: String?): ScreenView

Name of the Fragment subclass.

fragmentTag

fun fragmentTag(fragmentTag: String?): ScreenView

Tag of the Fragment subclass.

previousId

fun previousId(previousId: String?): ScreenView

Identifier of the previous screen.

previousName

fun previousName(previousName: String?): ScreenView

Name of the previous screen.

previousType

fun previousType(previousType: String?): ScreenView

Type of the previous screen.

transitionType

fun transitionType(transitionType: String?): ScreenView

Type of transition between previous and current screen.

trueTimestamp

fun trueTimestamp(trueTimestamp: Long?): AbstractEvent

Set the custom timestamp of the event.

type

fun type(type: String?): ScreenView

Type of screen.

Properties

activityClassName

var activityClassName: String?

Name of the Activity subclass.

activityTag

var activityTag: String?

Tag of the Activity subclass.

contexts

open override var ~~contexts~~: List<SelfDescribingJson>

dataPayload

open override val dataPayload: Map<String, Any?>

The payload for the event.

entities

open override var entities: MutableList<SelfDescribingJson>

entitiesForProcessing

open val entitiesForProcessing: List<SelfDescribingJson>?

Used for events whose properties are added as entities, e.g. Ecommerce events

fragmentClassName

var fragmentClassName: String?

Name of the Fragment subclass.

fragmentTag

var fragmentTag: String?

Tag of the Fragment subclass.

val id: String

Identifier of the screen view (unique for each screen view event).

name

val name: String

Name of the screen.

previousId

var previousId: String?

Identifier of the previous screen.

previousName

var previousName: String?

Name of the previous screen.

previousType

var previousType: String?

Type of the previous screen.

schema

open override val schema: String

transitionType

var transitionType: String?

Type of transition between previous and current screen.

trueTimestamp

open override var trueTimestamp: Long?

type

var type: String?

Type of screen.