ArticleEntity

Kotlin |Java

public final class ArticleEntity extends Entity

java.lang.Object
↳	com.google.android.engage.common.datamodel.Entity
	↳	com.google.android.engage.common.datamodel.ArticleEntity

An object representing a article entity.

Summary

Nested types
`public final class ArticleEntity.Builder` Builder class for `ArticleEntity`.
@IntDef(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(value = RetentionPolicy.SOURCE) public annotation ArticleEntity.EligibleContentCategory Possible content categories of the article entity.

Nested types

public final class ArticleEntity.Builder

Builder class for ArticleEntity.

@IntDef(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(value = RetentionPolicy.SOURCE)
public annotation ArticleEntity.EligibleContentCategory

Possible content categories of the article entity.

Public fields
`final Uri`	`actionUri`
`final Long`	`lastEngagementTimestampMillis`
`final int`	`progressPercentage`

Public methods
`Uri`	`getActionUri()` Returns the action uri of the article entity.
`List<Badge>`	`getBadgeList()` Returns the list of badges (image/text) for the article entity.
`List<Integer>`	`getContentCategoryList()` Returns the content categories of the article entity.
`Optional<String>`	`getDescription()` Returns the description (typically a single paragraph of text) for the article entity.
`Optional<String>`	`getEntityId()` Returns the id of the entity.
`Optional<Long>`	`getLastContentPublishTimestampMillis()` Returns the last content publish timestamp for the article entity in epoch milliseconds.
`Long`	`getLastEngagementTimestampMillis()` Returns the last engagement timestamp for the article entity in epoch milliseconds.
`List<Image>`	`getPosterImages()` Returns the poster image of the entity.
`int`	`getProgressPercentage()` Returns the progress percentage of the article entity.
`Optional<Badge>`	`getSource()` Returns the source/author for the article entity.
`List<String>`	`getSubtitleList()` Returns the list of subtitles for the article entity.
`Optional<String>`	`getTitle()` Returns the name/title of the article entity.

Inherited methods

From com.google.android.engage.common.datamodel.Entity

int

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.