com.twilio.sync

Class Map

java.lang.Object

com.twilio.sync.Map

public class Map
extends java.lang.Object

Map 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 Map use Client#openMap.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Map.Item Single item in a Map.
static class	Map.PageSort Defines result ordering within a single paginator page.
static class	Map.QueryOptions Defines query options for requesting items from a Map.
static class	Map.QueryOrder Defines collection query direction (forward or backwards item listing)

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	getItem(java.lang.String itemKey, long flowId, SuccessListener<Map.Item> listener) Retrieve Item from the Map.
void	getItems(SuccessListener<MapIterator> listener) Get iterator access to all items in the map.
java.lang.String	getSid() Retrieves a machine-generated unique identifier for this Map.
java.lang.String	getUniqueName() Retrieves a user-set unique name for this Map.
void	mutateItem(java.lang.String itemKey, Mutator mutator, long flowId, SuccessListener<Map.Item> listener) Mutate Item in the Map.
void	queryItems(Map.QueryOptions options, SuccessListener<MapPaginator> listener) Query paginated sequence of items from the map, based on query options.
Map.QueryOptions	queryOptions() Provide options for querying items from the Map.
void	removeItem(java.lang.String itemKey, long flowId, SuccessListener<java.lang.Void> listener) Remove Item from the Map.
void	removeMap(long flowId, SuccessListener<java.lang.Void> listener) Remove entire Map object.
void	setItem(java.lang.String itemKey, org.json.JSONObject itemData, long flowId, SuccessListener<java.lang.Void> listener) Set Item in the Map.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSid

public java.lang.String getSid()

Retrieves a machine-generated unique identifier for this Map.

Returns:

Map SID.

getUniqueName

public java.lang.String getUniqueName()

Retrieves a user-set unique name for this Map.

Returns:

Map Unique Name.

getItem

public void getItem(java.lang.String itemKey,
                    long flowId,
                    SuccessListener<Map.Item> listener)

Retrieve Item from the Map.

Parameters:

itemKey - Key of the item to retrieve.

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

setItem

public void setItem(java.lang.String itemKey,
                    org.json.JSONObject itemData,
                    long flowId,
                    SuccessListener<java.lang.Void> listener)

Set Item in the Map.

Parameters:

itemKey - Key of the item to set.

itemData - Item data to set as a JSON object.

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

mutateItem

public void mutateItem(java.lang.String itemKey,
                       Mutator mutator,
                       long flowId,
                       SuccessListener<Map.Item> listener)

Mutate Item in the Map.

Parameters:

itemKey - Key of the item to mutate.

mutator - Mutator function object.

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

See Also:

Mutator

removeItem

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

Remove Item from the Map.

Parameters:

itemKey - Key of the item to remove.

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

getItems

public void getItems(SuccessListener<MapIterator> listener)

Get iterator access to all items in the map.

Parameters:

listener - Async result listener. See SuccessListener.

queryOptions

public Map.QueryOptions queryOptions()

Provide options for querying items from the Map.

Returns:

Default query options upon which you can build.

See Also:

Options

queryItems

public void queryItems(Map.QueryOptions options,
                       SuccessListener<MapPaginator> listener)

Query paginated sequence of items from the map, based on query options.

Parameters:

options - Specific query options.

listener - Async result listener. See SuccessListener.

removeMap

public void removeMap(long flowId,
                      SuccessListener<java.lang.Void> listener)

Remove entire Map object.

Parameters:

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

dispose

public void dispose()