query Items
abstract fun queryItems(startKey: String? = null, includeStartKey: Boolean = true, queryOrder: <Error class: unknown class> = QueryOrder.Ascending, pageSize: Int = kDefaultPageSize, useCache: Boolean = true): SyncIterator<SyncMap.Item>
Retrieve items from the SyncMap.
Return
New SyncIterator to sequentially access the elements from this SyncMap.
Parameters
start Key
Key of the first item to retrieve, null
means start from the first item in the SyncMap.
include Start Key
When true
- result includes the item with the startKey (if exists in the SyncMap). When false
- the item with the startKey is skipped. Ignored when startKey = null
query Order
QueryOrder for sorting results.
page Size
Page size for querying items from backend.
use Cache
When true
returns cached value if found in cache. Collect Events.onItemUpdated and Events.onItemRemoved to receive notifications about the item changes. When false
- performs network request to get latest data from backend.