Package-level declarations

Types

Link copied to clipboard
interface StoryblokClient

Client for the Storyblok Content Delivery API.

Link copied to clipboard
open class StoryblokClientException(message: String?, cause: Throwable?) : Exception

Exception thrown on errors occurring during StoryblokClient operations.

Link copied to clipboard

Default StoryblokClient implementation. Create clients through the StoryblokClient factory functions instead of instantiating this class directly.

Functions

Link copied to clipboard
inline fun <T : Component> StoryblokClient.stories(config: PagingConfig = PagingConfig(pageSize = 25), resolveLevel: Int = 1, noinline query: StoriesQuery<T>.() -> Unit = {}): Pager<Int, Story<T>>

Retrieves multiple stories as a PagingData stream, using reified type information for the Component type.

Link copied to clipboard
inline fun <T : Component> StoryblokClient.story(slug: String, resolveLevel: Int = 1, noinline query: StoryQuery<T>.() -> Unit = {}): Flow<Story<T>>

Retrieves a Story by its slug using reified type information for the Component type.

inline fun <T : Component> StoryblokClient.story(uuid: Uuid, resolveLevel: Int = 1, noinline query: StoryQuery<T>.() -> Unit = {}): Flow<Story<T>>

Retrieves a Story by its UUID using reified type information for the Component type.