com.twilio.sync

Interface SyncMap.QueryOptions

Enclosing interface:

SyncMap

public static interface SyncMap.QueryOptions

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

Method Summary

Modifier and Type	Method and Description
SyncMap.QueryOptions	withPageSize(long size) Specifies the maximum size of the page returned by the query.
SyncMap.QueryOptions	withQueryOrder(SyncMap.QueryOrder order) Specifies the ordering (i.e.
SyncMap.QueryOptions	withStartPosition(java.lang.String key) Specifies the initial position of the query.

Method Detail

withStartPosition

SyncMap.QueryOptions withStartPosition(java.lang.String key)

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

Parameters:

key - The starting map key position for the query.

Returns:

This object for optional method chaining.

withQueryOrder

SyncMap.QueryOptions withQueryOrder(SyncMap.QueryOrder order)

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.

Parameters:

order - The ordering of the query.

Returns:

This object for optional method chaining.

withPageSize

SyncMap.QueryOptions withPageSize(long size)

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

Parameters:

size - The maximum size of the page returned by the query.

Returns:

This object for optional method chaining.