Sync Android SDK for Java/com.twilio.sync.client.java/MapsJava/queryMapItems

queryMapItems

open fun queryMapItems(mapSidOrUniqueName: String): SyncIteratorJava<SyncMapJava.Item>

Retrieve all items from the SyncMapJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncMapJava.

Parameters

mapSidOrUniqueName

SID or unique name of existing SyncMapJava.

open fun queryMapItems(mapSidOrUniqueName: String, startKey: String): SyncIteratorJava<SyncMapJava.Item>

Retrieve items from the SyncMapJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncMapJava.

Parameters

mapSidOrUniqueName

SID or unique name of existing SyncMapJava.

startKey

Key of the first item to retrieve.

open fun queryMapItems(mapSidOrUniqueName: String, startKey: String, includeStartKey: Boolean): SyncIteratorJava<SyncMapJava.Item>

Retrieve items from the SyncMapJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncMapJava.

Parameters

mapSidOrUniqueName

SID or unique name of existing SyncMapJava.

startKey

Key of the first item to retrieve.

includeStartKey

When true - result includes the item with the startKey When false - the item with the startKey is skipped.

open fun queryMapItems(mapSidOrUniqueName: String, startKey: String?, includeStartKey: Boolean, queryOrder: <Error class: unknown class>): SyncIteratorJava<SyncMapJava.Item>

Retrieve items from the SyncMapJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncMapJava.

Parameters

mapSidOrUniqueName

SID or unique name of existing SyncMapJava.

startKey

Key of the first item to retrieve, null means start from the first item in the SyncMapJava.

includeStartKey

When true - result includes the item with the startKey. When false - the item with the startKey is skipped. Ignored when startKey = null

queryOrder

QueryOrder for sorting results.

open fun queryMapItems(mapSidOrUniqueName: String, startKey: String?, includeStartKey: Boolean, queryOrder: <Error class: unknown class>, pageSize: Int): SyncIteratorJava<SyncMapJava.Item>

Retrieve items from the SyncMapJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncMapJava.

Parameters

mapSidOrUniqueName

SID or unique name of existing SyncMapJava.

startKey

Key of the first item to retrieve, null means start from the first item in the SyncMapJava.

includeStartKey

When true - result includes the item with the startKey. When false - the item with the startKey is skipped. Ignored when startKey = null

queryOrder

QueryOrder for sorting results.

pageSize

Page size for querying items from backend.

abstract fun queryMapItems(mapSidOrUniqueName: String, startKey: String?, includeStartKey: Boolean, queryOrder: <Error class: unknown class>, pageSize: Int, useCache: Boolean): SyncIteratorJava<SyncMapJava.Item>

Retrieve items from the SyncMapJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncMapJava.

Parameters

mapSidOrUniqueName

SID or unique name of existing SyncMapJava.

startKey

Key of the first item to retrieve, null means start from the first item in the SyncMapJava.

includeStartKey

When true - result includes the item with the startKey. When false - the item with the startKey is skipped. Ignored when startKey = null

queryOrder

QueryOrder for sorting results.

pageSize

Page size for querying items from backend.

useCache

When true returns cached value if found in cache. When false - performs network request to get latest data from backend.