# ArticleEntity

# ArticleEntity

*** ** * ** ***

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


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

*** ** * ** ***

An object representing a article entity.

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ### Nested types                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `public final class `[ArticleEntity.Builder](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.Builder) Builder class for [ArticleEntity](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `@`[IntDef](https://developer.android.com/reference/androidx/annotation/IntDef.html)`(value = [EligibleContentCategory.TYPE_EDUCATION, EligibleContentCategory.TYPE_SPORTS, EligibleContentCategory.TYPE_MOVIES_AND_TV_SHOWS, EligibleContentCategory.TYPE_BOOKS, EligibleContentCategory.TYPE_AUDIOBOOKS, EligibleContentCategory.TYPE_MUSIC, EligibleContentCategory.TYPE_DIGITAL_GAMES, EligibleContentCategory.TYPE_TRAVEL_AND_LOCAL, EligibleContentCategory.TYPE_HOME_AND_AUTO, EligibleContentCategory.TYPE_BUSINESS, EligibleContentCategory.TYPE_NEWS, EligibleContentCategory.TYPE_FOOD_AND_DRINK, EligibleContentCategory.TYPE_SHOPPING, EligibleContentCategory.TYPE_HEALTH_AND_FITNESS, EligibleContentCategory.TYPE_MEDICAL, EligibleContentCategory.TYPE_PARENTING, EligibleContentCategory.TYPE_DATING])` `@`[Retention](https://developer.android.com/reference/java/lang/annotation/Retention.html)`(value = RetentionPolicy.SOURCE)` `public annotation `[ArticleEntity.EligibleContentCategory](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity.EligibleContentCategory) Possible content categories of the article entity. |

|                              ### Public fields                              |
|-----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `final `[Uri](https://developer.android.com/reference/android/net/Uri.html) | [actionUri](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#actionUri())                                         |
| `final `[Long](https://developer.android.com/reference/java/lang/Long.html) | [lastEngagementTimestampMillis](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#lastEngagementTimestampMillis()) |
| `final int`                                                                 | [progressPercentage](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#progressPercentage())                       |

|                                                                                        ### Public methods                                                                                        |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)                                                                                                                              | [getActionUri](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getActionUri())`()` Returns the action uri of the article entity.                                                                                            |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[Badge](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Badge)`>`                       | [getBadgeList](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getBadgeList())`()` Returns the list of badges (image/text) for the article entity.                                                                          |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[Integer](https://developer.android.com/reference/java/lang/Integer.html)`>`                                               | [getContentCategoryList](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getContentCategoryList())`()` Returns the content categories of the article entity.                                                                |
| [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/common/datamodel/ArticleEntity#getDescription())`()` Returns the description (typically a single paragraph of text) for the article entity.                                               |
| [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/common/datamodel/ArticleEntity#getEntityId())`()` Returns the id of the entity.                                                                                                              |
| [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)`>`                               | [getLastContentPublishTimestampMillis](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getLastContentPublishTimestampMillis())`()` Returns the last content publish timestamp for the article entity in epoch milliseconds. |
| [Long](https://developer.android.com/reference/java/lang/Long.html)                                                                                                                              | [getLastEngagementTimestampMillis](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getLastEngagementTimestampMillis())`()` Returns the last engagement timestamp for the article entity in epoch milliseconds.              |
| [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/common/datamodel/ArticleEntity#getPosterImages())`()` Returns the poster image of the entity.                                                                                            |
| `int`                                                                                                                                                                                            | [getProgressPercentage](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getProgressPercentage())`()` Returns the progress percentage of the article entity.                                                                 |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Badge](https://developer.android.com/reference/com/google/android/engage/common/datamodel/Badge)`>` | [getSource](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getSource())`()` Returns the source/author for the article entity.                                                                                              |
| [List](https://developer.android.com/reference/java/util/List.html)`<`[String](https://developer.android.com/reference/java/lang/String.html)`>`                                                 | [getSubtitleList](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getSubtitleList())`()` Returns the list of subtitles for the article entity.                                                                              |
| [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)`>`                           | [getTitle](https://developer.android.com/reference/com/google/android/engage/common/datamodel/ArticleEntity#getTitle())`()` Returns the name/title of the article entity.                                                                                                    |

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

### actionUri

```
public final Uri actionUri
```  

### lastEngagementTimestampMillis

```
public final Long lastEngagementTimestampMillis
```  

### progressPercentage

```
public final int progressPercentage
```  

## Public methods

### getActionUri

```
public Uri getActionUri()
```

Returns the action uri of the article entity.  

### getBadgeList

```
public List<Badge> getBadgeList()
```

Returns the list of badges (image/text) for the article entity.  

### getContentCategoryList

```
public List<Integer> getContentCategoryList()
```

Returns the content categories of the article entity.  

### getDescription

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

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

### getEntityId

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

Returns the id of the entity.  

### getLastContentPublishTimestampMillis

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

Returns the last content publish timestamp for the article entity in epoch milliseconds.  

### getLastEngagementTimestampMillis

```
public Long getLastEngagementTimestampMillis()
```

Returns the last engagement timestamp for the article entity in epoch milliseconds.  

### getPosterImages

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

Returns the poster image of the entity.  

### getProgressPercentage

```
public int getProgressPercentage()
```

Returns the progress percentage of the article entity.  

### getSource

```
public Optional<Badge> getSource()
```

Returns the source/author for the article entity.  

### getSubtitleList

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

Returns the list of subtitles for the article entity.  

### getTitle

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

Returns the name/title of the article entity.