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

fun ScreenView(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.

beginProcessing

open override fun beginProcessing(tracker: Tracker)

Hook method called just before the event processing in order to execute special operations.

contexts

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

Adds a list of contexts.

endProcessing

open override fun endProcessing(tracker: Tracker)

Hook method called just after the event processing in order to execute special operations.

entities

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

Adds a list of contexts.

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? = null

Name of the Activity subclass.

activityTag

var activityTag: String? = null

Tag of the Activity subclass.

contexts

open override val contexts: List<SelfDescribingJson>

customContexts

val customContexts: MutableList<SelfDescribingJson>

List of custom contexts associated with the event.

dataPayload

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

entities

open override val entities: List<SelfDescribingJson>

fragmentClassName

var fragmentClassName: String? = null

Name of the Fragment subclass.

fragmentTag

var fragmentTag: String? = null

Tag of the Fragment subclass.

val id: String

Identifier of the screen.

name

val name: String

Name of the screen.

previousId

var previousId: String? = null

Identifier of the previous screen.

previousName

var previousName: String? = null

Name of the previous screen.

previousType

var previousType: String? = null

Type of the previous screen.

schema

open override val schema: String

transitionType

var transitionType: String? = null

Type of transition between previous and current screen.

trueTimestamp

open override var trueTimestamp: Long? = null

type

var type: String? = null

Type of screen.