stories

abstract fun stories(config: PagingConfig = PagingConfig(pageSize = 25), resolveLevel: Int = 1, query: StoriesQuery<Component>.() -> Unit = {}): Pager<Int, Story<Component>>(source)

Retrieves multiple stories as a PagingData stream.

Return

A Pager whose flow emits the stories with Component content, with potential cached and fresh values.

Parameters

config

The Paging configuration; its pageSize maps to the API's per_page, defaults to 25.

resolveLevel

How deeply nested Story relations are resolved, see story.

query

Configures the query parameters via the StoriesQuery DSL.


abstract fun <T : Component> stories(config: PagingConfig, typeInfo: TypeInfo, resolveLevel: Int = 1, query: StoriesQuery<T>.() -> Unit = {}): Pager<Int, Story<T>>(source)

Retrieves multiple stories as a PagingData stream with explicit type information for the Component type.

Return

A Pager whose flow emits the stories, with potential cached and fresh values.

Parameters

config

The Paging configuration; its pageSize maps to the API's per_page, defaults to 25.

typeInfo

Type information for deserialization; must describe a Story<T>.

resolveLevel

How deeply nested Story relations are resolved, see story.

query

Configures the query parameters via the StoriesQuery DSL.

Type Parameters

T

The Component type of the stories' content.