ArcXP-Mobile-SDK-Android/com.arcxp.content.models/PromoItem/PromoItemBasic

PromoItemBasic

@JsonClass(generateAdapter = true)

data class PromoItemBasic( val _id: String?, val address: Address?, val alignment: String?, val canonical_url: String?, val caption: String?, val channels: List<String>?, val content: String?, val copyright: String?, val created_date: Date?, val credits: Credits?, val description: Description?, val display_date: Date?, val editor_note: String?, val embed: Embed?, val first_publish_date: Date?, val geo: Geo?, val headlines: Headline?, val height: Int?, val width: Int?, val last_updated_date: Date?, val language: String?, val licensable: Boolean?, val location: String?, val owner: Owner?, val publish_date: Date?, val short_url: String?, val status: String?, val subheadlines: Headline?, val subtitle: String?, val subtype: String?, val taxonomy: Taxonomy?, val type: String?, val url: String?, val version: String?, val promo_items: PromoItem?, val additional_properties: Map<String, *>?, val auth: Map<String, String>?)

Constructors

PromoItemBasic

fun PromoItemBasic( _id: String?, address: Address?, alignment: String?, canonical_url: String?, caption: String?, channels: List<String>?, content: String?, copyright: String?, created_date: Date?, credits: Credits?, description: Description?, display_date: Date?, editor_note: String?, embed: Embed?, first_publish_date: Date?, geo: Geo?, headlines: Headline?, height: Int?, width: Int?, last_updated_date: Date?, language: String?, licensable: Boolean?, location: String?, owner: Owner?, publish_date: Date?, short_url: String?, status: String?, subheadlines: Headline?, subtitle: String?, subtype: String?, taxonomy: Taxonomy?, type: String?, url: String?, version: String?, promo_items: PromoItem?, additional_properties: Map<String, *>?, auth: Map<String, String>?)

Properties

_id

val _id: String?

Globally Unique ID trait: A globally unique identifier of the content in the ANS repository.

additional_properties

val additional_properties: Map<String, *>?

A grab-bag object for non-validatable data.

address

val address: Address?

Address: An Address following the convention of http://microformats.org/wiki/hcard

alignment

val alignment: String?

Alignment: A property used to determine horizontal positioning of a content element relative to the elements that immediately follow it in the element sequence. could be 'left', 'right', or 'center'

auth

val auth: Map<String, String>?

canonical_url

val canonical_url: String?

Canonical URL: The relative URL to this document on the website specified by the canonical_website field. In the Arc ecosystem, this will be populated by the content api from the arc-canonical-url service if present based on the canonical_website. In conjunction with canonical_website, it can be used to determine the SEO canonical url or open graph url. In a multi-site context, this field may be different from the website_url field.

caption

val caption: String?

Caption for an image.

channels

val channels: List<String>?

Channel trait: An optional list of output types for which this element should be visible

content

val content: String?

Any arbitrary chunk of HTML.

val copyright: String?

created_date

val created_date: Date?

Created Date: When the content was originally created (RFC3339-formatted). In the Arc ecosystem, this will be automatically generated for stories in the Story API.

credits

val credits: Credits?

Credits: A list of people and groups attributed to this content, keyed by type of contribution. In the Arc ecosystem, references in this list will be denormalized into author objects from the arc-author-service.

description

val description: Description?

Description: The descriptions, or blurbs, for the content.

display_date

val display_date: Date?

Display_Date: The RFC3339-formatted dated time of the most recent date the story was (re)displayed on a public site.

editor_note

val editor_note: String?

Editor_Note: Additional information to be displayed near the content from the editor.

embed

val embed: Embed?

A custom embed element. Can be used to reference content from external providers about which little is known.

first_publish_date

val first_publish_date: Date?

First Publish Date: When the story was first published.

geo

val geo: Geo?

Geo: Latitude and Longitude of the content

headlines

val headlines: Headline?

Headlines: The headline(s) or title for this content.

height

val height: Int?

Height for an image.

language

val language: String?

Locale: The primary language of the content. The value should follow IETF BCP47. (e.g. 'en', 'es-419', etc.)

last_updated_date

val last_updated_date: Date?

Last Updated Date: When the content was last updated (RFC3339-formatted).

licensable

val licensable: Boolean?

True if the image can legally be licensed to others.

location

val location: String?

Location related trait: A description of the location, useful if a full address or lat/long specification is overkill.

owner

val owner: Owner?

Various unrelated fields that should be preserved for backwards-compatibility reasons. See also trait_source.

promo_items

val promo_items: PromoItem?

publish_date

val publish_date: Date?

Publish_Date: When the story was published.

short_url

val short_url: String?

Short_Url: A url-shortened version of the canonical url.

status

val status: String?

Status: Optional field to story story workflow related status (e.g. published/embargoed/etc)

subheadlines

val subheadlines: Headline?

Sub-Headlines: The sub-headline(s) for the content.

subtitle

val subtitle: String?

Subtitle for an image.

subtype

val subtype: String?

Subtype or Template: A user-defined categorization method to supplement type. In Arc, this field is reserved for organization-defined purposes, such as selecting the PageBuilder template that should be used to render a document.

taxonomy

val taxonomy: Taxonomy?

Holds the collection of tags, categories, keywords, etc that describe content.

type

val type: String?

could be "string", "raw_html", or "custom_embed"

url

val url: String?

URL for an image.

version

val version: String?

The version of ANS that this object was serialized as, in major.minor.patch format. For top-level content objects, this is a required trait.

width

val width: Int?

Width for an image.