A B C D E F G H I L M O P Q R S T U V W

A

addItem(JSONObject, long, SuccessListener<Long>) - Method in class com.twilio.sync.List

Add Item to the List.

B

builder() - Static method in class com.twilio.sync.SyncClient.Properties

Builder() - Constructor for class com.twilio.sync.SyncClient.Properties.Builder

C

CLIENT_ERROR - Static variable in class com.twilio.sync.ErrorInfo

com.twilio.sync - package com.twilio.sync

create(Context, String, SyncClient.Properties, SuccessListener<SyncClient>) - Static method in class com.twilio.sync.SyncClient

Public factory method to create a new instance of Sync Client.

createProperties() - Method in class com.twilio.sync.SyncClient.Properties.Builder

createWithUniqueName(String) - Method in class com.twilio.sync.Options

Creates a new object with specified unique name, fails if the given name is already in use.

D

defaultProperties() - Static method in class com.twilio.sync.SyncClient.Properties

Use default properties to create Client without any specific configuration.

dispose() - Method in class com.twilio.sync.Document

dispose() - Method in class com.twilio.sync.DocumentObserver

dispose() - Method in class com.twilio.sync.List

dispose() - Method in class com.twilio.sync.ListIterator

dispose() - Method in class com.twilio.sync.ListObserver

dispose() - Method in class com.twilio.sync.ListPaginator

dispose() - Method in class com.twilio.sync.Map

dispose() - Method in class com.twilio.sync.MapIterator

dispose() - Method in class com.twilio.sync.MapObserver

dispose() - Method in class com.twilio.sync.MapPaginator

dispose() - Method in class com.twilio.sync.Mutator

dispose() - Method in class com.twilio.sync.Options

dispose() - Method in class com.twilio.sync.Stream

dispose() - Method in class com.twilio.sync.StreamObserver

dispose() - Method in class com.twilio.sync.SyncClient

Document - Class in com.twilio.sync

Document is an arbitrary JSON value.

DocumentObserver - Class in com.twilio.sync

Observer for all operations on a Document.

DocumentObserver() - Constructor for class com.twilio.sync.DocumentObserver

Keep default constructor, you don't need to override it.

E

ErrorInfo - Class in com.twilio.sync

Representation of a Sync Error object.

ErrorInfo(int, String) - Constructor for class com.twilio.sync.ErrorInfo

ErrorInfo(int, int, String) - Constructor for class com.twilio.sync.ErrorInfo

F

FlowID - Class in com.twilio.sync

Description of local flow identifiers, not a real type.

FlowID() - Constructor for class com.twilio.sync.FlowID

fromInt(int) - Static method in enum com.twilio.sync.Options.OpenMode

fromInt(int) - Static method in enum com.twilio.sync.Options.SynchronizationStrategy

fromInt(int) - Static method in enum com.twilio.sync.SyncClient.ConnectionState

G

getCode() - Method in class com.twilio.sync.ErrorInfo

Returns unique code for given error

getConnectionState() - Method in class com.twilio.sync.SyncClient

getData() - Method in class com.twilio.sync.Document

Get value of the document as a JSON object.

getData() - Method in class com.twilio.sync.List.Item

getData() - Method in class com.twilio.sync.Map.Item

getData() - Method in class com.twilio.sync.Stream.Message

getIndex() - Method in class com.twilio.sync.List.Item

getItem(long, long, SuccessListener<List.Item>) - Method in class com.twilio.sync.List

Retrieve contents of a given Item in the List.

getItem() - Method in class com.twilio.sync.ListIterator

getItem(String, long, SuccessListener<Map.Item>) - Method in class com.twilio.sync.Map

Retrieve Item from the Map.

getItem() - Method in class com.twilio.sync.MapIterator

getItems(SuccessListener<ListIterator>) - Method in class com.twilio.sync.List

Get iterator access to all items in the list.

getItems() - Method in class com.twilio.sync.ListPaginator

getItems(SuccessListener<MapIterator>) - Method in class com.twilio.sync.Map

Get iterator access to all items in the map.

getItems() - Method in class com.twilio.sync.MapPaginator

getKey() - Method in class com.twilio.sync.Map.Item

getMessage() - Method in class com.twilio.sync.ErrorInfo

Returns error message of given error

getOpenMode() - Method in class com.twilio.sync.Options

getPageSize() - Method in class com.twilio.sync.ListPaginator

getPageSize() - Method in class com.twilio.sync.MapPaginator

getRegion() - Method in class com.twilio.sync.SyncClient.Properties

getSdkVersion() - Static method in class com.twilio.sync.SyncClient

getSid() - Method in class com.twilio.sync.Document

Retrieves a machine-generated unique identifier for this Document.

getSid() - Method in class com.twilio.sync.List

Retrieves a machine-generated unique identifier for this List.

getSid() - Method in class com.twilio.sync.Map

Retrieves a machine-generated unique identifier for this Map.

getSid() - Method in class com.twilio.sync.Stream

getSid() - Method in class com.twilio.sync.Stream.Message

getSidOrUniqueName() - Method in class com.twilio.sync.Options

getStatus() - Method in class com.twilio.sync.ErrorInfo

Get error category as a classifier.

getSynchronizationStrategy() - Method in class com.twilio.sync.Options

getUniqueName() - Method in class com.twilio.sync.Document

Retrieves a user-set unique name for this Document.

getUniqueName() - Method in class com.twilio.sync.List

Retrieves a user-set unique name for this List.

getUniqueName() - Method in class com.twilio.sync.Map

Retrieves a user-set unique name for this Map.

getUniqueName() - Method in class com.twilio.sync.Stream

getValue() - Method in enum com.twilio.sync.Options.OpenMode

getValue() - Method in enum com.twilio.sync.Options.SynchronizationStrategy

getValue() - Method in enum com.twilio.sync.SyncClient.ConnectionState

H

hasNextPage() - Method in class com.twilio.sync.ListPaginator

hasNextPage() - Method in class com.twilio.sync.MapPaginator

hasPreviousPage() - Method in class com.twilio.sync.ListPaginator

hasPreviousPage() - Method in class com.twilio.sync.MapPaginator

I

Item(long, JSONObject) - Constructor for class com.twilio.sync.List.Item

Item(String, JSONObject) - Constructor for class com.twilio.sync.Map.Item

L

List - Class in com.twilio.sync

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

List.Item - Class in com.twilio.sync

Single item in a List.

List.PageSort - Enum in com.twilio.sync

Defines result ordering within a single paginator page.

List.QueryOptions - Class in com.twilio.sync

Defines query options for requesting items from a List.

List.QueryOrder - Enum in com.twilio.sync

Defines collection query direction (forward or backwards item listing).

ListIterator - Class in com.twilio.sync

Class for iterating over List items retrieved using List.getItems(com.twilio.sync.SuccessListener<com.twilio.sync.ListIterator>).

ListObserver - Class in com.twilio.sync

Observer for all operations on a List.

ListObserver() - Constructor for class com.twilio.sync.ListObserver

Keep default constructor, you don't need to override it.

ListPaginator - Class in com.twilio.sync

Class for paginating over List items retrieved using List.queryItems(com.twilio.sync.List.QueryOptions, com.twilio.sync.SuccessListener<com.twilio.sync.ListPaginator>).

ListPaginator.Listener - Interface in com.twilio.sync

LOGIC_ERROR - Static variable in class com.twilio.sync.ErrorInfo

Signaled to success listener if logic assumptions are violated (e.g.

M

Map - Class in com.twilio.sync

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

Map.Item - Class in com.twilio.sync

Single item in a Map.

Map.PageSort - Enum in com.twilio.sync

Defines result ordering within a single paginator page.

Map.QueryOptions - Class in com.twilio.sync

Defines query options for requesting items from a Map.

Map.QueryOrder - Enum in com.twilio.sync

Defines collection query direction (forward or backwards item listing)

MapIterator - Class in com.twilio.sync

Class for iterating over Map items retrieved using Map.getItems(com.twilio.sync.SuccessListener<com.twilio.sync.MapIterator>).

MapObserver - Class in com.twilio.sync

Observer for all operations on a Map.

MapObserver() - Constructor for class com.twilio.sync.MapObserver

Keep default constructor, you don't need to override it.

MapPaginator - Class in com.twilio.sync

Class for paginating over Map items retrieved using Map.queryItems(com.twilio.sync.Map.QueryOptions, com.twilio.sync.SuccessListener<com.twilio.sync.MapPaginator>).

MapPaginator.Listener - Interface in com.twilio.sync

Message(String, JSONObject) - Constructor for class com.twilio.sync.Stream.Message

MISMATCHING_TOKEN_UPDATE - Static variable in class com.twilio.sync.ErrorInfo

Signaled to listener of SyncClient.updateToken() if updated token does not match the original token.

mutateData(Mutator, long, SuccessListener<JSONObject>) - Method in class com.twilio.sync.Document

Mutate value of the document using provided Mutator function.

mutateItem(long, Mutator, long, SuccessListener<List.Item>) - Method in class com.twilio.sync.List

Mutate contents of a given Item in the List.

mutateItem(String, Mutator, long, SuccessListener<Map.Item>) - Method in class com.twilio.sync.Map

Mutate Item in the Map.

Mutator - Class in com.twilio.sync

Mutator is a functional object that you provide to modify entity data in a controlled manner.

Mutator() - Constructor for class com.twilio.sync.Mutator

Sole constructor.

O

onApplied(long, JSONObject) - Method in class com.twilio.sync.Mutator

Override this method to provide your own implementation of data mutator.

onConnectionStateChanged(SyncClient.ConnectionState) - Method in interface com.twilio.sync.SyncClient.ConnectionStateListener

onError(ErrorInfo) - Method in interface com.twilio.sync.ListPaginator.Listener

onError(ErrorInfo) - Method in interface com.twilio.sync.MapPaginator.Listener

onError(ErrorInfo) - Method in class com.twilio.sync.SuccessListener

Callback to report error status of an asynchronous call to the back end.

onPageLoaded(ListPaginator) - Method in interface com.twilio.sync.ListPaginator.Listener

onPageLoaded(MapPaginator) - Method in interface com.twilio.sync.MapPaginator.Listener

onRemoteCollectionRemoved() - Method in class com.twilio.sync.ListObserver

This callback is invoked when an entire List has been removed by a remote.

onRemoteCollectionRemoved() - Method in class com.twilio.sync.MapObserver

This callback is invoked when entire Map has been removed by a remote.

onRemoteItemAdded(List.Item) - Method in class com.twilio.sync.ListObserver

This callback is invoked when List item has been added by a remote.

onRemoteItemAdded(Map.Item) - Method in class com.twilio.sync.MapObserver

This callback is invoked when Map item has been added by a remote.

onRemoteItemRemoved(List.Item) - Method in class com.twilio.sync.ListObserver

This callback is invoked when List item has been removed by a remote.

onRemoteItemRemoved(Map.Item) - Method in class com.twilio.sync.MapObserver

This callback is invoked when Map item has been removed by a remote.

onRemoteItemUpdated(List.Item, List.Item) - Method in class com.twilio.sync.ListObserver

This callback is invoked when List item has been updated by a remote.

onRemoteItemUpdated(Map.Item, Map.Item) - Method in class com.twilio.sync.MapObserver

This callback is invoked when Map item has been updated by a remote.

onRemoteMessagePublished(Stream.Message) - Method in class com.twilio.sync.StreamObserver

This callback is invoked when Stream message has been added by a remote.

onRemoteRemoved() - Method in class com.twilio.sync.DocumentObserver

This callback is invoked when entire Document has been removed by a remote.

onRemoteRemoved() - Method in class com.twilio.sync.StreamObserver

This callback is invoked when entire Stream has been removed by a remote.

onRemoteUpdated(JSONObject, JSONObject) - Method in class com.twilio.sync.DocumentObserver

This callback is invoked when a Document has been modified by a remote.

onResultCollectionRemoved(long) - Method in class com.twilio.sync.ListObserver

This callback is invoked when an entire List has been removed by a local request.

onResultCollectionRemoved(long) - Method in class com.twilio.sync.MapObserver

This callback is invoked when entire Map has been removed by a local request.

onResultErrorOccurred(long, ErrorInfo) - Method in class com.twilio.sync.DocumentObserver

This callback is invoked when a Document operation has encountered a error in local request.

onResultErrorOccurred(long, ErrorInfo) - Method in class com.twilio.sync.ListObserver

This callback is invoked when a List operation has encountered an error in local request.

onResultErrorOccurred(long, ErrorInfo) - Method in class com.twilio.sync.MapObserver

This callback is invoked when a Map operation has encountered a error in local request.

onResultErrorOccurred(long, ErrorInfo) - Method in class com.twilio.sync.StreamObserver

This callback is invoked when a Stream operation has encountered a error in local request.

onResultItemAdded(long, long) - Method in class com.twilio.sync.ListObserver

This callback is invoked when List item has been added by a local request.

onResultItemRemoved(long, long) - Method in class com.twilio.sync.ListObserver

This callback is invoked when List item has been removed by a local request.

onResultItemRemoved(long, String) - Method in class com.twilio.sync.MapObserver

This callback is invoked when Map item has been removed by a local request.

onResultItemSet(long, String) - Method in class com.twilio.sync.MapObserver

This callback is invoked when Map item has been modified by a local request.

onResultItemUpdated(long, long) - Method in class com.twilio.sync.ListObserver

This callback is invoked when List item has been updated by a local request.

onResultMessagePublished(long, String) - Method in class com.twilio.sync.StreamObserver

This callback is invoked when Stream has successfully published a message.

onResultOpened(Document) - Method in class com.twilio.sync.DocumentObserver

This callback is invoked when Document object has been initialised and opened locally.

onResultOpened(List) - Method in class com.twilio.sync.ListObserver

This callback is invoked when List object has been initialised and opened locally.

onResultOpened(Map) - Method in class com.twilio.sync.MapObserver

This callback is invoked when Map object has been initialised and opened locally.

onResultOpened(Stream) - Method in class com.twilio.sync.StreamObserver

This callback is invoked when Stream object has been initialised and opened locally.

onResultRemoved(long) - Method in class com.twilio.sync.DocumentObserver

This callback is invoked when entire Document has been removed by a local request.

onResultRemoved(long) - Method in class com.twilio.sync.StreamObserver

This callback is invoked when Map item has been removed by a local request.

onResultUpdated(long) - Method in class com.twilio.sync.DocumentObserver

This callback is invoked when a Document has been modified by a local request.

onSuccess(T) - Method in class com.twilio.sync.SuccessListener

Callback to report successful status of an asynchronous call to the back end.

openDocument(Options, DocumentObserver, SuccessListener<Document>) - Method in class com.twilio.sync.SyncClient

Open or create a Document object.

openList(Options, ListObserver, SuccessListener<List>) - Method in class com.twilio.sync.SyncClient

Open or create a List object.

openMap(Options, MapObserver, SuccessListener<Map>) - Method in class com.twilio.sync.SyncClient

Open or create a Map object.

openStream(Options, StreamObserver, SuccessListener<Stream>) - Method in class com.twilio.sync.SyncClient

Open or create a Stream object.

openWithSidOrUniqueName(String) - Method in class com.twilio.sync.Options

Opens an existing object with specified SID or unique name.

Options - Class in com.twilio.sync

Options are used to pass variable information to Document, Map, List and Stream opening functions.

Options() - Constructor for class com.twilio.sync.Options

Options.OpenMode - Enum in com.twilio.sync

Options.SynchronizationStrategy - Enum in com.twilio.sync

P

publishMessage(JSONObject, long, SuccessListener<String>) - Method in class com.twilio.sync.Stream

Q

queryItems(List.QueryOptions, SuccessListener<ListPaginator>) - Method in class com.twilio.sync.List

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

queryItems(Map.QueryOptions, SuccessListener<MapPaginator>) - Method in class com.twilio.sync.Map

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

queryOptions() - Method in class com.twilio.sync.List

Provide options for querying items from the List.

queryOptions() - Method in class com.twilio.sync.Map

Provide options for querying items from the Map.

R

removeDocument(long, SuccessListener<Void>) - Method in class com.twilio.sync.Document

Remove document.

removeItem(long, long, SuccessListener<Void>) - Method in class com.twilio.sync.List

Remove Item from the List.

removeItem(String, long, SuccessListener<Void>) - Method in class com.twilio.sync.Map

Remove Item from the Map.

removeList(long, SuccessListener<Void>) - Method in class com.twilio.sync.List

Remove entire List object.

removeMap(long, SuccessListener<Void>) - Method in class com.twilio.sync.Map

Remove entire Map object.

removeStream(long, SuccessListener<Void>) - Method in class com.twilio.sync.Stream

requestNextItem(SuccessListener<ListIterator>) - Method in class com.twilio.sync.ListIterator

requestNextItem(SuccessListener<ListIterator>) - Method in class com.twilio.sync.MapIterator

requestNextPage(ListPaginator.Listener) - Method in class com.twilio.sync.ListPaginator

requestNextPage(MapPaginator.Listener) - Method in class com.twilio.sync.MapPaginator

requestPreviousPage(ListPaginator.Listener) - Method in class com.twilio.sync.ListPaginator

requestPreviousPage(MapPaginator.Listener) - Method in class com.twilio.sync.MapPaginator

S

setConnectionStateListener(SyncClient.ConnectionStateListener) - Method in class com.twilio.sync.SyncClient

Set new connection state listener on the client.

setData(JSONObject, long, SuccessListener<Void>) - Method in class com.twilio.sync.Document

Set value of the document as a JSON object.

setItem(long, JSONObject, long, SuccessListener<Void>) - Method in class com.twilio.sync.List

Set contents of a given Item in the List.

setItem(String, JSONObject, long, SuccessListener<Void>) - Method in class com.twilio.sync.Map

Set Item in the Map.

setRegion(String) - Method in class com.twilio.sync.SyncClient.Properties.Builder

shutdown() - Method in class com.twilio.sync.SyncClient

Cleanly shut down the SyncClient and free up associated resources.

Stream - Class in com.twilio.sync

Stream is an ordered message delivery queue.

Stream.Message - Class in com.twilio.sync

Single message in a Stream.

StreamObserver - Class in com.twilio.sync

Observer for all operations on a Stream.

StreamObserver() - Constructor for class com.twilio.sync.StreamObserver

Keep default constructor, you don't need to override it.

SuccessListener<T> - Class in com.twilio.sync

Interface for a generic listener object.

SuccessListener() - Constructor for class com.twilio.sync.SuccessListener

SyncClient - Class in com.twilio.sync

This is a central entity used to work with Sync.

SyncClient.ConnectionState - Enum in com.twilio.sync

Enum representing underlying twilsock connection state.

SyncClient.ConnectionStateListener - Interface in com.twilio.sync

Listener interface to receive connection state change events.

SyncClient.Properties - Class in com.twilio.sync

Specify properties for creating new Sync Client.

SyncClient.Properties.Builder - Class in com.twilio.sync

Helper class to build client properties.

T

toString() - Method in class com.twilio.sync.ErrorInfo

U

updateToken(String, SuccessListener<Void>) - Method in class com.twilio.sync.SyncClient

Update SyncClient with a refreshed token.

V

valueOf(String) - Static method in enum com.twilio.sync.List.PageSort

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.twilio.sync.List.QueryOrder

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.twilio.sync.Map.PageSort

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.twilio.sync.Map.QueryOrder

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.twilio.sync.Options.OpenMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.twilio.sync.Options.SynchronizationStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.twilio.sync.SyncClient.ConnectionState

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.twilio.sync.List.PageSort

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.twilio.sync.List.QueryOrder

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.twilio.sync.Map.PageSort

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.twilio.sync.Map.QueryOrder

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.twilio.sync.Options.OpenMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.twilio.sync.Options.SynchronizationStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.twilio.sync.SyncClient.ConnectionState

Returns an array containing the constants of this enum type, in the order they are declared.

W

withPageSize(long) - Method in class com.twilio.sync.List.QueryOptions

withPageSize(long) - Method in class com.twilio.sync.Map.QueryOptions

withPageSort(List.PageSort) - Method in class com.twilio.sync.List.QueryOptions

withPageSort(Map.PageSort) - Method in class com.twilio.sync.Map.QueryOptions

withQueryOrder(List.QueryOrder) - Method in class com.twilio.sync.List.QueryOptions

withQueryOrder(Map.QueryOrder) - Method in class com.twilio.sync.Map.QueryOptions

withStartPosition(long) - Method in class com.twilio.sync.List.QueryOptions

withStartPosition(String) - Method in class com.twilio.sync.Map.QueryOptions

withStrategy(Options.SynchronizationStrategy) - Method in class com.twilio.sync.Options

withUniqueName(String) - Method in class com.twilio.sync.Options

Creates a new object or opens an existing one with provided unique name.

withUniqueName(String, Options.OpenMode) - Method in class com.twilio.sync.Options

Creates a new object or opens an existing one with provided unique name, also given a specific opening mode.

A B C D E F G H I L M O P Q R S T U V W