query-api/me.ahoo.wow.api.query/CursorQuery

CursorQuery

class CursorQuery @InternalWowApi constructor(val filter: FilterExpression, val projection: Projection = Projection.ALL, val sort: List<Sort> = emptyList(), val size: Int = DEFAULT_SIZE, val cursor: String? = null) : Queryable<CursorQuery>

A query for the page of results after a cursor, in the order of sort, with filtering and projection (Queryable).

Constructors

@InternalWowApi

constructor(filter: FilterExpression, projection: Projection = Projection.ALL, sort: List<Sort> = emptyList(), size: Int = DEFAULT_SIZE, cursor: String? = null)

Types

object Companion

Properties

val cursor: String?

Where the page starts: the previous page's next cursor, or null for the first page.

open override val filter: FilterExpression

The filter expression the results match.

open override val projection: Projection

The fields the results include or exclude.

The most items on the page, at least 1.

open override val sort: List<Sort>

The order of the results, which the cursor follows.

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String

open override fun withFilter(newFilter: FilterExpression): CursorQuery

open override fun withProjection(newProjection: Projection): CursorQuery

Creates a new query with the specified projection.