EventBuilders.TileInteractionEvent

@RequiresSchemaVersion(major = 1, minor = 400)
class EventBuilders.TileInteractionEvent

Event reported when a user interacts with a tile (e.g. entering or leaving a tile).

Summary

Nested types

Builder for TileInteractionEvent

Constants
const Int
ENTER = 1

User entered the tile.
const Int
LEAVE = 2

User left the tile.
const Int

Unknown type

Public functions
Int

Gets the type of the TileInteractionEvent.
Int

Gets instance ID of the tile, allocated when the tile instance is added to the carousel.
Instant

Gets the timestamp of when the interaction was reported.
String

Constants

ENTER

Added in 1.4.0-alpha03
const val ENTER = 1: Int

User entered the tile.

LEAVE

Added in 1.4.0-alpha03
const val LEAVE = 2: Int

User left the tile.

UNKNOWN

Added in 1.4.0-alpha03
const val UNKNOWN = 0: Int

Unknown type

Public functions

getEventType

Added in 1.4.0-alpha03
fun getEventType(): Int

Gets the type of the TileInteractionEvent.

getTileId

Added in 1.4.0-alpha03
fun getTileId(): Int

Gets instance ID of the tile, allocated when the tile instance is added to the carousel. This ID will remain the same for this tile instance as long it is not removed from the carousel.

getTimestamp

Added in 1.4.0-alpha03
fun getTimestamp(): Instant

Gets the timestamp of when the interaction was reported. Defaults to now (Created at the time of Builder constructor call) if not provided.

toString

fun toString(): String