# ArticleEntity.Builder

# ArticleEntity.Builder

*** ** * ** ***

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

<br />

```
public final class ArticleEntity.Builder
```

<br />

*** ** * ** ***

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

## Summary

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

|                                                        ### Public methods                                                         |
|-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addAllDisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.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 display time windows for the article entity. |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addBadge](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#addBadge(com.google.android.engage.common.datamodel.Badge))`(`[Badge](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Badge)` badge)` Add a badge (image/text) for the article entity.                                                                                                                                                                        |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addBadges](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#addBadges(java.util.List<com.google.android.engage.common.datamodel.Badge>))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[Badge](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Badge)`> badges)` Add badges of the article entity.                                                                                             |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addContentCategories](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#addContentCategories(java.util.List<java.lang.Integer>))`(`[List](https://developer.android.com/reference/java/util/List.html)`<`[Integer](https://developer.android.com/reference/java/lang/Integer.html)`> contentCategories)` Add eligible content categories for the article entity.                                                                                             |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addContentCategory](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#addContentCategory(int))`(` ` @`[ArticleEntity.EligibleContentCategory](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.EligibleContentCategory)` int contentCategory` `)` Add eligible content category for the article entity.                                                                                                      |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addDisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#addDisplayTimeWindow(com.google.android.engage.common.datamodel.DisplayTimeWindow))`(`[DisplayTimeWindow](https://developer.android.com/reference/com/google/android/engage/common/datamodel/DisplayTimeWindow)` displayTimeWindow)` Adds a display time window for the article entity.                                                                                              |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImage](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.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.                                                                                                                                                                           |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addPosterImages](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.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.                                                                                  |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addSubtitle](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#addSubtitle(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` subtitle)` Add a subtitle of the article entity.                                                                                                                                                                                                                                    |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [addSubtitles](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#addSubtitles(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)`> subtitles)` Add subtitles of the article entity.                                                                                                                                           |
| [ArticleEntity](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity)                 | [build](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#build())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setActionUri](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#setActionUri(android.net.Uri))`(`[Uri](https://developer.android.com/reference/android/net/Uri.html)` actionUri)` Sets the action uri of the article entity.                                                                                                                                                                                                                                 |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setDescription](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#setDescription(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` description)` Sets the description (typically a single paragraph of text) of the article entity.                                                                                                                                                                              |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setEntityId](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#setEntityId(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` entityId)` Sets content id of the entity.                                                                                                                                                                                                                                           |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setLastContentPublishTimestampMillis](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#setLastContentPublishTimestampMillis(java.lang.Long))`(` ` `[Long](https://developer.android.com/reference/java/lang/Long.html)` lastContentPublishTimestampMillis` `)` Sets the last content publish timestamp for the article entity.                                                                                                                              |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setLastEngagementTimestampMillis](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#setLastEngagementTimestampMillis(long))`(long lastEngagementTimestampMillis)` Sets the last engagement timestamp for the article entity.                                                                                                                                                                                                                                 |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setProgressPercentage](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#setProgressPercentage(int))`(int progressPercentage)` Sets the progress percentage for the article entity.                                                                                                                                                                                                                                                                          |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setSource](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#setSource(com.google.android.engage.common.datamodel.Badge))`(`[Badge](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Badge)` source)` Sets the source/author details of the article entity.                                                                                                                                                                |
| [ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) | `@`[CanIgnoreReturnValue](https://errorprone.info/api/latest/com/google/errorprone/annotations/CanIgnoreReturnValue.html) [setTitle](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder#setTitle(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String.html)` title)` Sets the name/title of the article entity.                                                                                                                                                                                                                                        |

## Public constructors

### Builder

```
public Builder()
```  

## Public methods

### addAllDisplayTimeWindow

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

Adds display time windows for the article entity.

Optional.  

### addBadge

```
@CanIgnoreReturnValue
public ArticleEntity.Builder addBadge(Badge badge)
```

Add a badge (image/text) for the article entity.

Optional.  

### addBadges

```
@CanIgnoreReturnValue
public ArticleEntity.Builder addBadges(List<Badge> badges)
```

Add badges of the article entity.

Optional.  

### addContentCategories

```
@CanIgnoreReturnValue
public ArticleEntity.Builder addContentCategories(List<Integer> contentCategories)
```

Add eligible content categories for the article entity.

Optional.  

### addContentCategory

```
@CanIgnoreReturnValue
public ArticleEntity.Builder addContentCategory(
    @ArticleEntity.EligibleContentCategory int contentCategory
)
```

Add eligible content category for the article entity.

Optional.  

### addDisplayTimeWindow

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

Adds a display time window for the article entity.

Optional.  

### addPosterImage

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

Add a poster image of the entity.

Required.  

### addPosterImages

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

Add poster images of the entity.

Required.  

### addSubtitle

```
@CanIgnoreReturnValue
public ArticleEntity.Builder addSubtitle(String subtitle)
```

Add a subtitle of the article entity.

Optional.  

### addSubtitles

```
@CanIgnoreReturnValue
public ArticleEntity.Builder addSubtitles(List<String> subtitles)
```

Add subtitles of the article entity.

Optional.  

### build

```
public ArticleEntity build()
```  

### setActionUri

```
@CanIgnoreReturnValue
public ArticleEntity.Builder setActionUri(Uri actionUri)
```

Sets the action uri of the article entity.

Required.  

### setDescription

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

Sets the description (typically a single paragraph of text) of the article entity.

Optional.  

### setEntityId

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

Sets content id of the entity.

Optional.  

### setLastContentPublishTimestampMillis

```
@CanIgnoreReturnValue
public ArticleEntity.Builder setLastContentPublishTimestampMillis(
    Long lastContentPublishTimestampMillis
)
```

Sets the last content publish timestamp for the article entity.

Optional.  

### setLastEngagementTimestampMillis

```
@CanIgnoreReturnValue
public ArticleEntity.Builder setLastEngagementTimestampMillis(long lastEngagementTimestampMillis)
```

Sets the last engagement timestamp for the article entity.

Required.  

### setProgressPercentage

```
@CanIgnoreReturnValue
public ArticleEntity.Builder setProgressPercentage(int progressPercentage)
```

Sets the progress percentage for the article entity.

Required.  

### setSource

```
@CanIgnoreReturnValue
public ArticleEntity.Builder setSource(Badge source)
```

Sets the source/author details of the article entity.

Optional.  

### setTitle

```
@CanIgnoreReturnValue
public ArticleEntity.Builder setTitle(String title)
```

Sets the name/title of the article entity.

Optional.