[]
        
(Showing Draft Content)

C1.DataCollection.C1CursorDataCollection-2.GetPageAsync

GetPageAsync Method

GetPageAsync(int, K?, int?, IReadOnlyList<SortDescription>?, FilterExpression?, CancellationToken)

When overridden in an inherited class it returns the items in the page as well as a token to the next page.

Declaration
protected abstract Task<Tuple<K?, IReadOnlyList<T>>> GetPageAsync(int startingIndex, K? pageToken, int? count = null, IReadOnlyList<SortDescription>? sortDescriptions = null, FilterExpression? filterExpression = null, CancellationToken cancellationToken = default)
Protected MustOverride Function GetPageAsync(startingIndex As Integer, pageToken As K, Optional count As Integer? = Nothing, Optional sortDescriptions As IReadOnlyList(Of SortDescription) = Nothing, Optional filterExpression As FilterExpression = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Tuple(Of K, IReadOnlyList(Of T)))
Parameters
Type Name Description
int startingIndex

The index where the returned items will be inserted.

K pageToken

The token of the requesting page, pass null if no pages had been requested so far.

int? count

The desired number of items to be returned.

IReadOnlyList<SortDescription> sortDescriptions

The sort descriptions.

FilterExpression filterExpression

The filter expression.

CancellationToken cancellationToken

Cancellation token.

Returns
Type Description
Task<Tuple<K, IReadOnlyList<T>>>

A tuple containing the items and a token to the next page.