# EbookEntity

# EbookEntity

*** ** * ** ***

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

<br />

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

*** ** * ** ***

An object representing an ebook.

## Summary

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

|                                                                                                                                                           ### Public functions                                                                                                                                                            |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)`!`                                                                                                                                                                                                                                                                    | [getActionLinkUri](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getActionLinkUri())`()` Returns the action link associated with the book.                                      |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                                                                                                                                                                                                                                                | [getAvailability](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getAvailability())`()`                                                                                          |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`!>!`                                                                                                                                                               | [getContinueBookType](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getContinueBookType())`()` Returns the read next type of the book.                                          |
| [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/books/datamodel/EbookEntity#getDescription())`()` Returns the description of the book series, if available                                   |
| `(`[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)`<`[DisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/DisplayTimeWindow)`!>!` | [getDisplayTimeWindows](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getDisplayTimeWindows())`()`                                                                              |
| [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/books/datamodel/EbookEntity#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)`<`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                 | [getGenres](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getGenres())`()` Returns the list of genre of the book series                                                         |
| [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)`!>!`                                                                                                                                                             | [getLastEngagementTimeMillis](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getLastEngagementTimeMillis())`()` Returns the last engagement time in milliseconds.                |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!`                                                                                                                                                                                                                                                       | [getName](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getName())`()` Returns the name of the entity.                                                                          |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`!>!`                                                                                                                                                               | [getPageCount](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getPageCount())`()` Returns the page count of the ebook, if available.                                             |
| `(`[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/books/datamodel/EbookEntity#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/books/datamodel/EbookEntity#getPrice())`()` Returns the price of the ebook, if available.                                                          |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`!>!`                                                                                                                                                               | [getProgressPercentComplete](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getProgressPercentComplete())`()` Returns the percentage progress completed.                         |
| [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)`!>!`                                                                                                                                                             | [getPublishDateEpochMillis](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getPublishDateEpochMillis())`()` Returns the publishing date associated with the ebook, if available. |
| [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/books/datamodel/EbookEntity#getRating())`()`                                                                                                      |
| [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)`!>!`                                                                                                                                                         | [getSeriesName](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getSeriesName())`()` Returns the name of the series that the ebook belongs to                                     |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`!>!`                                                                                                                                                               | [getSeriesUnitIndex](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#getSeriesUnitIndex())`()` Returns the index value of the ebook in the book series                            |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)                                                                                                                                                                                                                                                        | [isDownloadedOnDevice](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#isDownloadedOnDevice())`()`                                                                                |

|                                                                                                                                   ### Public properties                                                                                                                                   |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `(`[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)`!>!` | [authors](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/EbookEntity#authors()) |

|                                                                                                                                                                                                                                                                                         ### 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

### getActionLinkUri

```
fun getActionLinkUri(): Uri!
```

Returns the action link associated with the book.  

### getAvailability

```
fun getAvailability(): Int
```  

### getContinueBookType

```
fun getContinueBookType(): Optional<Int!>!
```

Returns the read next type of the book.  

### getDescription

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

Returns the description of the book series, if available  

### getDisplayTimeWindows

```
fun getDisplayTimeWindows(): (Mutable)List<DisplayTimeWindow!>!
```  

### getEntityId

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

Returns the id of the entity.  

### getGenres

```
fun getGenres(): (Mutable)List<String!>!
```

Returns the list of genre of the book series  

### getLastEngagementTimeMillis

```
fun getLastEngagementTimeMillis(): Optional<Long!>!
```

Returns the last engagement time in milliseconds.  

### getName

```
fun getName(): String!
```

Returns the name of the entity.  

### getPageCount

```
fun getPageCount(): Optional<Int!>!
```

Returns the page count of the ebook, if available.  

### getPosterImages

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

Returns the poster image of the entity.  

### getPrice

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

Returns the price of the ebook, if available.  

### getProgressPercentComplete

```
fun getProgressPercentComplete(): Optional<Int!>!
```

Returns the percentage progress completed.  

### getPublishDateEpochMillis

```
fun getPublishDateEpochMillis(): Optional<Long!>!
```

Returns the publishing date associated with the ebook, if available.  

### getRating

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

### getSeriesName

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

Returns the name of the series that the ebook belongs to  

### getSeriesUnitIndex

```
fun getSeriesUnitIndex(): Optional<Int!>!
```

Returns the index value of the ebook in the book series  

### isDownloadedOnDevice

```
fun isDownloadedOnDevice(): Boolean
```  

## Public properties

### authors

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