Viaduct Tenant API/viaduct.api.types/MultidirectionalConnectionArguments

MultidirectionalConnectionArguments

interface MultidirectionalConnectionArguments : ForwardConnectionArguments, BackwardConnectionArguments(source)

Arguments for connections that expose all four pagination args ([first], [after], [last], [before]).

Forward args take precedence over backward in toOffsetLimit; passing neither returns the first page at the default size. Forward and backward args cannot be mixed in the same request.

Prefer ForwardConnectionArguments or BackwardConnectionArguments when only one direction is needed.

Functions

requiresTotalCountForOffsetLimit

open override fun requiresTotalCountForOffsetLimit(): Boolean

Returns true if backward pagination is active (last/before) and requires total count.

toOffsetLimit

open override fun toOffsetLimit(defaultPageSize: Int): OffsetLimit

Converts multidirectional pagination arguments to offset/limit.

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

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

validate

open override fun validate()

Validates multidirectional pagination arguments.