TWSListQueryOptions Class Reference

Inherits from	NSObject
Declared in	TWSListQueryOptions.h

Overview

Options passed while querying List objects within Sync specifying query parameters and result set position and sorting.

`startPosition`

The starting position for the query.

@property (readonly) TWSItemIndex startPosition

Discussion

The starting position for the query.

Declared In

TWSListQueryOptions.h

`queryOrder`

The ordering of the query.

@property (readonly) TWSQueryOrder queryOrder

Discussion

The ordering of the query.

Declared In

TWSListQueryOptions.h

`pageSize`

The maximum size of the page returned by the query.

@property (readonly) NSUInteger pageSize

Discussion

The maximum size of the page returned by the query.

Declared In

TWSListQueryOptions.h

`– withStartPosition:`

Specifies the initial position of the query. Results will be inclusive of the item as this position, if specified and if it exists.

- (nonnull instancetype)withStartPosition:(TWSItemIndex)startPosition

Parameters

`startPosition`	The starting position for the query.

Return Value

This object for optional method chaining.

Discussion

Specifies the initial position of the query. Results will be inclusive of the item as this position, if specified and if it exists.

Declared In

TWSListQueryOptions.h

`– withQueryOrder:`

Specifies the ordering (i.e. direction) of the query. If no starting position is provided, ascending will execute the query from beginning and descending will execute the query from the end.

- (nonnull instancetype)withQueryOrder:(TWSQueryOrder)queryOrder

Parameters

`queryOrder`	The ordering of the query.

Return Value

This object for optional method chaining.

Discussion

Specifies the ordering (i.e. direction) of the query. If no starting position is provided, ascending will execute the query from beginning and descending will execute the query from the end.

Declared In

TWSListQueryOptions.h

`– withPageSize:`

Specifies the maximum size of the page returned by the query. The page may contain less items when approaching the end of collection.

- (nonnull instancetype)withPageSize:(NSUInteger)pageSize

Parameters

`pageSize`	The maximum size of the page returned by the query.

Return Value

This object for optional method chaining.

Discussion

Specifies the maximum size of the page returned by the query. The page may contain less items when approaching the end of collection.

Declared In

TWSListQueryOptions.h