Content Delivery API Client/com.storyblok.cdn/StoryblokClientImpl/story

story

open override fun story(slug: String, resolveLevel: Int = 1, query: StoryQuery<Component>.() -> Unit = {}): Flow<Story<Component>>(source)

Retrieves a Story by its slug.

Return

A Flow emitting the story with Component content, with potential cached and fresh values.

Parameters

slug

The URL path segment identifying the story.

resolveLevel

How deeply nested Story relations are resolved. 1 (the default) resolves direct relations; higher values resolve relations of relations; 0 disables relation resolution entirely — model relation fields as Uuid (or String) to receive the raw uuids. Relations that cannot be resolved within the level (including circular relations) resolve to null for nullable story fields, and fail with a SerializationException naming the uuid for non-nullable ones.

query

Configures the query parameters via the StoryQuery DSL.

open override fun story(uuid: Uuid, resolveLevel: Int = 1, query: StoryQuery<Component>.() -> Unit = {}): Flow<Story<Component>>(source)

Retrieves a Story by its UUID.

Return

A Flow emitting the story with Component content, with potential cached and fresh values.

Parameters

uuid

The unique identifier of the story.

resolveLevel

How deeply nested Story relations are resolved. 1 (the default) resolves direct relations; higher values resolve relations of relations; 0 disables relation resolution entirely — model relation fields as Uuid (or String) to receive the raw uuids. Relations that cannot be resolved within the level (including circular relations) resolve to null for nullable story fields, and fail with a SerializationException naming the uuid for non-nullable ones.

query

Configures the query parameters via the StoryQuery DSL.

open override fun <T : Component> story(uuid: Uuid, typeInfo: TypeInfo, resolveLevel: Int = 1, query: StoryQuery<T>.() -> Unit = {}): Flow<Story<T>>(source)

Retrieves a Story by its UUID with explicit type information for the Component type.

Return

A Flow emitting the story, with potential cached and fresh values.

Parameters

uuid

The unique identifier of the story.

typeInfo

Type information for deserialization.

resolveLevel

How deeply nested Story relations are resolved. 1 (the default) resolves direct relations; higher values resolve relations of relations; 0 disables relation resolution entirely — model relation fields as Uuid (or String) to receive the raw uuids. Relations that cannot be resolved within the level (including circular relations) resolve to null for nullable story fields, and fail with a SerializationException naming the uuid for non-nullable ones.

query

Configures the query parameters via the StoryQuery DSL.

Type Parameters

T

The Component type of the story content.

open override fun <T : Component> story(slug: String, typeInfo: TypeInfo, resolveLevel: Int = 1, query: StoryQuery<T>.() -> Unit = {}): Flow<Story<T>>(source)

Retrieves a Story by its slug with explicit type information for the Component type.

Return

A Flow emitting the story, with potential cached and fresh values.

Parameters

slug

The URL path segment identifying the story.

typeInfo

Type information for deserialization.

resolveLevel

How deeply nested Story relations are resolved. 1 (the default) resolves direct relations; higher values resolve relations of relations; 0 disables relation resolution entirely — model relation fields as Uuid (or String) to receive the raw uuids. Relations that cannot be resolved within the level (including circular relations) resolve to null for nullable story fields, and fail with a SerializationException naming the uuid for non-nullable ones.

query

Configures the query parameters via the StoryQuery DSL.

Type Parameters

T

The Component type of the story content.

Generated by Dokka
© 2026 Copyright