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

Package-level declarations

Different types of events that can be tracked with Snowplow.

Types

Base AbstractEvent class which contains common elements that can be added to all events:

abstract class AbstractPrimitive : AbstractEvent

Abstract class which contains common elements to all "primitive" events, i.e. events that are not based on a schema, such as Structured events.

AbstractSelfDescribing

abstract class AbstractSelfDescribing : AbstractEvent

Abstract class which contains common elements to all self-describing events, i.e. events that are based on a schema. Examples include SelfDescribing, ScreenView, and Foreground events.

Background

class Background : AbstractSelfDescribing

A background transition event.

ConsentDocument

class ConsentDocument(documentId: String, documentVersion: String) : AbstractSelfDescribing

A consent document event.

ConsentGranted

class ConsentGranted(expiry: String, documentId: String, documentVersion: String) : AbstractSelfDescribing

A consent granted event.

ConsentWithdrawn

class ConsentWithdrawn(all: Boolean, documentId: String, documentVersion: String) : AbstractSelfDescribing

A consent withdrawn event.

DeepLinkReceived

class DeepLinkReceived(val url: String) : AbstractSelfDescribing

A deep-link received in the app.

EcommerceTransaction

class ~~EcommerceTransaction~~(orderId: String, totalValue: Double, items: List<EcommerceTransactionItem>) : AbstractPrimitive

An ecommerce event.

EcommerceTransactionItem

class ~~EcommerceTransactionItem~~(sku: String, price: Double, quantity: Int) : AbstractPrimitive

An ecommerce item event.

Event

interface Event

The Event interface

Foreground

class Foreground : AbstractSelfDescribing

A foreground transition event.

ListItemView

class ListItemView(var index: Int, var itemsCount: Int?) : AbstractSelfDescribing

Event tracking the view of an item in a list. If screen engagement tracking is enabled, the list item view events will be aggregated into a screen_summary entity and won't be sent as separate events to the collector.

MessageNotification

class MessageNotification(val title: String, val body: String, val trigger: MessageNotificationTrigger) : AbstractSelfDescribing

Event that represents the reception of a push notification (or a locally generated one).

MessageNotificationAttachment

class MessageNotificationAttachment(identifier: String, type: String, url: String) : HashMap<String, Any>

Attachment object that identifies an attachment in the MessageNotification.

MessageNotificationTrigger

enum MessageNotificationTrigger : Enum<MessageNotificationTrigger>

Trigger that caused the message notification.

PageView

class PageView(pageUrl: String) : AbstractPrimitive

A PageView event. This event has been designed for web trackers, and is not suitable for mobile apps.

ScreenEnd

class ScreenEnd : AbstractSelfDescribing

ScreenView

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

A ScreenView event.

ScrollChanged

class ScrollChanged(var yOffset: Int? = null, var xOffset: Int? = null, var viewWidth: Int? = null, var viewHeight: Int? = null, var contentWidth: Int? = null, var contentHeight: Int? = null) : AbstractSelfDescribing

Event tracked when a scroll view's scroll position changes. If screen engagement tracking is enabled, the scroll changed events will be aggregated into a screen_summary entity and won't be sent as separate events to the collector.

SelfDescribing

class SelfDescribing : AbstractSelfDescribing

A SelfDescribing event.

Structured

class Structured(category: String, action: String) : AbstractPrimitive

A Structured event.

Timing

class Timing(category: String, variable: String, timing: Int) : AbstractSelfDescribing

A timing event.

TrackerError

class TrackerError(source: String, message: String, throwable: Throwable? = null) : AbstractSelfDescribing

An error event representing an exception, error or warning message in the app.