Image

@JsonClass(generateAdapter = true)
data class Image(    val _id: String?,     val version: String?,     val subtype: String?,     val channels: List<String>?,     val alignment: String?,     val copyright: String?,     val canonical_url: String?,     val short_url: String?,     val created_date: Date?,     val last_updated_date: Date?,     val publish_date: Date?,     val first_publish_date: Date?,     val display_date: Date?,     val geo: Geo?,     val language: String?,     val location: String?,     val address: Address?,     val editor_note: String?,     val status: String?,     val headlines: Headline?,     val subheadlines: Headline?,     val description: Description?,     val credits: Credits?,     val vanity_credits: Credits?,     val promo_items: PromoItem?,     val related_content: Map<String, *>?,     val owner: Owner?,     val planning: Planning?,     val pitches: Pitches?,     val source: Source?,     val distributor: Distributor?,     val tracking: Any?,     val comments: Comments?,     val label: Label?,     val slug: String?,     val content_restrictions: ContentRestrictions?,     val image_type: String?,     val alt_text: String?,     val focal_point: Image.FocalPoint?,     val additional_properties: Map<String, *>?,     val subtitle: String?,     val caption: String?,     val url: String?,     val width: Int?,     val height: Int?,     val licensable: Boolean?,     val contributors: Image.CreatedBy?,     val auth: Map<String, String>?) : StoryElement

Image ANS type

Constructors

Link copied to clipboard
fun Image(    _id: String?,     version: String?,     subtype: String?,     channels: List<String>?,     alignment: String?,     copyright: String?,     canonical_url: String?,     short_url: String?,     created_date: Date?,     last_updated_date: Date?,     publish_date: Date?,     first_publish_date: Date?,     display_date: Date?,     geo: Geo?,     language: String?,     location: String?,     address: Address?,     editor_note: String?,     status: String?,     headlines: Headline?,     subheadlines: Headline?,     description: Description?,     credits: Credits?,     vanity_credits: Credits?,     promo_items: PromoItem?,     related_content: Map<String, *>?,     owner: Owner?,     planning: Planning?,     pitches: Pitches?,     source: Source?,     distributor: Distributor?,     tracking: Any?,     comments: Comments?,     label: Label?,     slug: String?,     content_restrictions: ContentRestrictions?,     image_type: String?,     alt_text: String?,     focal_point: Image.FocalPoint?,     additional_properties: Map<String, *>?,     subtitle: String?,     caption: String?,     url: String?,     width: Int?,     height: Int?,     licensable: Boolean?,     contributors: Image.CreatedBy?,     auth: Map<String, String>?)

Types

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class CreatedBy(val user_id: String?, val display_name: String?)

Trait that holds information on who created and contributed to a given document in Arc.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class FocalPoint(val x: Any?, val y: Any?)

coordinates representing the 'visual center' of an image. The X axis is horizontal line and the Y axis the vertical line, with 0,0 being the LEFT, TOP of the image.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class ResizerAuth(val one: String?)

Properties

Link copied to clipboard
val _id: String?

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

Link copied to clipboard
val additional_properties: Map<String, *>?

A grab-bag object for non-validatable data.

Link copied to clipboard
val address: Address?

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

Link copied to clipboard
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'

Link copied to clipboard
val alt_text: String?

The direct ANS equivalent of the HTML 'alt' attribute. A description of the contents of an image for improved accessibility.

Link copied to clipboard
val auth: Map<String, String>?
Link copied to clipboard
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.

Link copied to clipboard
val caption: String?

Caption for the image.

Link copied to clipboard
val channels: List<String>?

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

Link copied to clipboard
val comments: Comments?

Comment configuration data

Link copied to clipboard
val content_restrictions: ContentRestrictions?

Trait that applies contains the content restrictions of an ANS object.

Link copied to clipboard
val contributors: Image.CreatedBy?

Trait that holds information on who created and contributed to a given document in Arc.

Link copied to clipboard
val copyright: String?

Copyright information: A copyright notice for the legal owner of this content. E.g., '© 1996-2018 The Washington Post.' Format may vary between organizations.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
val description: Description?

The descriptions, or blurbs, for the content

Link copied to clipboard
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.

Link copied to clipboard
val distributor: Distributor?

Information about a third party that provided this content from outside this document's hosted organization.

Link copied to clipboard
val editor_note: String?

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

Link copied to clipboard
val first_publish_date: Date?

First Publish Date: When the story was first published.

Link copied to clipboard
val focal_point: Image.FocalPoint?

coordinates representing the 'visual center' of an image. The X axis is horizontal line and the Y axis the vertical line, with 0,0 being the LEFT, TOP of the image.

Link copied to clipboard
val geo: Geo?

Geo: Latitude and Longitude of the content

Link copied to clipboard
val headlines: Headline?

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

Link copied to clipboard
val height: Int?

Height for the image.

Link copied to clipboard
val image_type: String?

A more specific category for an image. "photograph", "graphic", "illustration", or "thumbnail"

Link copied to clipboard
val label: Label?

What the Washington Post calls a Kicker

Link copied to clipboard
val language: String?

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

Link copied to clipboard
val last_updated_date: Date?

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

Link copied to clipboard
val licensable: Boolean?

True if the image can legally be licensed to others.

Link copied to clipboard
val location: String?

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

Link copied to clipboard
val owner: Owner?

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

Link copied to clipboard
val pitches: Pitches?

Trait that represents a story's pitches. In the Arc ecosystem, this data is generated by WebSked.

Link copied to clipboard
val planning: Planning?

Trait that applies planning information to a document or resource. In the Arc ecosystem, this data is generated by WebSked. Newsroom use only. All these fields should be available and editable in WebSked.

Link copied to clipboard
val promo_items: PromoItem?

Lists of promotional content to use when highlighting the story. In the Arc ecosystem, references in these lists will be denormalized.

Link copied to clipboard
val publish_date: Date?

Publish_Date: When the story was published.

Link copied to clipboard
val related_content: Map<String, *>?

Lists of content items or references this story is related to, arbitrarily keyed. In the Arc ecosystem, references in this object will be denormalized into the fully-inflated content objects they represent.

Link copied to clipboard
val short_url: String?

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

Link copied to clipboard
val slug: String?

A short reference name for internal editorial use

Link copied to clipboard
val source: Source?

Information about the original source and/or owner of this content

Link copied to clipboard
val status: String?

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

Link copied to clipboard
val subheadlines: Headline?

SubHeadlines: The subheadline(s) or title for this content.

Link copied to clipboard
val subtitle: String?

Subtitle for the image.

Link copied to clipboard
val subtype: String?

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.

Link copied to clipboard
val tracking: Any?

Tracking information, probably implementation-dependent

Link copied to clipboard
val type: String
Link copied to clipboard
val url: String?

URL for the image.

Link copied to clipboard
val vanity_credits: Credits?

Similar to the credits trait, but to be used only when ANS is being directly rendered to readers natively. For legal and technical reasons, the credits trait is preferred when converting ANS into feeds or other distribution formats. However, when present, vanity_credits allows more sophisticated credits presentation to override the default without losing that original data.

Link copied to clipboard
val version: String?

Describes the ANS version of this object: 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.

Link copied to clipboard
val width: Int?

Width for the image.

Extensions

Link copied to clipboard
fun Image.fallback(): String
Link copied to clipboard
fun Image.imageUrl(): String