# EbookEntity

# EbookEntity

*** ** * ** ***

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

<br />

```
public final class EbookEntity extends Entity
```

<br />

|---|---|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html)                                                                            |||
| ↳ | [com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Entity)            ||
|   | ↳ | [com.google.android.engage.books.datamodel.EbookEntity](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity) |

*** ** * ** ***

An object representing an ebook.

## Summary

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

|                                                                    ### Public fields                                                                     |
|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| `final `[List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>` | [authors](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#authors()) |

|                                                                                         ### Public methods                                                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)                                                                                                                                | [getActionLinkUri](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#getActionLinkUri())`()` Returns the action link associated with the book.                                      |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>`                                                   | [getAuthors](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#getAuthors())`()` Returns the list of authors of the ebook.                                                          |
| `int`                                                                                                                                                                                              | [getAvailability](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#getAvailability())`()`                                                                                          |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Integer](https://developer.android.com/reference/java/lang/Integer.html)`>`                           | [getContinueBookType](https://developer.android.com/reference/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://developer.android.com/reference/java/lang/String.html)`>`                             | [getDescription](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#getDescription())`()` Returns the description of the book series, if available                                   |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[DisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/common/datamodel/DisplayTimeWindow)`>` | [getDisplayTimeWindows](https://developer.android.com/reference/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://developer.android.com/reference/java/lang/String.html)`>`                             | [getEntityId](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#getEntityId())`()` Returns the id of the entity.                                                                    |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>`                                                   | [getGenres](https://developer.android.com/reference/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://developer.android.com/reference/java/lang/Long.html)`>`                                 | [getLastEngagementTimeMillis](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#getLastEngagementTimeMillis())`()` Returns the last engagement time in milliseconds.                |
| [String](https://developer.android.com/reference/java/lang/String.html)                                                                                                                            | [getName](https://developer.android.com/reference/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)`<`[Integer](https://developer.android.com/reference/java/lang/Integer.html)`>`                           | [getPageCount](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#getPageCount())`()` Returns the page count of the ebook, if available.                                             |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[Image](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Image)`>`                         | [getPosterImages](https://developer.android.com/reference/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/com/google/android/engage/common/datamodel/Price)`>`   | [getPrice](https://developer.android.com/reference/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)`<`[Integer](https://developer.android.com/reference/java/lang/Integer.html)`>`                           | [getProgressPercentComplete](https://developer.android.com/reference/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://developer.android.com/reference/java/lang/Long.html)`>`                                 | [getPublishDateEpochMillis](https://developer.android.com/reference/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/com/google/android/engage/common/datamodel/Rating)`>` | [getRating](https://developer.android.com/reference/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://developer.android.com/reference/java/lang/String.html)`>`                             | [getSeriesName](https://developer.android.com/reference/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)`<`[Integer](https://developer.android.com/reference/java/lang/Integer.html)`>`                           | [getSeriesUnitIndex](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#getSeriesUnitIndex())`()` Returns the index value of the ebook in the book series                            |
| `boolean`                                                                                                                                                                                          | [isDownloadedOnDevice](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity#isDownloadedOnDevice())`()`                                                                                |

|                                                                                                                                                                                                          ### Inherited methods                                                                                                                                                                                                           |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Entity) |-------|--------------------------------------------------------------------------------------------------------------------------------| | `int` | [getEntityType](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Entity#getEntityType())`()` | |

## Public fields

### authors

```
public final List<String> authors
```  

## Public methods

### getActionLinkUri

```
public Uri getActionLinkUri()
```

Returns the action link associated with the book.  

### getAuthors

```
public List<String> getAuthors()
```

Returns the list of authors of the ebook.  

### getAvailability

```
public int getAvailability()
```  

### getContinueBookType

```
public Optional<Integer> getContinueBookType()
```

Returns the read next type of the book.  

### getDescription

```
public Optional<String> getDescription()
```

Returns the description of the book series, if available  

### getDisplayTimeWindows

```
public List<DisplayTimeWindow> getDisplayTimeWindows()
```  

### getEntityId

```
public Optional<String> getEntityId()
```

Returns the id of the entity.  

### getGenres

```
public List<String> getGenres()
```

Returns the list of genre of the book series  

### getLastEngagementTimeMillis

```
public Optional<Long> getLastEngagementTimeMillis()
```

Returns the last engagement time in milliseconds.  

### getName

```
public String getName()
```

Returns the name of the entity.  

### getPageCount

```
public Optional<Integer> getPageCount()
```

Returns the page count of the ebook, if available.  

### getPosterImages

```
public List<Image> getPosterImages()
```

Returns the poster image of the entity.  

### getPrice

```
public Optional<Price> getPrice()
```

Returns the price of the ebook, if available.  

### getProgressPercentComplete

```
public Optional<Integer> getProgressPercentComplete()
```

Returns the percentage progress completed.  

### getPublishDateEpochMillis

```
public Optional<Long> getPublishDateEpochMillis()
```

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

### getRating

```
public Optional<Rating> getRating()
```  

### getSeriesName

```
public Optional<String> getSeriesName()
```

Returns the name of the series that the ebook belongs to  

### getSeriesUnitIndex

```
public Optional<Integer> getSeriesUnitIndex()
```

Returns the index value of the ebook in the book series  

### isDownloadedOnDevice

```
public boolean isDownloadedOnDevice()
```