Sync Android SDK for Java/com.twilio.sync.client.java/ListsJava/queryListItems

queryListItems

open fun queryListItems(listSidOrUniqueName: String): SyncIteratorJava<SyncListJava.Item>

Retrieve all items from the SyncListJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncListJava.

Parameters

listSidOrUniqueName

SID or unique name of existing SyncListJava.

open fun queryListItems(listSidOrUniqueName: String, startIndex: Long): SyncIteratorJava<SyncListJava.Item>

Retrieve items from the SyncListJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncListJava.

Parameters

listSidOrUniqueName

SID or unique name of existing SyncListJava.

startIndex

Index of the first item to retrieve.

open fun queryListItems(listSidOrUniqueName: String, startIndex: Long, includeStartIndex: Boolean): SyncIteratorJava<SyncListJava.Item>

Retrieve items from the SyncListJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncListJava.

Parameters

listSidOrUniqueName

SID or unique name of existing SyncListJava.

startIndex

Index of the first item to retrieve.

includeStartIndex

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

open fun queryListItems(listSidOrUniqueName: String, startIndex: Long?, includeStartIndex: Boolean, queryOrder: <Error class: unknown class>): SyncIteratorJava<SyncListJava.Item>

Retrieve items from the SyncListJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncListJava.

Parameters

listSidOrUniqueName

SID or unique name of existing SyncListJava.

startIndex

Index of the first item to retrieve, null means start from the first item in the SyncListJava.

includeStartIndex

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

queryOrder

QueryOrder for sorting results.

open fun queryListItems(listSidOrUniqueName: String, startIndex: Long?, includeStartIndex: Boolean, queryOrder: <Error class: unknown class>, pageSize: Int): SyncIteratorJava<SyncListJava.Item>

Retrieve items from the SyncListJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncListJava.

Parameters

listSidOrUniqueName

SID or unique name of existing SyncListJava.

startIndex

Index of the first item to retrieve, null means start from the first item in the SyncListJava.

includeStartIndex

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

queryOrder

QueryOrder for sorting results.

pageSize

Page size for querying items from backend.

abstract fun queryListItems(listSidOrUniqueName: String, startIndex: Long?, includeStartIndex: Boolean, queryOrder: <Error class: unknown class>, pageSize: Int, useCache: Boolean): SyncIteratorJava<SyncListJava.Item>

Retrieve items from the SyncListJava without opening it.

Return

New SyncIteratorJava to sequentially access the elements from this SyncListJava.

Parameters

listSidOrUniqueName

SID or unique name of existing SyncListJava.

startIndex

Index of the first item to retrieve, null means start from the first item in the SyncListJava.

includeStartIndex

When true - result includes the item with the startIndex. When false - the item with the startIndex is skipped. Ignored when startIndex = 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.