EventEntity

Kotlin |Java

class EventEntity : Entity

kotlin.Any
↳	com.google.android.engage.common.datamodel.Entity
	↳	com.google.android.engage.travel.datamodel.EventEntity

An object representing an Event Entity.

Summary

Nested types
`class EventEntity.Builder` Builder class for `EventEntity`.
`@IntDef(value = [EligibleContentCategory.TYPE_EDUCATION, EligibleContentCategory.TYPE_SPORTS, EligibleContentCategory.TYPE_MOVIES_AND_TV_SHOWS, EligibleContentCategory.TYPE_MUSIC, EligibleContentCategory.TYPE_DIGITAL_GAMES, EligibleContentCategory.TYPE_TRAVEL_AND_LOCAL, EligibleContentCategory.TYPE_HEALTH_AND_FITNESS, EligibleContentCategory.TYPE_DATING]) @Retention(value = RetentionPolicy.SOURCE) annotation EventEntity.EligibleContentCategory` Possible content categories of the event entity.

Nested types

class EventEntity.Builder

Builder class for EventEntity.

@IntDef(value = [EligibleContentCategory.TYPE_EDUCATION, EligibleContentCategory.TYPE_SPORTS, EligibleContentCategory.TYPE_MOVIES_AND_TV_SHOWS, EligibleContentCategory.TYPE_MUSIC, EligibleContentCategory.TYPE_DIGITAL_GAMES, EligibleContentCategory.TYPE_TRAVEL_AND_LOCAL, EligibleContentCategory.TYPE_HEALTH_AND_FITNESS, EligibleContentCategory.TYPE_DATING])
@Retention(value = RetentionPolicy.SOURCE)
annotation EventEntity.EligibleContentCategory

Possible content categories of the event entity.

Public functions
`(Mutable)List<Badge!>!`	`getBadgeList()` Returns the list of badges (image/text) for the event entity. e.g. “Onsale".
`(Mutable)List<Int!>!`	`getContentCategoryList()` Returns the content categories of the event entity.
`Optional<String!>!`	`getDescription()` Returns the description (typically a single paragraph of text) for the event entity.
`Optional<Long!>!`	`getEndTime()` This function is deprecated. use `getLocalizedEndTime` instead
`Optional<String!>!`	`getEntityId()` Returns the id of the entity.
`Optional<LocalizedTimestamp!>!`	`getLocalizedEndTime()` Returns the localized timestamp for the event end time.
`Optional<Address!>!`	`getLocation()` Returns the location/address of the event entity.
`(Mutable)List<Image!>!`	`getPosterImages()` Returns the poster image of the entity.
`Optional<Price!>!`	`getPrice()` Returns the price of the event entity.
`Optional<String!>!`	`getPriceCallout()` Returns the price callout for the event entity. e.g. “Limited offer"
`(Mutable)List<String!>!`	`getSubtitleList()` Returns the list of subtitles for the event entity. e.g. "Over 50M users watched Hamilton already", "4 sessions every Monday”.

Public properties
`Uri!`	`actionLinkUri`
`ImmutableList<DisplayTimeWindow!>!`	`displayTimeWindows`
`Int`	`@EventMode eventMode`
`LocalizedTimestamp!`	`localizedStartTime`
`Long!`	`startTime` This property is deprecated. Use `localizedStartTime` instead.
`String!`	`title`

Inherited functions

From com.google.android.engage.common.datamodel.Entity

Int

getEntityType()

Public functions

getBadgeList

fun getBadgeList(): (Mutable)List<Badge!>!

Returns the list of badges (image/text) for the event entity. e.g. “Onsale".

getContentCategoryList

fun getContentCategoryList(): (Mutable)List<Int!>!

Returns the content categories of the event entity.

getDescription

fun getDescription(): Optional<String!>!

Returns the description (typically a single paragraph of text) for the event entity.

getEndTime

fun getEndTime(): Optional<Long!>!

Returns the epoch timestamp (in milliseconds) for the event end time.

getEntityId

fun getEntityId(): Optional<String!>!

Returns the id of the entity.

getLocalizedEndTime

fun getLocalizedEndTime(): Optional<LocalizedTimestamp!>!

Returns the localized timestamp for the event end time.

getLocation

fun getLocation(): Optional<Address!>!

Returns the location/address of the event entity.

getPosterImages

fun getPosterImages(): (Mutable)List<Image!>!

Returns the poster image of the entity.

getPrice

fun getPrice(): Optional<Price!>!

Returns the price of the event entity.

getPriceCallout

fun getPriceCallout(): Optional<String!>!

Returns the price callout for the event entity. e.g. “Limited offer"

getSubtitleList

fun getSubtitleList(): (Mutable)List<String!>!

Returns the list of subtitles for the event entity. e.g. "Over 50M users watched Hamilton already", "4 sessions every Monday”.

Public properties

actionLinkUri

val actionLinkUri: Uri!

displayTimeWindows

val displayTimeWindows: ImmutableList<DisplayTimeWindow!>!

eventMode

@EventMode
val eventMode: Int

localizedStartTime

val localizedStartTime: LocalizedTimestamp!

startTime

val startTime: Long!

title

val title: String!