core/co.cafeyn.cgs.api.model/Article

Article

data class Article(val id: ArticleId, val releaseDate: Date, val lastUpdate: Date, val primeImage: ArticleImage?, val title: String, val surTitle: String?, val subTitle: String?, val author: String?, val theme: String?, val subTheme: String?, val elements: List<ArticleElement>, val preview: String?, val wordCount: Long, val abstractLayout: String?, val templateId: TemplateId, val issueId: IssueId?, val articleNumber: Int?, val pages: List<Int>?, val themeTags: List<String>, val publicationId: PublicationId?, val formattedUrl: String?, val language: String?, val mediaTrackId: MediaTrackId?, val isAdvertisement: Boolean, val articlePath: String?, val isDigitalArticle: Boolean, val readingTime: Int) : Serializable

Represents an article with full detail.

Parameters

unique identifier of the article

releaseDate

publication / release date of the article

lastUpdate

date of the last modification to the article

primeImage

primary article image

title

main title of the article

surTitle

optional kicker/label displayed above the title

subTitle

optional subtitle displayed below the title

author

optional name of the article's author

theme

optional primary theme or category of the article

subTheme

optional secondary theme or subcategory of the article

elements

the article body, in reading order — see ArticleElement

preview

optional teaser or excerpt of the article content

wordCount

total word count of the article body

abstractLayout

optional layout identifier used to render the article abstract

templateId

identifier of the display template used to render the article

issueId

optional identifier of the issue this article belongs to

articleNumber

optional sequential number of the article within its issue

pages

optional list of page numbers this article spans

themeTags

list of topic tags associated with the article

publicationId

optional identifier of the publication this article belongs to

formattedUrl

optional canonical URL of the article

language

optional BCP 47 / ISO language code of the article content

mediaTrackId

optional identifier of an associated audio or media track

isAdvertisement

whether this article is an advertisement

articlePath

optional path to the article resource on the content server

isDigitalArticle

whether this article is digital-only (not available in print)

readingTime

estimated reading time in minutes

Constructors

Article

constructor(id: ArticleId, releaseDate: Date, lastUpdate: Date, primeImage: ArticleImage?, title: String, surTitle: String?, subTitle: String?, author: String?, theme: String?, subTheme: String?, elements: List<ArticleElement>, preview: String?, wordCount: Long, abstractLayout: String?, templateId: TemplateId, issueId: IssueId?, articleNumber: Int?, pages: List<Int>?, themeTags: List<String>, publicationId: PublicationId?, formattedUrl: String?, language: String?, mediaTrackId: MediaTrackId?, isAdvertisement: Boolean, articlePath: String?, isDigitalArticle: Boolean, readingTime: Int)

Types

Author

data class Author(val value: String) : ArticleElement

Name of the person or entity responsible for creating the article, typically displayed prominently near the title to credit the author(s).

DropCap

data class DropCap(val value: String) : ArticleElement

A stylistic element at the beginning of an article or section where the first letter is enlarged and styled differently (e.g. bold or decorative font) to create a visually appealing introduction.

InterviewAnswer

data class InterviewAnswer(val value: String) : ArticleElement

The response provided by an interviewee. Displayed in a format that distinguishes it from the interview question and other text elements, such as regular font or indentation.

InterviewQuestion

data class InterviewQuestion(val value: String) : ArticleElement

A question posed to an interviewee. Typically displayed in a distinct format (e.g. bold or italicised) to differentiate it from the interviewee's response and other text elements.

Introduction

data class Introduction(val value: String) : ArticleElement

Brief introductory text providing an overview of the article's content, setting the stage for the reader and highlighting the main points or themes explored in the article.

Paragraph

data class Paragraph(val value: String) : ArticleElement

A block of text forming the main body of the article, containing the core content and information the article aims to convey.

ParagraphTitle

data class ParagraphTitle(val value: String) : ArticleElement

A title for a specific section or paragraph within the article, used to organise the content and guide the reader through the different topics or themes covered.

Quote

data class Quote(val value: String) : ArticleElement

A quotation from a person or source, typically displayed in a distinct format (e.g. italicised or indented) to differentiate it from the main body of the article.

QuoteAuthor

data class QuoteAuthor(val value: String) : ArticleElement

The name of the person being quoted, displayed alongside the quoted text to provide context and credit to the original source.

SubTheme

data class SubTheme(val value: String) : ArticleElement

More specific subcategory or aspect of the main theme, providing additional context and helping readers understand the focus of the article.

SubTitle

data class SubTitle(val value: String) : ArticleElement

Secondary title displayed below the main title, used to elaborate on the main topic, highlight a specific angle, or provide a brief summary of the article.

SurTitle