Package-level declarations
Types
Link copied to clipboard
interface StoryblokClient
Client for the Storyblok Content Delivery API.
Link copied to clipboard
Exception thrown on errors occurring during StoryblokClient operations.
Link copied to clipboard
class StoryblokClientImpl(apiBuilder: Api.Config.Content.() -> Unit, serializersModuleBuilder: SerializersModuleBuilder.() -> Unit, jsonBuilder: JsonBuilder.() -> Unit, val json: Json = Json {
isLenient = true
decodeEnumsCaseInsensitive = true
classDiscriminator = "component"
serializersModule = SerializersModule {
polymorphic(Component::class) {
defaultDeserializer { serializer<Component.Unknown>() }
}
serializersModuleBuilder()
}
jsonBuilder()
// Applied after jsonBuilder so it cannot be turned off: the schema classes name their fields with
// @JsonNames, which is only honoured while alternative names are enabled.
useAlternativeNames = true
}, val http: HttpClient = HttpClient { configureStoryblok(json, apiBuilder) }) : StoryblokClient
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