ArticleEntity


class ArticleEntity : Entity


An object representing a article entity.

Summary

Nested types

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)
annotation ArticleEntity.EligibleContentCategory

Possible content categories of the article entity.

Public functions

(Mutable)List<Badge!>!

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

(Mutable)List<Int!>!

Returns the content categories of the article entity.

Optional<String!>!

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

Optional<String!>!

Returns the id of the entity.

Optional<Long!>!

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

(Mutable)List<Image!>!

Returns the poster image of the entity.

Optional<Badge!>!

Returns the source/author for the article entity.

(Mutable)List<String!>!

Returns the list of subtitles for the article entity.

Optional<String!>!

Returns the name/title of the article entity.

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 actionUriUri!

lastEngagementTimestampMillis

val lastEngagementTimestampMillisLong!

progressPercentage

val progressPercentageInt