# BookSeriesEntity

# BookSeriesEntity

*** ** * ** ***

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

<br />

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

*** ** * ** ***

An object representing a book series entity.

## Summary

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

| ### Public fields |
|-------------------|-----------------------------------------------------------------------------------------------------------------------------|
| `final int`       | [bookCount](https://developer.android.com/reference/com/google/android/engage/books/datamodel/BookSeriesEntity#bookCount()) |

|                                                                                         ### Public methods                                                                                         |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)                                                                                                                                | [getActionLinkUri](https://developer.android.com/reference/com/google/android/engage/books/datamodel/BookSeriesEntity#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/BookSeriesEntity#getAuthors())`()` Returns the list of authors of the book series.                                     |
| `int`                                                                                                                                                                                              | [getAvailability](https://developer.android.com/reference/com/google/android/engage/books/datamodel/BookSeriesEntity#getAvailability())`()`                                                                           |
| `int`                                                                                                                                                                                              | [getBookCount](https://developer.android.com/reference/com/google/android/engage/books/datamodel/BookSeriesEntity#getBookCount())`()` Returns the number of books in the book series.                                 |
| [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/BookSeriesEntity#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/BookSeriesEntity#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/BookSeriesEntity#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/BookSeriesEntity#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/BookSeriesEntity#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/BookSeriesEntity#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/BookSeriesEntity#getName())`()` Returns the name of the entity.                                                           |
| [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/BookSeriesEntity#getPosterImages())`()` Returns the poster image 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)`>`                           | [getProgressPercentComplete](https://developer.android.com/reference/com/google/android/engage/books/datamodel/BookSeriesEntity#getProgressPercentComplete())`()` Returns the percentage progress completed.          |
| [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/BookSeriesEntity#getRating())`()`                                                                                       |
| `boolean`                                                                                                                                                                                          | [isDownloadedOnDevice](https://developer.android.com/reference/com/google/android/engage/books/datamodel/BookSeriesEntity#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

### bookCount

```
public final int bookCount
```  

## 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 book series.  

### getAvailability

```
public int getAvailability()
```  

### getBookCount

```
public int getBookCount()
```

Returns the number of books in the book series.  

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

### getPosterImages

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

Returns the poster image of the entity.  

### getProgressPercentComplete

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

Returns the percentage progress completed.  

### getRating

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

### isDownloadedOnDevice

```
public boolean isDownloadedOnDevice()
```