# EventEntity

# EventEntity

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/com/google/android/engage/travel/datamodel/EventEntity "View this page in Java")  

<br />

```
class EventEntity : Entity
```

<br />

|---|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                     |||
| ↳ | [com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)              ||
|   | ↳ | [com.google.android.engage.travel.datamodel.EventEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity) |

*** ** * ** ***

An object representing an Event Entity.

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                                   ### Nested types                                                                                                                                                                                                                                                                                                                                                                                                    |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[EventEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity.Builder) Builder class for[EventEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `@`[IntDef](https://developer.android.com/reference/androidx/annotation/IntDef.html)`(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](https://developer.android.com/reference/java/lang/annotation/Retention.html)`(value = RetentionPolicy.SOURCE)` `annotation `[EventEntity.EligibleContentCategory](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity.EligibleContentCategory) Possible content categories of the event entity. |

|                                                                                                                                               ### Public functions                                                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[Badge](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Badge)`!>!` | [getBadgeList](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getBadgeList())`()` Returns the list of badges (image/text) for the event entity. e.g. "Onsale".                                                                                                                         |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`!>!`                               | [getContentCategoryList](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getContentCategoryList())`()` Returns the content categories of the event entity.                                                                                                                              |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getDescription](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getDescription())`()` Returns the description (typically a single paragraph of text) for the event entity.                                                                                                             |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`!>!`                                                                                                                                     | ~~[getEndTime](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getEndTime())~~`()` **This function is deprecated.** use[getLocalizedEndTime](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getLocalizedEndTime())instead <br /> |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getEntityId](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getEntityId())`()` Returns the id of the entity.                                                                                                                                                                          |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[LocalizedTimestamp](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/LocalizedTimestamp)`!>!`                                                                               | [getLocalizedEndTime](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getLocalizedEndTime())`()` Returns the localized timestamp for the event end time.                                                                                                                                |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Address](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Address)`!>!`                                                                                                     | [getLocation](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getLocation())`()` Returns the location/address of the event entity.                                                                                                                                                      |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[Image](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Image)`!>!` | [getPosterImages](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getPosterImages())`()` Returns the poster image of the entity.                                                                                                                                                        |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Price](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Price)`!>!`                                                                                                         | [getPrice](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getPrice())`()` Returns the price of the event entity.                                                                                                                                                                       |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getPriceCallout](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getPriceCallout())`()` Returns the price callout for the event entity. e.g. "Limited offer"                                                                                                                           |
| `(`[Mutable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                         | [getSubtitleList](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#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](https://developer.android.com/reference/android/net/Uri.html)`!`                                                                                                                                                                         | [actionLinkUri](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#actionLinkUri())                                                                                                                                                                                             |
| [ImmutableList](https://guava.dev/releases/21.0/api/docs/com/google/common/collect/ImmutableList.html)`<`[DisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/DisplayTimeWindow)`!>!` | [displayTimeWindows](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#displayTimeWindows())                                                                                                                                                                                   |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                                                                                                                                                     | `@`[EventMode](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventMode) [eventMode](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#eventMode())                                                                                 |
| [LocalizedTimestamp](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/LocalizedTimestamp)`!`                                                                                                          | [localizedStartTime](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#localizedStartTime())                                                                                                                                                                                   |
| [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`!`                                                                                                                                                                | [startTime](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#startTime()) **This property is deprecated.** Use[localizedStartTime](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#localizedStartTime())instead. <br /> |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!`                                                                                                                                                            | [title](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#title())                                                                                                                                                                                                             |

|                                                                                                                                                                                                                                                                                         ### Inherited functions                                                                                                                                                                                                                                                                                         |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity) |----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getEntityType](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity#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](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getEndTime())(): Optional<Long!>!
```
| **This function is deprecated.**   
|
| use[getLocalizedEndTime](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#getLocalizedEndTime())instead

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!
```
| **This property is deprecated.**   
|
Use[localizedStartTime](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/EventEntity#localizedStartTime())instead.  

### title

```
val title: String!
```