Content Delivery API Client/com.storyblok.cdn.schema/Story

Story

@Serializable

data class Story<T : Component>(val id: Long, val uuid: Uuid, val name: String, val content: T, val slug: String, val fullSlug: String, val createdAt: Instant, val publishedAt: Instant?, val firstPublishedAt: Instant?, val updatedAt: Instant?, val sortByDate: LocalDate?, val position: Int, val tagList: List<String>, val isStartPage: Boolean, val parentId: Long?, val metadata: Map<String, String>?, val groupId: Uuid, val releaseId: Long? = null, val language: String, val path: String?, val alternates: List<Story.Alternate>, val defaultFullSlug: String?, val translatedSlugs: List<Story.TranslatedSlug>?)(source)

Represents a single story retrieved from the Storyblok API.

Constructors

Story

constructor(id: Long, uuid: Uuid, name: String, content: T, slug: String, fullSlug: String, createdAt: Instant, publishedAt: Instant?, firstPublishedAt: Instant?, updatedAt: Instant?, sortByDate: LocalDate?, position: Int, tagList: List<String>, isStartPage: Boolean, parentId: Long?, metadata: Map<String, String>?, groupId: Uuid, releaseId: Long? = null, language: String, path: String?, alternates: List<Story.Alternate>, defaultFullSlug: String?, translatedSlugs: List<Story.TranslatedSlug>?)

Types

Alternate

@Serializable

data class Alternate(val id: Long, val name: String, val slug: String, val published: Boolean, val fullSlug: String, val isFolder: Boolean, val parentId: Long)

Basic data for a story defined as an alternate of the current story.

TranslatedSlug

@Serializable

data class TranslatedSlug(val path: String, val name: String?, val language: String, val published: Boolean?)

Translated slug information for localized story variants.

Properties

alternates

val alternates: List<Story.Alternate>

An array containing objects that provide basic data of the stories defined as alternates of the current story.

content

val content: T

An object containing the field data associated with a content type's specific structure. Also includes a component property with the content type's technical name.

createdAt

val createdAt: Instant

Creation timestamp (Timestamps follow the ISO 8601 standard in UTC).

defaultFullSlug

val defaultFullSlug: String?

Contains the complete slug of the default language (if the Translatable Slugs app is installed).

firstPublishedAt

val firstPublishedAt: Instant?

First publication timestamp (Timestamps follow the ISO 8601 standard in UTC).

fullSlug

val fullSlug: String

Story full slug, combining the parent folder(s) and the story slug.