ArticleEntity.Builder

Kotlin |Java

class ArticleEntity.Builder

Builder class for ArticleEntity.

Summary

Public constructors
`Builder()`

Public functions
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue addBadge(badge: Badge!)` Add a badge (image/text) for the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue addBadges(badges: (Mutable)List<Badge!>!)` Add badges of the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue addContentCategories(contentCategories: (Mutable)List<Int!>!)` Add eligible content categories for the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue addContentCategory( @ArticleEntity.EligibleContentCategory contentCategory: Int )` Add eligible content category for the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue addPosterImage(image: Image!)` Add a poster image of the entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue addPosterImages(images: (Mutable)List<Image!>!)` Add poster images of the entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue addSubtitle(subtitle: String!)` Add a subtitle of the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue addSubtitles(subtitles: (Mutable)List<String!>!)` Add subtitles of the article entity.
`ArticleEntity!`	`build()`
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue setActionUri(actionUri: Uri!)` Sets the action uri of the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue setDescription(description: String!)` Sets the description (typically a single paragraph of text) of the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue setEntityId(entityId: String!)` Sets content id of the entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue setLastContentPublishTimestampMillis( lastContentPublishTimestampMillis: Long! )` Sets the last content publish timestamp for the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue setLastEngagementTimestampMillis(lastEngagementTimestampMillis: Long)` Sets the last engagement timestamp for the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue setProgressPercentage(progressPercentage: Int)` Sets the progress percentage for the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue setSource(source: Badge!)` Sets the source/author details of the article entity.
`ArticleEntity.Builder!`	`@CanIgnoreReturnValue setTitle(title: String!)` Sets the name/title of the article entity.

Public constructors

Builder

Builder()

Public functions

addBadge

@CanIgnoreReturnValue
fun addBadge(badge: Badge!): ArticleEntity.Builder!

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

Optional.

addBadges

@CanIgnoreReturnValue
fun addBadges(badges: (Mutable)List<Badge!>!): ArticleEntity.Builder!

Add badges of the article entity.

Optional.

addContentCategories

@CanIgnoreReturnValue
fun addContentCategories(contentCategories: (Mutable)List<Int!>!): ArticleEntity.Builder!

Add eligible content categories for the article entity.

Optional.

addContentCategory

@CanIgnoreReturnValue
fun addContentCategory(
    @ArticleEntity.EligibleContentCategory contentCategory: Int
): ArticleEntity.Builder!

Add eligible content category for the article entity.

Optional.

addPosterImage

@CanIgnoreReturnValue
fun addPosterImage(image: Image!): ArticleEntity.Builder!

Add a poster image of the entity.

Required.

addPosterImages

@CanIgnoreReturnValue
fun addPosterImages(images: (Mutable)List<Image!>!): ArticleEntity.Builder!

Add poster images of the entity.

Required.

addSubtitle

@CanIgnoreReturnValue
fun addSubtitle(subtitle: String!): ArticleEntity.Builder!

Add a subtitle of the article entity.

Optional.

addSubtitles

@CanIgnoreReturnValue
fun addSubtitles(subtitles: (Mutable)List<String!>!): ArticleEntity.Builder!

Add subtitles of the article entity.

Optional.

build

fun build(): ArticleEntity!

setActionUri

@CanIgnoreReturnValue
fun setActionUri(actionUri: Uri!): ArticleEntity.Builder!

Sets the action uri of the article entity.

Required.

setDescription

@CanIgnoreReturnValue
fun setDescription(description: String!): ArticleEntity.Builder!

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

Optional.

setEntityId

@CanIgnoreReturnValue
fun setEntityId(entityId: String!): ArticleEntity.Builder!

Sets content id of the entity.

Optional.

setLastContentPublishTimestampMillis

@CanIgnoreReturnValue
fun setLastContentPublishTimestampMillis(
    lastContentPublishTimestampMillis: Long!
): ArticleEntity.Builder!

Sets the last content publish timestamp for the article entity.

Optional.

setLastEngagementTimestampMillis

@CanIgnoreReturnValue
fun setLastEngagementTimestampMillis(lastEngagementTimestampMillis: Long): ArticleEntity.Builder!

Sets the last engagement timestamp for the article entity.

Required.

setProgressPercentage

@CanIgnoreReturnValue
fun setProgressPercentage(progressPercentage: Int): ArticleEntity.Builder!

Sets the progress percentage for the article entity.

Required.

setSource

@CanIgnoreReturnValue
fun setSource(source: Badge!): ArticleEntity.Builder!

Sets the source/author details of the article entity.

Optional.

setTitle

@CanIgnoreReturnValue
fun setTitle(title: String!): ArticleEntity.Builder!

Sets the name/title of the article entity.

Optional.