Content Delivery API Client/com.storyblok.cdn.query/StoriesQuery

StoriesQuery

class StoriesQuery<T : Component> : StoryQuery<T> (source)

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

Every documented parameter has a dedicated, type-safe entry point. Fields of your own content types are addressed by a property reference of T, Story attributes are addressed by a property reference of Story:

client.stories<Article> {
    sortBy(Article::headline)                    // sort_by=content.headline:asc
    sortByDescending(Story<*>::publishedAt)      // sort_by=published_at:desc
    filter { Article::price greaterThan 100.0 }  // filter_query[price][gt_float]=100.0
}

Type Parameters

The Component type the query is built for, whose properties the property-reference overloads accept.

Properties

bySlugs

var bySlugs: List<String>

Retrieve the stories matching these full slugs; supports * wildcards. Maps to by_slugs.

byUuids

var byUuids: List<Uuid>

Retrieve the stories with these uuids, in the API's own order. Maps to by_uuids.

byUuidsOrdered

var byUuidsOrdered: List<Uuid>

Retrieve the stories with these uuids, preserving the order given here. Maps to by_uuids_ordered.

excludingFields

var excludingFields: List<String>

Omit these content fields from the response to reduce its size. Maps to excluding_fields.

excludingIds

var excludingIds: List<Long>

Exclude the stories with these ids. Maps to excluding_ids.

excludingSlugs

var excludingSlugs: List<String>

Exclude the stories matching these full slugs; supports * wildcards. Maps to excluding_slugs.

firstPublishedAtGreaterThan

var firstPublishedAtGreaterThan: Instant?

Retrieve stories first published after this instant. Maps to first_published_at_gt.

firstPublishedAtLessThan

var firstPublishedAtLessThan: Instant?

Retrieve stories first published before this instant. Maps to first_published_at_lt.

fromRelease

var fromRelease: String?

Retrieve the story as it appears in the release with this id. Maps to from_release.

isStartpage

var isStartpage: Boolean?

Retrieve only start pages (true) or only non-start pages (false). Maps to is_startpage.

publishedAtGreaterThan

var publishedAtGreaterThan: Instant?

Retrieve stories published after this instant. Maps to published_at_gt.

publishedAtGreaterThanOrEqual

var publishedAtGreaterThanOrEqual: Instant?

Retrieve stories published at or after this instant. Maps to published_at_gte.

publishedAtLessThan

var publishedAtLessThan: Instant?

Retrieve stories published before this instant. Maps to published_at_lt.

publishedAtLessThanOrEqual

var publishedAtLessThanOrEqual: Instant?

Retrieve stories published at or before this instant. Maps to published_at_lte.

searchTerm

var searchTerm: String?

Search across all content fields, e.g. spaceship. Maps to search_term.

startsWith

var startsWith: String?

Filter by the full slug prefix, e.g. blog/posts, to retrieve the stories of a specific folder. Maps to the starts_with parameter.

updatedAtGreaterThan

var updatedAtGreaterThan: Instant?

Retrieve stories updated after this instant. Maps to updated_at_gt.

updatedAtLessThan

var updatedAtLessThan: Instant?

Retrieve stories updated before this instant. Maps to updated_at_lt.

withTag

var withTag: List<String>

Retrieve only stories carrying all of these tags. Maps to with_tag.

Functions

filter

fun filter(block: FilterQueryBuilder<T>.() -> Unit)

Configure advanced filter queries targeting the fields of your content types, e.g.:

parameter

fun parameter(name: String, value: Any)

Set a query parameter directly, for forward compatibility with parameters this SDK version does not know about yet.

sortBy

fun sortBy(field: KProperty1<in T, *>)

Sort the stories by the content field field ascending, e.g. Article::price. Call repeatedly, or alongside sortByDescending, to sort by several fields; they are applied in call order. Maps to sort_by, prefixed with content. as the API requires for content fields.

@JvmName(name = "sortByAttribute")

fun sortBy(field: KProperty1<Story<*>, *>)

Sort the stories ascending by the Story attribute field, e.g. Story<*>::publishedAt, rather than by a field of their content. Only some attributes are sortable; the API answers the rest with Not sortable by this column rather than the SDK second-guessing which those are.

fun sortBy(field: KProperty1<in T, *>, sortAs: SortAs)

Sort the stories by the content field field ascending, ordering it as sortAs states rather than as the property's type implies — for a number Storyblok holds in a text field, which is otherwise sorted as text.

sortByDescending

fun sortByDescending(field: KProperty1<in T, *>)

Sort the stories by the content field field descending, see sortBy.

@JvmName(name = "sortByAttributeDescending")

fun sortByDescending(field: KProperty1<Story<*>, *>)

Sort the stories descending by the Story attribute field, see sortBy.

fun sortByDescending(field: KProperty1<in T, *>, sortAs: SortAs)

Sort the stories by the content field field descending, ordering it as sortAs states, see sortBy.