AnalyticsEvent


abstract class AnalyticsEvent

Known direct subclasses
BrowseChangeEvent

Describes a browse node change event.

ErrorEvent

Analytics event indicating a parsing error.

MediaClickedEvent

Describes a media clicked event.

ViewChangeEvent

Describes a view entry or exit event.

VisibleItemsEvent

Describes a visible items event.


Base class for Analytics events.

Summary

Constants

const Int

Indicates BrowseChangeEvent

const Int

Indicates ErrorEvent

const Int

Indicates MediaClickedEvent

const Int

Indicates an unknown event

const Int

Indicates ViewChangeEvent

const Int

Indicates VisibleItemsEvent

const Int

Indicates view was hidden

const Int

Indicates view action mode is default/none

const Int

Indicates view action mode is from a scroll

const Int

Indicates view was shown

const Int

Indicates event generated from Browse Action Overflow view component

const Int

Indicates event generated from Browse List view component

const Int

Indicates event generated from Browse Tabs view component

const Int

Indicates event generated from Error Message view component

const Int

Indicates event generated from Launcher view component

const Int

Indicates event generated from Media Host view component

const Int

Indicates event generated from Mini Playback view component

const Int

Indicates event generated from Playback view component

const Int

Indicates event generated from Queue List view component

const Int

Indicates event generated from Settings view component

const Int

Indicates event generated from an Unknown view component

Public functions

Int

Returns the analytics version.

String

Returns the platform component that is generating analytic events.

Int

Returns the EventType.

Long

Returns the time of the event in milliseconds since 1970-01-01T00:00:00Z.

String

Constants

EVENT_TYPE_BROWSE_NODE_CHANGED_EVENT

Added in 1.7.0-beta03
const val EVENT_TYPE_BROWSE_NODE_CHANGED_EVENT = 3: Int

Indicates BrowseChangeEvent

EVENT_TYPE_ERROR_EVENT

Added in 1.7.0-beta03
const val EVENT_TYPE_ERROR_EVENT = 5: Int

Indicates ErrorEvent

EVENT_TYPE_MEDIA_CLICKED_EVENT

Added in 1.7.0-beta03
const val EVENT_TYPE_MEDIA_CLICKED_EVENT = 2: Int

Indicates MediaClickedEvent

EVENT_TYPE_UNKNOWN_EVENT

Added in 1.7.0-beta03
const val EVENT_TYPE_UNKNOWN_EVENT = 0: Int

Indicates an unknown event

EVENT_TYPE_VIEW_CHANGE_EVENT

Added in 1.7.0-beta03
const val EVENT_TYPE_VIEW_CHANGE_EVENT = 4: Int

Indicates ViewChangeEvent

EVENT_TYPE_VISIBLE_ITEMS_EVENT

Added in 1.7.0-beta03
const val EVENT_TYPE_VISIBLE_ITEMS_EVENT = 1: Int

Indicates VisibleItemsEvent

VIEW_ACTION_HIDE

Added in 1.7.0-beta03
const val VIEW_ACTION_HIDE = 0: Int

Indicates view was hidden

VIEW_ACTION_MODE_NONE

Added in 1.7.0-beta03
const val VIEW_ACTION_MODE_NONE = 0: Int

Indicates view action mode is default/none

VIEW_ACTION_MODE_SCROLL

Added in 1.7.0-beta03
const val VIEW_ACTION_MODE_SCROLL = 1: Int

Indicates view action mode is from a scroll

VIEW_ACTION_SHOW

Added in 1.7.0-beta03
const val VIEW_ACTION_SHOW = 1: Int

Indicates view was shown

VIEW_COMPONENT_BROWSE_ACTION_OVERFLOW

Added in 1.7.0-beta03
const val VIEW_COMPONENT_BROWSE_ACTION_OVERFLOW = 8: Int

Indicates event generated from Browse Action Overflow view component

VIEW_COMPONENT_BROWSE_LIST

Added in 1.7.0-beta03
const val VIEW_COMPONENT_BROWSE_LIST = 1: Int

Indicates event generated from Browse List view component

VIEW_COMPONENT_BROWSE_TABS

Added in 1.7.0-beta03
const val VIEW_COMPONENT_BROWSE_TABS = 2: Int

Indicates event generated from Browse Tabs view component

VIEW_COMPONENT_ERROR_MESSAGE

Added in 1.7.0-beta03
const val VIEW_COMPONENT_ERROR_MESSAGE = 10: Int

Indicates event generated from Error Message view component

VIEW_COMPONENT_LAUNCHER

Added in 1.7.0-beta03
const val VIEW_COMPONENT_LAUNCHER = 6: Int

Indicates event generated from Launcher view component

VIEW_COMPONENT_MEDIA_HOST

Added in 1.7.0-beta03
const val VIEW_COMPONENT_MEDIA_HOST = 9: Int

Indicates event generated from Media Host view component

VIEW_COMPONENT_MINI_PLAYBACK

Added in 1.7.0-beta03
const val VIEW_COMPONENT_MINI_PLAYBACK = 5: Int

Indicates event generated from Mini Playback view component

VIEW_COMPONENT_PLAYBACK

Added in 1.7.0-beta03
const val VIEW_COMPONENT_PLAYBACK = 4: Int

Indicates event generated from Playback view component

VIEW_COMPONENT_QUEUE_LIST

Added in 1.7.0-beta03
const val VIEW_COMPONENT_QUEUE_LIST = 3: Int

Indicates event generated from Queue List view component

VIEW_COMPONENT_SETTINGS_VIEW

Added in 1.7.0-beta03
const val VIEW_COMPONENT_SETTINGS_VIEW = 7: Int

Indicates event generated from Settings view component

VIEW_COMPONENT_UNKNOWN_COMPONENT

Added in 1.7.0-beta03
const val VIEW_COMPONENT_UNKNOWN_COMPONENT = 0: Int

Indicates event generated from an Unknown view component

Public functions

getAnalyticsVersion

Added in 1.7.0-beta03
fun getAnalyticsVersion(): Int

Returns the analytics version.

getComponent

Added in 1.7.0-beta03
fun getComponent(): String

Returns the platform component that is generating analytic events.

Returns
String

component of platform that is sending events.

getEventType

Added in 1.7.0-beta03
fun getEventType(): Int

Returns the EventType.

Returns
Int

event type

getTimestampMillis

Added in 1.7.0-beta03
fun getTimestampMillis(): Long

Returns the time of the event in milliseconds since 1970-01-01T00:00:00Z.

toString

fun toString(): String