com.twilio.sync

Interface SyncMap

public interface SyncMap

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 SyncClient.openMap(com.twilio.sync.SyncOptions, com.twilio.sync.SyncMapObserver, com.twilio.sync.SuccessListener<com.twilio.sync.SyncMap>).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SyncMap.Item Single item in a SyncMap.
static interface	SyncMap.QueryOptions Options passed while querying SyncMap objects within Sync specifying query parameters and result set position and sorting.
static class	SyncMap.QueryOrder Defines collection query direction (forward or backwards item listing)

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFINITE_DURATION Time to live for a map, specifying no expiry.

Method Summary

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

Field Detail

INFINITE_DURATION

static final int INFINITE_DURATION

Time to live for a map, specifying no expiry.

See Also:

Constant Field Values

Method Detail

getSid

java.lang.String getSid()

Retrieves a machine-generated unique identifier for this SyncMap.

Returns:

Map SID.

getUniqueName

java.lang.String getUniqueName()

Retrieves a user-set unique name for this SyncMap.

Returns:

Map Unique Name.

getDateUpdated

java.util.Date getDateUpdated()

Retrieves a Date when the Map was last updated.

Returns:

Date this Map was last updated.

getItem

void getItem(java.lang.String itemKey,
             SuccessListener<SyncMap.Item> listener)

Retrieve Item from the SyncMap.

Parameters:

itemKey - Key of the item to retrieve.

listener - Async result listener. See SuccessListener.

setItem

void setItem(java.lang.String itemKey,
             org.json.JSONObject itemData,
             SuccessListener<SyncMap.Item> listener)

Set Item in the SyncMap. Uses default metadata.

Parameters:

itemKey - Key of the item to set.

itemData - Item data to set as a JSON object.

listener - Async result listener. See SuccessListener.

setItem

void setItem(java.lang.String itemKey,
             org.json.JSONObject itemData,
             SyncMap.Item.Metadata metadata,
             SuccessListener<SyncMap.Item> listener)

Set Item in the SyncMap.

Parameters:

itemKey - Key of the item to set.

itemData - Item data to set as a JSON object.

metadata - Optional metadata for the set item, currently only ttl.

listener - Async result listener. See SuccessListener.

mutateItem

void mutateItem(java.lang.String itemKey,
                SyncMutator mutator,
                SuccessListener<SyncMap.Item> listener)

Mutate Item in the SyncMap. Uses default metadata.

Parameters:

itemKey - Key of the item to mutate.

mutator - Mutator function object.

listener - Async result listener. See SuccessListener.

See Also:

SyncMutator

mutateItem

void mutateItem(java.lang.String itemKey,
                SyncMutator mutator,
                SyncMap.Item.Metadata metadata,
                SuccessListener<SyncMap.Item> listener)

Mutate Item in the SyncMap.

Parameters:

itemKey - Key of the item to mutate.

mutator - Mutator function object.

metadata - Optional metadata for the set item, currently only ttl.

listener - Async result listener. See SuccessListener.

See Also:

SyncMutator

setTtl

void setTtl(int ttl,
            SuccessListener<java.lang.Void> listener)

Set time to live for map object in seconds.

This TTL specifies the minimum time the SyncMap will live, sometime soon after this time the object will be deleted.

If time to live is not specified, object lives infinitely long.

TTL could be used in order to auto-recycle old unused objects, but it is not recommended to build some app logic like timers using ttl.

Parameters:

ttl - Time to live in seconds from now or INFINITE_DURATION to indicate no expiry.

listener - Async result listener. See SuccessListener.

setItemTtl

void setItemTtl(java.lang.String itemKey,
                int ttl,
                SuccessListener<java.lang.Void> listener)

Set time to live for an item in list.

TTL specifies the minimum time the Item will live, sometime soon after this time the object will be deleted.

If time to live is not specified, object lives infinitely long.

TTL could be used in order to auto-recycle old unused objects, but it is not recommended to build some app logic like timers using ttl.

Parameters:

itemKey - The key of the item to adjust the ttl for.

ttl - Time to live in seconds from now or SyncMap.Item.INFINITE_DURATION to indicate no expiry.

listener - Async result listener. See SuccessListener.

removeItem

void removeItem(java.lang.String itemKey,
                SuccessListener<java.lang.Void> listener)

Remove Item from the SyncMap.

Parameters:

itemKey - Key of the item to remove.

listener - Async result listener. See SuccessListener.

getItems

void getItems(SuccessListener<SyncMapIterator> listener)

Get iterator access to all items in the map.

Parameters:

listener - Async result listener. See SuccessListener.

queryOptions

SyncMap.QueryOptions queryOptions()

Provide options for querying items from the SyncMap.

Returns:

Default query options upon which you can build.

See Also:

SyncOptions

queryItems

void queryItems(SyncMap.QueryOptions options,
                SuccessListener<SyncMapPaginator> listener)

Query paginated sequence of items from the map, based on query options. The order of items within the page is not guaranteed.

Parameters:

options - Specific query options.

listener - Async result listener. See SuccessListener.

removeMap

void removeMap(SuccessListener<java.lang.Void> listener)

Remove entire SyncMap object.

Parameters:

listener - Async result listener. See SuccessListener.