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

SyncMapJava

interface SyncMapJava : Listenable<SyncMapJava.Listener>

SyncMap is a key-value store with Strings as keys and arbitrary JSON objects as values.

You can add, remove and modify values associated with the keys.

To obtain an instance of a SyncMapJava use SyncClientJava.maps

Types

data class Item(val key: String, val jsonData: String, val dateCreated: Long, val dateUpdated: Long, val dateExpires: Long?)

Represents a value associated with each key in SyncMapJava.

Listener

interface Listener

Listener for all operations on a SyncMapJava.

Properties

dateCreated

abstract val dateCreated: Long

A date when this SyncMapJava was created.

dateExpires

abstract val dateExpires: Long?

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

dateUpdated

abstract val dateUpdated: Long

A date when this SyncMapJava was last updated.

isFromCache

abstract val isFromCache: Boolean

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

isRemoved

abstract val isRemoved: Boolean

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

sid

abstract val sid: String

An immutable system-assigned identifier of this SyncMapJava.

subscriptionState

abstract val subscriptionState: SubscriptionStateJava

Current subscription state.

uniqueName

abstract val uniqueName: String?

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

Functions

addListener

abstract override fun addListener(listener: SyncMapJava.Listener)

Method to add listener for this SyncMapJava.

abstract fun close()

Close this SyncMapJava.

getItem

abstract fun getItem(itemKey: String, callback: SuccessListener<SyncMapJava.Item?>): CancellationToken

Retrieve Item from the SyncMapJava.

mutateItem

abstract fun mutateItem(itemKey: String, mutator: SyncMutator, callback: SuccessListener<SyncMapJava.Item>): CancellationToken

Mutate value of the Item using provided Mutator function.

mutateItemWithTtl

abstract fun mutateItemWithTtl(itemKey: String, ttlSeconds: Long, mutator: SyncMutator, callback: SuccessListener<SyncMapJava.Item>): CancellationToken

Mutate value of the Item using provided Mutator function.

queryItems

open fun queryItems(): SyncIteratorJava<SyncMapJava.Item>

Retrieve all items from the SyncMap.

open fun queryItems(startKey: String): SyncIteratorJava<SyncMapJava.Item>

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

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

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

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

Retrieve items from the SyncMapJava.

removeAllListeners

abstract override fun removeAllListeners()

Method to remove all listeners from this SyncMapJava.

removeItem

abstract fun removeItem(itemKey: String, callback: SuccessListener<SyncMapJava>): CancellationToken

Remove Item from the SyncMapJava.

removeListener

abstract override fun removeListener(listener: SyncMapJava.Listener)

Method to Method to remove listener from this SyncMapJava.

removeMap

abstract fun removeMap(callback: SuccessListener<SyncMapJava>): CancellationToken

Remove this SyncMapJava.

setItem

abstract fun setItem(itemKey: String, jsonData: String, callback: SuccessListener<SyncMapJava.Item>): CancellationToken

Set Item in the SyncMapJava.

setItemWithTtl

abstract fun setItemWithTtl(itemKey: String, jsonData: String, ttlSeconds: Long, callback: SuccessListener<SyncMapJava.Item>): CancellationToken

Set Item in the SyncMapJava.

setTtl

abstract fun setTtl(ttlSeconds: Long, callback: SuccessListener<SyncMapJava>): CancellationToken

Set time to live for this SyncMapJava.