com.twilio.sync.Map Class Reference

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

Classes
class	Item
	Single item in a Map. More...
enum	PageSort
	Defines result ordering within a single paginator page. More...
class	QueryOptions
	Defines query options for requesting items from a Map. More...
enum	QueryOrder
	Defines collection query direction (forward or backwards item listing) More...

Public Member Functions
native String	getSid ()
	Retrieves a machine-generated unique identifier for this Map. More...
native String	getUniqueName ()
	Retrieves a user-set unique name for this Map. More...
void	getItem (String itemKey, SuccessListener< Item > listener)
	Retrieve Item from the Map. More...
void	setItem (String itemKey, JSONObject itemData, SuccessListener< Item > listener)
	Set Item in the Map. More...
void	setItem (String itemKey, JSONObject itemData, Item.Metadata metadata, SuccessListener< Item > listener)
	Set Item in the Map. More...
void	mutateItem (String itemKey, Mutator mutator, SuccessListener< Item > listener)
	Mutate Item in the Map. More...
void	mutateItem (String itemKey, Mutator mutator, Item.Metadata metadata, SuccessListener< Item > listener)
	Mutate Item in the Map. More...
void	setTtl (int ttl, SuccessListener< Void > listener)
	Update the map’s time to live. More...
void	setItemTtl (String itemKey, int ttl, SuccessListener< Void > listener)
	Update the map item’s time to live. More...
void	removeItem (String itemKey, SuccessListener< Void > listener)
	Remove Item from the Map. More...
void	getItems (SuccessListener< MapIterator > listener)
	Get iterator access to all items in the map. More...
QueryOptions	queryOptions ()
	Provide options for querying items from the Map. More...
void	queryItems (QueryOptions options, SuccessListener< MapPaginator > listener)
	Query paginated sequence of items from the map, based on query options. More...
void	removeMap (SuccessListener< Void > listener)
	Remove entire Map object. More...

Detailed Description

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 SyncClient#openMap.

Member Function Documentation

void com.twilio.sync.Map.getItem	(	String	itemKey,
		SuccessListener< Item >	listener
	)

Retrieve Item from the Map.

Parameters

itemKey	Key of the item to retrieve.
listener	Async result listener. See SuccessListener.

void com.twilio.sync.Map.getItems

(

SuccessListener< MapIterator >

listener

)

Get iterator access to all items in the map.

Parameters

listener

Async result listener. See SuccessListener.

native String com.twilio.sync.Map.getSid

(

)

Retrieves a machine-generated unique identifier for this Map.

Returns

Map SID.

native String com.twilio.sync.Map.getUniqueName

(

)

Retrieves a user-set unique name for this Map.

Returns

Map Unique Name.

void com.twilio.sync.Map.mutateItem	(	String	itemKey,
		Mutator	mutator,
		SuccessListener< Item >	listener
	)

Mutate Item in the Map.

Uses default metadata.

Parameters

itemKey	Key of the item to mutate.
mutator	Mutator function object.
listener	Async result listener. See SuccessListener.

See also

Mutator

void com.twilio.sync.Map.mutateItem	(	String	itemKey,
		Mutator	mutator,
		Item.Metadata	metadata,
		SuccessListener< Item >	listener
	)

Mutate Item in the Map.

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

Mutator

void com.twilio.sync.Map.queryItems	(	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.

QueryOptions com.twilio.sync.Map.queryOptions

(

)

Provide options for querying items from the Map.

Returns

Default query options upon which you can build.

See also

Options

void com.twilio.sync.Map.removeItem	(	String	itemKey,
		SuccessListener< Void >	listener
	)

Remove Item from the Map.

Parameters

itemKey	Key of the item to remove.
listener	Async result listener. See SuccessListener.

void com.twilio.sync.Map.removeMap

(

SuccessListener< Void >

listener

)

Remove entire Map object.

Parameters

listener

Async result listener. See SuccessListener.

void com.twilio.sync.Map.setItem	(	String	itemKey,
		JSONObject	itemData,
		SuccessListener< Item >	listener
	)

Set Item in the Map.

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.

void com.twilio.sync.Map.setItem	(	String	itemKey,
		JSONObject	itemData,
		Item.Metadata	metadata,
		SuccessListener< Item >	listener
	)

Set Item in the Map.

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.

void com.twilio.sync.Map.setItemTtl	(	String	itemKey,
		int	ttl,
		SuccessListener< Void >	listener
	)

Update the map item’s time to live.

Parameters

itemKey	The key of the item to adjust the ttl for.
ttl	The new time to live for this map item in seconds from now or Item#InfiniteDuration to indicate no expiry.
listener	Async result listener. See SuccessListener.

void com.twilio.sync.Map.setTtl	(	int	ttl,
		SuccessListener< Void >	listener
	)

Update the map’s time to live.

Parameters

ttl	The new time to live for this map in seconds from now or InfiniteDuration to indicate no expiry.
listener	Async result listener. See SuccessListener.