com.twilio.sync

Class List

java.lang.Object

com.twilio.sync.List

public class List
extends java.lang.Object

List is an ordered sequence of arbitrary JSON objects as values.

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

To obtain an instance of a List use SyncClient.openList(com.twilio.sync.Options, com.twilio.sync.ListObserver, com.twilio.sync.SuccessListener<com.twilio.sync.List>).

Nested Class Summary

Nested Classes

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

Method Summary

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

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 List.

Returns:

List SID.

getUniqueName

public java.lang.String getUniqueName()

Retrieves a user-set unique name for this List.

Returns:

List Unique Name.

addItem

public void addItem(org.json.JSONObject itemData,
                    long flowId,
                    SuccessListener<java.lang.Long> listener)

Add Item to the List.

Parameters:

itemData - Item data to add as a JSON object.

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

getItem

public void getItem(long itemIndex,
                    long flowId,
                    SuccessListener<List.Item> listener)

Retrieve contents of a given Item in the List.

Parameters:

itemIndex - Index of the item to retrieve.

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

setItem

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

Set contents of a given Item in the List.

Parameters:

itemIndex - Index 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(long itemIndex,
                       Mutator mutator,
                       long flowId,
                       SuccessListener<List.Item> listener)

Mutate contents of a given Item in the List.

Parameters:

itemIndex - Index 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(long itemIndex,
                       long flowId,
                       SuccessListener<java.lang.Void> listener)

Remove Item from the List. After removing item with a given index indices of the following items will _NOT_ change.

Parameters:

itemIndex - Index of the item to remove.

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

getItems

public void getItems(SuccessListener<ListIterator> listener)

Get iterator access to all items in the list.

Parameters:

listener - Async result listener. See SuccessListener.

queryOptions

public List.QueryOptions queryOptions()

Provide options for querying items from the List.

Returns:

Default query options upon which you can build.

See Also:

Options

queryItems

public void queryItems(List.QueryOptions options,
                       SuccessListener<ListPaginator> listener)

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

Parameters:

options - Specific query options.

listener - Async result listener. See SuccessListener.

removeList

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

Remove entire List object.

Parameters:

flowId - Local flow identifier.

listener - Async result listener. See SuccessListener.

dispose

public void dispose()