mutate Item With Ttl
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.
The Mutator function could be invoked more than once in case of data collision, i.e. if data on backend is modified while the mutate operation is executing. It guarantees that Mutator generates new value based on latest item data.
Possible use case is to implement distributed counter:
@Serializable
data class Counter(val value: Long = 0) {
operator fun plus(x: Long) = Counter(value + x)
}
list.mutateItemWithTtl<Counter>(itemIndex = 0, ttl = 1.days) { counter -> counter + 1 }
Content copied to clipboard
Return
Item which has been set during mutation.
Parameters
item Index
Index of the item to mutate.
ttl
Time to live from now or Duration.INFINITE to indicate no expiry.
mutator
Mutator which will be applied to the list item.
This function will be provided with the
previous data contents and should return new desired contents or null to abort
mutate operation. This function is invoked on a background thread.
Content copied to clipboard
Throws
Twilio Exception
When error occurred while mutating the Item.