Package-level declarations

Types

Link copied to clipboard

Infix DSL for building filter queries.

Link copied to clipboard
enum Is : Enum<Is>

The value types the is operation matches, which are the eight the API documents. A value type it may add later is reachable by writing the parameter out with Query.parameter, e.g. parameter("filter_query[categories][is]", "<its name>").

Link copied to clipboard
abstract class Query

Base of the query builders, carrying what every Content Delivery API endpoint has in common: nothing beyond a way to set a parameter directly. token, version and cv are the other parameters every endpoint takes, and they belong to the Ktor plugin's configuration rather than to a single query.

Link copied to clipboard
annotation class QueryDsl

DSL marker for the StoriesQuery and FilterQueryBuilder builders, preventing accidental access to an outer builder's receiver from within a nested builder block.

Link copied to clipboard
enum SortAs : Enum<SortAs>

The ordering to apply to a sort_by field, for the StoriesQuery.sortBy overload that states it rather than deriving it from the property's type. Storyblok serializes a number field as text, so a field holding one is as likely to be modelled as a String as a Long or a Double, and its type cannot settle the ordering.

Link copied to clipboard

Builder for the query parameters of the retrieve multiple stories endpoint.

Link copied to clipboard
open class StoryQuery<T : Component> : Query

Builder for the query parameters of the retrieve a single story endpoint.