Viaduct Tenant API/viaduct.api.types/BackwardConnectionArguments

BackwardConnectionArguments

interface BackwardConnectionArguments : ConnectionArguments(source)

Arguments for backward pagination through a connection.

The offset/limit math and validation are delegated to the language-neutral ConnectionArgumentsSupport so the Kotlin and Java Tenant APIs stay in lockstep.

See also

Inheritors

Properties

Link copied to clipboard
abstract val before: String?

Cursor to start fetching items before (exclusive).

Link copied to clipboard
abstract val last: Int?

Maximum number of items to return from the end.

Functions

Link copied to clipboard
open override fun requiresTotalCountForOffsetLimit(): Boolean

Returns true if backward pagination needs the total count to resolve the starting offset.

Link copied to clipboard
open override fun toOffsetLimit(defaultPageSize: Int): OffsetLimit

Converts backward pagination arguments to offset/limit.

open override fun toOffsetLimit(totalCount: Int, defaultPageSize: Int): OffsetLimit

Converts backward pagination arguments to offset/limit when the total count is known.

Link copied to clipboard
open override fun validate()

Validates backward pagination arguments.