# LodgingEntity

# LodgingEntity

*** ** * ** ***

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

<br />

```
class LodgingEntity : 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.LodgingEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity) |

*** ** * ** ***

An object representing a Lodging Entity.

## Summary

|                                                                                                                                      ### Nested types                                                                                                                                       |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[LodgingEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity.Builder) Builder class for[LodgingEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity). |

|                                                                                                                                               ### Public functions                                                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[AvailabilityTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/AvailabilityTimeWindow)`!>!`                                                                       | [getAvailabilityTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity#getAvailabilityTimeWindow())`()` Returns availability time window for the lodging 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/LodgingEntity#getDescription())`()` Returns the description (typically a single paragraph of text) for the lodging 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)`!>!`                                                                                                                                 | [getEntityId](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity#getEntityId())`()` Returns the id of the 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/LodgingEntity#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/LodgingEntity#getPrice())`()` Returns the price of the lodging 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/LodgingEntity#getPriceCallout())`()` Returns the price callout for the lodging entity. e.g. "Limited offer"               |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Rating](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Rating)`!>!`                                                                                                       | [getRating](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity#getRating())`()` Returns the rating of the lodging entity.                                                        |

|                                                                                                                                               ### 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/LodgingEntity#actionLinkUri())           |
| `(`[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)`!>!` | [badgeList](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity#badgeList())                   |
| [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/LodgingEntity#displayTimeWindows()) |
| [Address](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Address)`!`                                                                                                                                                                                                   | [location](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity#location())                     |
| `(`[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)`!>!`                         | [subtitleList](https://developer.android.com/reference/kotlin/com/google/android/engage/travel/datamodel/LodgingEntity#subtitleList())             |
| [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/LodgingEntity#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

### getAvailabilityTimeWindow

```
fun getAvailabilityTimeWindow(): Optional<AvailabilityTimeWindow!>!
```

Returns availability time window for the lodging entity.

This can refer to time the lodging entity is opened for the day/dates between which the lodging is available.  

### getDescription

```
fun getDescription(): Optional<String!>!
```

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

### getEntityId

```
fun getEntityId(): Optional<String!>!
```

Returns the id of the entity.  

### getPosterImages

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

Returns the poster image of the entity.  

### getPrice

```
fun getPrice(): Optional<Price!>!
```

Returns the price of the lodging entity.  

### getPriceCallout

```
fun getPriceCallout(): Optional<String!>!
```

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

### getRating

```
fun getRating(): Optional<Rating!>!
```

Returns the rating of the lodging entity.  

## Public properties

### actionLinkUri

```
val actionLinkUri: Uri!
```  

### badgeList

```
val badgeList: (Mutable)List<Badge!>!
```  

### displayTimeWindows

```
val displayTimeWindows: ImmutableList<DisplayTimeWindow!>!
```  

### location

```
val location: Address!
```  

### subtitleList

```
val subtitleList: (Mutable)List<String!>!
```  

### title

```
val title: String!
```