# ArticleEntity

# ArticleEntity

*** ** * ** ***

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

<br />

```
class ArticleEntity : Entity
```

<br />

|---|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                                         |||
| ↳ | [com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity)                  ||
|   | ↳ | [com.google.android.engage.common.datamodel.ArticleEntity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity) |

*** ** * ** ***

An object representing a article entity.

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         ### Nested types                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[ArticleEntity.Builder](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity.Builder) Builder class for[ArticleEntity](https://developer.android.com/reference/kotlin/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)` `annotation `[ArticleEntity.EligibleContentCategory](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity.EligibleContentCategory) Possible content categories of the article entity. |

|                                                                                                                                               ### Public functions                                                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `(`[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)`<`[Badge](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Badge)`!>!` | [getBadgeList](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#getBadgeList())`()` Returns the list of badges (image/text) for the article entity.                                                                          |
| `(`[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)`<`[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`!>!`                               | [getContentCategoryList](https://developer.android.com/reference/kotlin/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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getDescription](https://developer.android.com/reference/kotlin/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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getEntityId](https://developer.android.com/reference/kotlin/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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`!>!`                                                                                                                                     | [getLastContentPublishTimestampMillis](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#getLastContentPublishTimestampMillis())`()` Returns the last content publish timestamp for the article entity in epoch milliseconds. |
| `(`[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)`!>!` | [getPosterImages](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#getPosterImages())`()` Returns the poster image of the entity.                                                                                            |
| [Optional](https://guava.dev/releases/21.0/api/docs/com/google/common/base/Optional.html)`<`[Badge](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Badge)`!>!`                                                                                                         | [getSource](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#getSource())`()` Returns the source/author for the article entity.                                                                                              |
| `(`[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)`!>!`                         | [getSubtitleList](https://developer.android.com/reference/kotlin/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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`!>!`                                                                                                                                 | [getTitle](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#getTitle())`()` Returns the name/title of the article entity.                                                                                                    |

|                                                                                                             ### Public properties                                                                                                              |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Uri](https://developer.android.com/reference/android/net/Uri.html)`!`                                                                                                                                                                         | [actionUri](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#actionUri())                                         |
| [ImmutableList](https://guava.dev/releases/21.0/api/docs/com/google/common/collect/ImmutableList.html)`<`[DisplayTimeWindow](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/DisplayTimeWindow)`!>!` | [displayTimeWindows](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#displayTimeWindows())                       |
| [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)`!`                                                                                                                                                                | [lastEngagementTimestampMillis](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#lastEngagementTimestampMillis()) |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                                                                                                                                                                     | [progressPercentage](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/ArticleEntity#progressPercentage())                       |

|                                                                                                                                                                                                                                                                                         ### Inherited functions                                                                                                                                                                                                                                                                                         |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From[com.google.android.engage.common.datamodel.Entity](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity) |----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getEntityType](https://developer.android.com/reference/kotlin/com/google/android/engage/common/datamodel/Entity#getEntityType())`()` | |

## Public functions

### getBadgeList

```
fun getBadgeList(): (Mutable)List<Badge!>!
```

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

### getContentCategoryList

```
fun getContentCategoryList(): (Mutable)List<Int!>!
```

Returns the content categories of the article entity.  

### getDescription

```
fun getDescription(): Optional<String!>!
```

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

### getEntityId

```
fun getEntityId(): Optional<String!>!
```

Returns the id of the entity.  

### getLastContentPublishTimestampMillis

```
fun getLastContentPublishTimestampMillis(): Optional<Long!>!
```

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

### getPosterImages

```
fun getPosterImages(): (Mutable)List<Image!>!
```

Returns the poster image of the entity.  

### getSource

```
fun getSource(): Optional<Badge!>!
```

Returns the source/author for the article entity.  

### getSubtitleList

```
fun getSubtitleList(): (Mutable)List<String!>!
```

Returns the list of subtitles for the article entity.  

### getTitle

```
fun getTitle(): Optional<String!>!
```

Returns the name/title of the article entity.  

## Public properties

### actionUri

```
val actionUri: Uri!
```  

### displayTimeWindows

```
val displayTimeWindows: ImmutableList<DisplayTimeWindow!>!
```  

### lastEngagementTimestampMillis

```
val lastEngagementTimestampMillis: Long!
```  

### progressPercentage

```
val progressPercentage: Int
```