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

StoryblokClientImpl

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() }, val http: HttpClient = HttpClient { install(ContentNegotiation) { json(json) } install(Storyblok(Api.CDN), apiBuilder) }) : StoryblokClient(source)

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

Constructors

StoryblokClientImpl

constructor(apiBuilder: Api.Config.Content.() -> Unit, serializersModuleBuilder: SerializersModuleBuilder.() -> Unit, jsonBuilder: JsonBuilder.() -> Unit, json: Json = Json { isLenient = true decodeEnumsCaseInsensitive = true classDiscriminator = "component" serializersModule = SerializersModule { polymorphic(Component::class) { defaultDeserializer { serializer<Component.Unknown>() } } serializersModuleBuilder() } jsonBuilder() }, http: HttpClient = HttpClient { install(ContentNegotiation) { json(json) } install(Storyblok(Api.CDN), apiBuilder) })

Properties

http

open override val http: HttpClient

The underlying Ktor HTTP client.

json

val json: Json

relations

val relations: Map<String, Map<String, Boolean>>

Relation fields per component, mapping each field name to whether its Story type is nullable (for list relations, whether the list's element type is nullable).

Functions

open override fun close()

Closes the underlying HTTP client and releases resources.

story

open override fun story(slug: String, resolveLevel: Int = 1): Flow<Story<Component>>

Retrieves a Story by its slug.

open override fun story(uuid: Uuid, resolveLevel: Int = 1): Flow<Story<Component>>

Retrieves a Story by its UUID.

open override fun <T : Component> story(slug: String, typeInfo: TypeInfo, resolveLevel: Int = 1): Flow<Story<T>>

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

open override fun <T : Component> story(uuid: Uuid, typeInfo: TypeInfo, resolveLevel: Int = 1): Flow<Story<T>>

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

story

inline fun <T : Component> StoryblokClient.story(slug: String, resolveLevel: Int = 1): 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): Flow<Story<T>>

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