# BookSeriesEntity.Builder

# BookSeriesEntity.Builder

*** ** * ** ***

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

<br />

```
class BookSeriesEntity.Builder
```

<br />

*** ** * ** ***

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

## Summary

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

|                                                               ### Public functions                                                               |
|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addAllDisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#addAllDisplayTimeWindow(java.util.List<com.google.android.engage.common.datamodel.DisplayTimeWindow>))`(` ` displayTimeWindows: (`[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)`!>!` `)` Adds the display time window for the book |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addAuthor](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#addAuthor(java.lang.String))`(author: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Adds the author of the book series.                                                                                                                                                                                                                                                                                                                                                                      |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addAuthors](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#addAuthors(java.util.List<java.lang.String>))`(authors: (`[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)`!>!)` Adds the list of authors of the book series.                                                                                                                                      |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addDisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#addDisplayTimeWindow(com.google.android.engage.common.datamodel.DisplayTimeWindow))`(displayTimeWindow: `[DisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/DisplayTimeWindow)`!)` Adds the display time window for the book                                                                                                                                                                                                                                   |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addGenre](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#addGenre(java.lang.String))`(genre: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Adds the genre of the book series.                                                                                                                                                                                                                                                                                                                                                                          |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addGenres](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#addGenres(java.util.List<java.lang.String>))`(genres: (`[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)`!>!)` Adds the genre of the book series.                                                                                                                                                   |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImage](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#addPosterImage(com.google.android.engage.common.datamodel.Image))`(image: `[Image](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Image)`!)` Add a poster image of the entity.                                                                                                                                                                                                                                                                                                       |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImages](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#addPosterImages(java.util.List<com.google.android.engage.common.datamodel.Image>))`(images: (`[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)`!>!)` Add poster images of the entity.                                                                                 |
| [BookSeriesEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity)`!`                 | [build](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#build())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setActionLinkUri](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setActionLinkUri(android.net.Uri))`(actionLinkUri: `[Uri](https://developer.android.com/reference/android/net/Uri.html)`!)` Sets the deeplink associated with the book.                                                                                                                                                                                                                                                                                                                                                       |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setAvailability](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setAvailability(int))`(@`[ContentAvailability](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ContentAvailability)` availability: `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the availability of the book.                                                                                                                                                                                                                                 |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setBookCount](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setBookCount(int))`(bookCount: `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets the deeplink associated with the book series.                                                                                                                                                                                                                                                                                                                                                                  |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setContinueBookType](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setContinueBookType(int))`(continueBookType: `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets a continue book type for the book.                                                                                                                                                                                                                                                                                                                                                        |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setDescription](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setDescription(java.lang.String))`(description: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Adds the description of the audiobook.                                                                                                                                                                                                                                                                                                                                                    |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setDownloadedOnDevice](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setDownloadedOnDevice(boolean))`(downloadedOnDevice: `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Sets a boolean value to indicate if book is downloaded on device or not.                                                                                                                                                                                                                                                                                                     |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setEntityId](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setEntityId(java.lang.String))`(entityId: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Sets content id of the entity.                                                                                                                                                                                                                                                                                                                                                                     |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setLastEngagementTimeMillis](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setLastEngagementTimeMillis(long))`(lastEngagementTimeMillis: `[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`)` Sets last engagement time of the entity, in milliseconds since Epoch.                                                                                                                                                                                                                                                                                               |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setName](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setName(java.lang.String))`(name: `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!)` Sets the name of the entity.                                                                                                                                                                                                                                                                                                                                                                                   |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setProgressPercentComplete](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setProgressPercentComplete(int))`(progressPercentComplete: `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Sets progress percent complete of the book entity.                                                                                                                                                                                                                                                                                                                        |
| [BookSeriesEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder)`!` | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setRating](https://developer.android.com/reference/kotlin/com/google/android/engage/books/datamodel/BookSeriesEntity.Builder#setRating(com.google.android.engage.common.datamodel.Rating))`(rating: `[Rating](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Rating)`!)` Sets the rating for the book entity.                                                                                                                                                                                                                                                                                                          |

## Public constructors

### Builder

```
Builder()
```  

## Public functions

### addAllDisplayTimeWindow

```
@CanIgnoreReturnValue
fun addAllDisplayTimeWindow(
    displayTimeWindows: (Mutable)List<DisplayTimeWindow!>!
): BookSeriesEntity.Builder!
```

Adds the display time window for the book

Optional.  

### addAuthor

```
@CanIgnoreReturnValue
fun addAuthor(author: String!): BookSeriesEntity.Builder!
```

Adds the author of the book series.

Required.  

### addAuthors

```
@CanIgnoreReturnValue
fun addAuthors(authors: (Mutable)List<String!>!): BookSeriesEntity.Builder!
```

Adds the list of authors of the book series.

Required  

### addDisplayTimeWindow

```
@CanIgnoreReturnValue
fun addDisplayTimeWindow(displayTimeWindow: DisplayTimeWindow!): BookSeriesEntity.Builder!
```

Adds the display time window for the book

Optional.  

### addGenre

```
@CanIgnoreReturnValue
fun addGenre(genre: String!): BookSeriesEntity.Builder!
```

Adds the genre of the book series.

Optional.  

### addGenres

```
@CanIgnoreReturnValue
fun addGenres(genres: (Mutable)List<String!>!): BookSeriesEntity.Builder!
```

Adds the genre of the book series.

Optional.  

### addPosterImage

```
@CanIgnoreReturnValue
fun addPosterImage(image: Image!): BookSeriesEntity.Builder!
```

Add a poster image of the entity.

Required.  

### addPosterImages

```
@CanIgnoreReturnValue
fun addPosterImages(images: (Mutable)List<Image!>!): BookSeriesEntity.Builder!
```

Add poster images of the entity.

Required.  

### build

```
fun build(): BookSeriesEntity!
```  

### setActionLinkUri

```
@CanIgnoreReturnValue
fun setActionLinkUri(actionLinkUri: Uri!): BookSeriesEntity.Builder!
```

Sets the deeplink associated with the book.

Required  

### setAvailability

```
@CanIgnoreReturnValue
fun setAvailability(@ContentAvailability availability: Int): BookSeriesEntity.Builder!
```

Sets the availability of the book.

Optional.  

### setBookCount

```
@CanIgnoreReturnValue
fun setBookCount(bookCount: Int): BookSeriesEntity.Builder!
```

Sets the deeplink associated with the book series.

Required  

### setContinueBookType

```
@CanIgnoreReturnValue
fun setContinueBookType(continueBookType: Int): BookSeriesEntity.Builder!
```

Sets a continue book type for the book.

Optional.  

### setDescription

```
@CanIgnoreReturnValue
fun setDescription(description: String!): BookSeriesEntity.Builder!
```

Adds the description of the audiobook.

Optional.  

### setDownloadedOnDevice

```
@CanIgnoreReturnValue
fun setDownloadedOnDevice(downloadedOnDevice: Boolean): BookSeriesEntity.Builder!
```

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

Optional.  

### setEntityId

```
@CanIgnoreReturnValue
fun setEntityId(entityId: String!): BookSeriesEntity.Builder!
```

Sets content id of the entity.

Optional.  

### setLastEngagementTimeMillis

```
@CanIgnoreReturnValue
fun setLastEngagementTimeMillis(lastEngagementTimeMillis: Long): BookSeriesEntity.Builder!
```

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

Optional.  

### setName

```
@CanIgnoreReturnValue
fun setName(name: String!): BookSeriesEntity.Builder!
```

Sets the name of the entity.

Required.  

### setProgressPercentComplete

```
@CanIgnoreReturnValue
fun setProgressPercentComplete(progressPercentComplete: Int): BookSeriesEntity.Builder!
```

Sets progress percent complete of the book entity.

Optional.  

### setRating

```
@CanIgnoreReturnValue
fun setRating(rating: Rating!): BookSeriesEntity.Builder!
```

Sets the rating for the book entity.

Optional.