EventBuilders.TileInteractionEvent

@RequiresSchemaVersion(major = 1, minor = 400)
public final 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
static final int
ENTER = 1

User entered the tile.
static final int
LEAVE = 2

User left the tile.
static final int

Unknown type

Public methods
int

Gets the type of the TileInteractionEvent.
int

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

Gets the timestamp of when the interaction was reported.
@NonNull String

Constants

ENTER

Added in 1.4.0-alpha03
public static final int ENTER = 1

User entered the tile.

LEAVE

Added in 1.4.0-alpha03
public static final int LEAVE = 2

User left the tile.

UNKNOWN

Added in 1.4.0-alpha03
public static final int UNKNOWN = 0

Unknown type

Public methods

getEventType

Added in 1.4.0-alpha03
public int getEventType()

Gets the type of the TileInteractionEvent.

getTileId

Added in 1.4.0-alpha03
public int getTileId()

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
public @NonNull Instant getTimestamp()

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

toString

public @NonNull String toString()