com.twilio.sync

Interface SyncDocument

public interface SyncDocument

SyncDocument is an arbitrary JSON value.

You can set, get and modify this value.

To obtain an instance of a SyncDocument use SyncClient.openDocument(com.twilio.sync.SyncOptions, com.twilio.sync.SyncDocumentObserver, com.twilio.sync.SuccessListener<com.twilio.sync.SyncDocument>).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SyncDocument.Metadata

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	getData() Get value of the document as a JSON object.
java.util.Date	getDateUpdated() Retrieves a Date when the Document was last updated.
java.lang.String	getSid() Retrieves a machine-generated unique identifier for this SyncDocument.
java.lang.String	getUniqueName() Retrieves a user-set unique name for this SyncDocument.
void	mutateData(SyncMutator mutator, SuccessListener<org.json.JSONObject> listener) Mutate value of the document using provided Mutator function.
void	mutateData(SyncMutator mutator, SyncDocument.Metadata metadata, SuccessListener<org.json.JSONObject> listener) Mutate value of the document using provided Mutator function.
void	removeDocument(SuccessListener<java.lang.Void> listener) Remove document.
void	setData(org.json.JSONObject data, SuccessListener<org.json.JSONObject> listener) Set value of the document as a JSON object.
void	setData(org.json.JSONObject data, SyncDocument.Metadata metadata, SuccessListener<org.json.JSONObject> listener) Set value of the document as a JSON object.
void	setTtl(int ttl, SuccessListener<java.lang.Void> listener) Set time to live for document object in seconds.

Field Detail

INFINITE_DURATION

static final int INFINITE_DURATION

Time to live for a document, specifying no expiry.

See Also:

Constant Field Values

Method Detail

getSid

java.lang.String getSid()

Retrieves a machine-generated unique identifier for this SyncDocument.

Returns:

Document SID.

getUniqueName

java.lang.String getUniqueName()

Retrieves a user-set unique name for this SyncDocument.

Returns:

Document Unique Name.

getDateUpdated

java.util.Date getDateUpdated()

Retrieves a Date when the Document was last updated.

Returns:

Date this Document was last updated.

getData

org.json.JSONObject getData()

Get value of the document as a JSON object.

Returns:

Document value.

setData

void setData(org.json.JSONObject data,
             SuccessListener<org.json.JSONObject> listener)

Set value of the document as a JSON object. Uses default metadata.

Parameters:

data - New document data.

listener - Async result listener. See SuccessListener.

setData

void setData(org.json.JSONObject data,
             SyncDocument.Metadata metadata,
             SuccessListener<org.json.JSONObject> listener)

Set value of the document as a JSON object.

Parameters:

data - New document data.

metadata - Optional metadata for the updated document, currently only ttl.

listener - Async result listener. See SuccessListener.

mutateData

void mutateData(SyncMutator mutator,
                SuccessListener<org.json.JSONObject> listener)

Mutate value of the document using provided Mutator function. Uses default metadata.

Parameters:

mutator - Mutator which will be applied to document data.

listener - Async result listener. See SuccessListener.

mutateData

void mutateData(SyncMutator mutator,
                SyncDocument.Metadata metadata,
                SuccessListener<org.json.JSONObject> listener)

Mutate value of the document using provided Mutator function.

Parameters:

mutator - Mutator which will be applied to document data.

metadata - Optional metadata for the updated document, currently only ttl.

listener - Async result listener. See SuccessListener.

setTtl

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

Set time to live for document object in seconds.

This TTL specifies the minimum time the SyncDocument 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.

removeDocument

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

Remove document.

Parameters:

listener - Async result listener. See SuccessListener.