# EbookEntity.Builder

# EbookEntity.Builder

*** ** * ** ***

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

<br />

```
public final class EbookEntity.Builder
```

<br />

*** ** * ** ***

Builder class for[EbookEntity](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity).

## Summary

|                                                    ### Public constructors                                                     |
|--------------------------------------------------------------------------------------------------------------------------------|
| [Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#Builder())`()` |

|                                                      ### Public methods                                                      |
|------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addAllDisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#addAllDisplayTimeWindow(java.util.List<com.google.android.engage.common.datamodel.DisplayTimeWindow>))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[DisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/common/datamodel/DisplayTimeWindow)`> displayTimeWindows)` Adds the display time window for the book |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addAuthor](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#addAuthor(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` author)` Adds author of the ebook.                                                                                                                                                                                                                                              |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addAuthors](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#addAuthors(java.util.List<java.lang.String>))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`> author)` Adds the list of authors of the ebook.                                                                                                                                        |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addDisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#addDisplayTimeWindow(com.google.android.engage.common.datamodel.DisplayTimeWindow))`(`[DisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/common/datamodel/DisplayTimeWindow)` displayTimeWindow)` Adds the display time window for the book                                                                                               |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addGenre](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#addGenre(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` genre)` Adds genre of the ebook.                                                                                                                                                                                                                                                  |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addGenres](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#addGenres(java.util.List<java.lang.String>))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`> genres)` Adds genre of the ebook.                                                                                                                                                        |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImage](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#addPosterImage(com.google.android.engage.common.datamodel.Image))`(`[Image](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Image)` image)` Add a poster image of the entity.                                                                                                                                                                   |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImages](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#addPosterImages(java.util.List<com.google.android.engage.common.datamodel.Image>))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[Image](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Image)`> images)` Add poster images of the entity.                                                                          |
| [EbookEntity](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity)                 | [build](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#build())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setActionLinkUri](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setActionLinkUri(android.net.Uri))`(`[Uri](https://developer.android.com/reference/android/net/Uri.html)` actionLinkUri)` Sets the deeplink associated with the book.                                                                                                                                                                                                            |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setAvailability](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setAvailability(int))`(@`[ContentAvailability](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ContentAvailability)` int availability)` Sets the availability of the book.                                                                                                                                                                     |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setContinueBookType](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setContinueBookType(int))`(int continueBookType)` Sets a continue book type for the book.                                                                                                                                                                                                                                                                                     |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setDescription](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setDescription(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` description)` Adds the description of the ebook.                                                                                                                                                                                                                      |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setDownloadedOnDevice](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setDownloadedOnDevice(boolean))`(boolean downloadedOnDevice)` Sets a boolean value to indicate if book is downloaded on device or not.                                                                                                                                                                                                                                      |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setEntityId](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setEntityId(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` entityId)` Sets content id of the video entity.                                                                                                                                                                                                                             |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setLastEngagementTimeMillis](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setLastEngagementTimeMillis(long))`(long lastEngagementTimeMillis)` Sets last engagement time of the entity, in milliseconds since Epoch.                                                                                                                                                                                                                             |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setName](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setName(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` name)` Sets the name of the entity.                                                                                                                                                                                                                                                 |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setPageCount](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setPageCount(int))`(int pageCount)` Adds the page count of the ebook.                                                                                                                                                                                                                                                                                                                |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setPrice](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setPrice(com.google.android.engage.common.datamodel.Price))`(`[Price](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Price)` price)` Adds the price of the ebook.                                                                                                                                                                                    |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setProgressPercentComplete](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setProgressPercentComplete(int))`(int progressPercentComplete)` Sets progress percent complete of the book entity.                                                                                                                                                                                                                                                     |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setPublishDateEpochMillis](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setPublishDateEpochMillis(long))`(long publishDateEpochMillis)` Sets publishing date of the ebook, in milliseconds.                                                                                                                                                                                                                                                     |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setRating](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setRating(com.google.android.engage.common.datamodel.Rating))`(`[Rating](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Rating)` rating)` Sets the rating for the book entity.                                                                                                                                                                      |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setSeriesName](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setSeriesName(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` seriesName)` Adds the name of the series that the ebook belongs to.                                                                                                                                                                                                     |
| [EbookEntity.Builder](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setSeriesUnitIndex](https://developer.android.com/reference/com/google/android/engage/books/datamodel/EbookEntity.Builder#setSeriesUnitIndex(java.lang.Integer))`(`[Integer](https://developer.android.com/reference/java/lang/Integer.html)` seriesUnitIndex)` Adds the index number of the ebook in the series.                                                                                                                                                                                        |

## Public constructors

### Builder

```
public Builder()
```  

## Public methods

### addAllDisplayTimeWindow

```
@CanIgnoreReturnValue
public EbookEntity.Builder addAllDisplayTimeWindow(List<DisplayTimeWindow> displayTimeWindows)
```

Adds the display time window for the book

Optional.  

### addAuthor

```
@CanIgnoreReturnValue
public EbookEntity.Builder addAuthor(String author)
```

Adds author of the ebook.

Required.  

### addAuthors

```
@CanIgnoreReturnValue
public EbookEntity.Builder addAuthors(List<String> author)
```

Adds the list of authors of the ebook.

Required.  

### addDisplayTimeWindow

```
@CanIgnoreReturnValue
public EbookEntity.Builder addDisplayTimeWindow(DisplayTimeWindow displayTimeWindow)
```

Adds the display time window for the book

Optional.  

### addGenre

```
@CanIgnoreReturnValue
public EbookEntity.Builder addGenre(String genre)
```

Adds genre of the ebook.

Optional.  

### addGenres

```
@CanIgnoreReturnValue
public EbookEntity.Builder addGenres(List<String> genres)
```

Adds genre of the ebook.

Optional.  

### addPosterImage

```
@CanIgnoreReturnValue
public EbookEntity.Builder addPosterImage(Image image)
```

Add a poster image of the entity.

Required.  

### addPosterImages

```
@CanIgnoreReturnValue
public EbookEntity.Builder addPosterImages(List<Image> images)
```

Add poster images of the entity.

Required.  

### build

```
public EbookEntity build()
```  

### setActionLinkUri

```
@CanIgnoreReturnValue
public EbookEntity.Builder setActionLinkUri(Uri actionLinkUri)
```

Sets the deeplink associated with the book.

Required  

### setAvailability

```
@CanIgnoreReturnValue
public EbookEntity.Builder setAvailability(@ContentAvailability int availability)
```

Sets the availability of the book.

Optional.  

### setContinueBookType

```
@CanIgnoreReturnValue
public EbookEntity.Builder setContinueBookType(int continueBookType)
```

Sets a continue book type for the book.

Optional.  

### setDescription

```
@CanIgnoreReturnValue
public EbookEntity.Builder setDescription(String description)
```

Adds the description of the ebook.

Optional.  

### setDownloadedOnDevice

```
@CanIgnoreReturnValue
public EbookEntity.Builder setDownloadedOnDevice(boolean downloadedOnDevice)
```

Sets a boolean value to indicate if book is downloaded on device or not.

Optional.  

### setEntityId

```
@CanIgnoreReturnValue
public EbookEntity.Builder setEntityId(String entityId)
```

Sets content id of the video entity.

Optional.  

### setLastEngagementTimeMillis

```
@CanIgnoreReturnValue
public EbookEntity.Builder setLastEngagementTimeMillis(long lastEngagementTimeMillis)
```

Sets last engagement time of the entity, in milliseconds since Epoch.

Optional.  

### setName

```
@CanIgnoreReturnValue
public EbookEntity.Builder setName(String name)
```

Sets the name of the entity.

Required.  

### setPageCount

```
@CanIgnoreReturnValue
public EbookEntity.Builder setPageCount(int pageCount)
```

Adds the page count of the ebook.

Optional.  

### setPrice

```
@CanIgnoreReturnValue
public EbookEntity.Builder setPrice(Price price)
```

Adds the price of the ebook.

Optional.  

### setProgressPercentComplete

```
@CanIgnoreReturnValue
public EbookEntity.Builder setProgressPercentComplete(int progressPercentComplete)
```

Sets progress percent complete of the book entity.

Optional.  

### setPublishDateEpochMillis

```
@CanIgnoreReturnValue
public EbookEntity.Builder setPublishDateEpochMillis(long publishDateEpochMillis)
```

Sets publishing date of the ebook, in milliseconds.

Optional.  

### setRating

```
@CanIgnoreReturnValue
public EbookEntity.Builder setRating(Rating rating)
```

Sets the rating for the book entity.

Optional.  

### setSeriesName

```
@CanIgnoreReturnValue
public EbookEntity.Builder setSeriesName(String seriesName)
```

Adds the name of the series that the ebook belongs to.

Optional.  

### setSeriesUnitIndex

```
@CanIgnoreReturnValue
public EbookEntity.Builder setSeriesUnitIndex(Integer seriesUnitIndex)
```

Adds the index number of the ebook in the series.

Optional.