Sync Android SDK/com.twilio.sync/SyncMap

SyncMap

interface SyncMap
Content copied to clipboard

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 SyncMap use openMap.

Types

Link copied to clipboard
interface Item
Content copied to clipboard
Single item in a SyncMap.
Link copied to clipboard
interface QueryOptions
Content copied to clipboard
Options passed while querying SyncMap objects within Sync specifying query parameters and result set position and sorting.
Link copied to clipboard
enum QueryOrder
Content copied to clipboard
Defines collection query direction (forward or backwards item listing)

Functions

Link copied to clipboard
abstract fun getDateUpdated(): Date
Content copied to clipboard
Retrieves a Date when the Map was last updated.
Link copied to clipboard
abstract fun getItem(itemKey: String, listener: SuccessListener<SyncMap.Item>)
Content copied to clipboard
Retrieve Item from the SyncMap.
Link copied to clipboard
abstract fun getItems(listener: SuccessListener<SyncMapIterator>)
Content copied to clipboard
Get iterator access to all items in the map.
Link copied to clipboard
abstract fun getSid(): String
Content copied to clipboard
Retrieves a machine-generated unique identifier for this SyncMap.
Link copied to clipboard
abstract fun getUniqueName(): String
Content copied to clipboard
Retrieves a user-set unique name for this SyncMap.
Link copied to clipboard
abstract fun mutateItem(    itemKey: String,     mutator: SyncMutator,     listener: SuccessListener<SyncMap.Item>)
Content copied to clipboard
abstract fun mutateItem(    itemKey: String,     mutator: SyncMutator,     metadata: SyncMap.Item.Metadata,     listener: SuccessListener<SyncMap.Item>)
Content copied to clipboard
Mutate Item in the SyncMap.
Link copied to clipboard
abstract fun queryItems(options: SyncMap.QueryOptions, listener: SuccessListener<SyncMapPaginator>)
Content copied to clipboard
Query paginated sequence of items from the map, based on query options.
Link copied to clipboard
abstract fun queryOptions(): SyncMap.QueryOptions
Content copied to clipboard
Provide options for querying items from the SyncMap.
Link copied to clipboard
abstract fun removeItem(itemKey: String, listener: SuccessListener<Void>)
Content copied to clipboard
Remove Item from the SyncMap.
Link copied to clipboard
abstract fun removeMap(listener: SuccessListener<Void>)
Content copied to clipboard
Remove entire SyncMap object.
Link copied to clipboard
abstract fun setItem(    itemKey: String,     itemData: JSONObject,     listener: SuccessListener<SyncMap.Item>)
Content copied to clipboard
abstract fun setItem(    itemKey: String,     itemData: JSONObject,     metadata: SyncMap.Item.Metadata,     listener: SuccessListener<SyncMap.Item>)
Content copied to clipboard
Set Item in the SyncMap.
Link copied to clipboard
abstract fun setItemTtl(    itemKey: String,     ttl: Int,     listener: SuccessListener<Void>)
Content copied to clipboard
Set time to live for an item in list.
Link copied to clipboard
abstract fun setTtl(ttl: Int, listener: SuccessListener<Void>)
Content copied to clipboard
Set time to live for map object in seconds.

Properties

Link copied to clipboard
val INFINITE_DURATION: Int
Content copied to clipboard
Time to live for a map, specifying no expiry.