Sync Android SDK/com.twilio.sync.entities/SyncList

SyncList

interface SyncList

SyncList is an ordered sequence of Item objects as values.

You can add, remove and modify values associated with each index in the list.

To obtain an instance of a SyncList use SyncClient.lists

Types

Events

interface Events

Item

data class Item(val index: Long, val data: <Error class: unknown class>, val dateCreated: <Error class: unknown class>, val dateUpdated: <Error class: unknown class>, val dateExpires: <Error class: unknown class>?)

Represents a value associated with each index in SyncList.

Properties

dateCreated

abstract val dateCreated: <Error class: unknown class>

A date when this SyncList was created.

dateExpires

abstract val dateExpires: <Error class: unknown class>?

A date this SyncList will expire, null means will not expire.

dateUpdated

abstract val dateUpdated: <Error class: unknown class>

A date when this SyncList was last updated.

events

abstract val events: SyncList.Events

Provides scope of Flows objects to get notified about events.

isFromCache

open val isFromCache: Boolean

true when this SyncList is offline and doesn't receive updates from backend, false otherwise.

isRemoved

abstract val isRemoved: Boolean

true when this SyncList has been removed on the backend, false otherwise.

sid

abstract val sid: EntitySid

An immutable system-assigned identifier of this SyncList.

subscriptionState

abstract val subscriptionState: SubscriptionState

Current subscription state.

uniqueName

abstract val uniqueName: String?

An optional unique name for this SyncList, assigned at creation time.

Functions

addItem

abstract suspend fun addItem(itemData: <Error class: unknown class>): SyncList.Item

Add Item to the SyncList.

addItem

inline suspend fun <T : Any> SyncList.addItem(itemData: T): SyncList.Item

Serializes the given value into an equivalent JsonObject using a serializer retrieved from reified type parameter and adds it as a new item to the end of the SyncList.

addItemWithTtl

abstract suspend fun addItemWithTtl(itemData: <Error class: unknown class>, ttl: <Error class: unknown class>): SyncList.Item

Add Item to the SyncList.

addItemWithTtl

inline suspend fun <T : Any> SyncList.addItemWithTtl(itemData: T, ttl: <Error class: unknown class>): SyncList.Item

Serializes the given value into an equivalent JsonObject using a serializer retrieved from reified type parameter and adds it as a new item to the end of the SyncList with a specified TTL.

abstract fun close()

Close this SyncList.

getItem

abstract suspend fun getItem(itemIndex: Long, useCache: Boolean = true): SyncList.Item?

Retrieve Item from the SyncList.

iterator

open operator fun iterator(): SyncIterator<SyncList.Item>

mutateItem

abstract suspend fun mutateItem(itemIndex: Long, mutator: suspend (<Error class: unknown class>) -> <Error class: unknown class>?): SyncList.Item

Mutate value of the existing Item using provided Mutator function.

mutateItem

inline suspend fun <T : Any> SyncList.mutateItem(itemIndex: Long, crossinline mutator: suspend (currentData: T) -> T?): SyncList.Item

Serializes the value returned by Mutator function into an equivalent JsonObject using a serializer retrieved from reified type parameter and uses the JsonObject to mutate value of the SyncList.Item

mutateItemWithTtl

abstract suspend fun mutateItemWithTtl(itemIndex: Long, ttl: <Error class: unknown class>, mutator: suspend (<Error class: unknown class>) -> <Error class: unknown class>?): SyncList.Item

Mutate value of the existing Item using provided Mutator function.

mutateItemWithTtl

inline suspend fun <T : Any> SyncList.mutateItemWithTtl(itemIndex: Long, ttl: <Error class: unknown class>, crossinline mutator: suspend (currentData: T) -> T?): SyncList.Item

Serializes the value returned by Mutator function into an equivalent JsonObject using a serializer retrieved from reified type parameter and uses the JsonObject to mutate value of the SyncList.Item

queryItems

abstract fun queryItems(startIndex: Long? = null, includeStartIndex: Boolean = true, queryOrder: <Error class: unknown class> = QueryOrder.Ascending, pageSize: Int = kDefaultPageSize, useCache: Boolean = true): SyncIterator<SyncList.Item>

Retrieve items from the SyncList.

removeItem

abstract suspend fun removeItem(itemIndex: Long)

Remove Item from the SyncList.

removeList

abstract suspend fun removeList()

Remove this SyncList.

setItem

abstract suspend fun setItem(itemIndex: Long, itemData: <Error class: unknown class>): SyncList.Item

Set Item in the SyncList.

setItem

inline suspend fun <T : Any> SyncList.setItem(itemIndex: Long, itemData: T): SyncList.Item

Serializes the given value into an equivalent JsonObject using a serializer retrieved from reified type parameter and set it as value of the SyncList.Item.

setItemWithTtl

abstract suspend fun setItemWithTtl(itemIndex: Long, itemData: <Error class: unknown class>, ttl: <Error class: unknown class>): SyncList.Item

Set Item in the SyncList.

setTtl

abstract suspend fun setTtl(ttl: <Error class: unknown class>)

Set time to live for this SyncList.

use

inline fun <R> SyncList.use(block: (SyncList) -> R): R

Executes the given block function on SyncList and then closes it down correctly whether an exception is thrown or not.