com.twilio.sync

Interface SyncOptions

public interface SyncOptions

SyncOptions are used to pass variable information to SyncDocument, SyncMap, SyncList and SyncStream opening functions.

• SyncClient.openDocument(com.twilio.sync.SyncOptions, com.twilio.sync.SyncDocumentObserver, com.twilio.sync.SuccessListener<com.twilio.sync.SyncDocument>)
• SyncClient.openMap(com.twilio.sync.SyncOptions, com.twilio.sync.SyncMapObserver, com.twilio.sync.SuccessListener<com.twilio.sync.SyncMap>)
• SyncClient.openList(com.twilio.sync.SyncOptions, com.twilio.sync.SyncListObserver, com.twilio.sync.SuccessListener<com.twilio.sync.SyncList>)
• SyncClient.openStream(com.twilio.sync.SyncOptions, com.twilio.sync.SyncStreamObserver, com.twilio.sync.SuccessListener<com.twilio.sync.SyncStream>)

Typical usage pattern: new SyncOptions().withUniqueName("myName")

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SyncOptions.OpenMode
static class	SyncOptions.SynchronizationStrategy

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static SyncOptions	create() Public factory method to create a new instance of SyncOptions.
SyncOptions	createWithUniqueName(java.lang.String uniqueName) Creates a new object with specified unique name, fails if the given name is already in use.
SyncOptions.OpenMode	getOpenMode()
java.lang.String	getSidOrUniqueName()
SyncOptions.SynchronizationStrategy	getSynchronizationStrategy()
int	getTtl()
SyncOptions	openWithSidOrUniqueName(java.lang.String sidOrUniqueName) Opens an existing object with specified SID or unique name.
SyncOptions	withStrategy(SyncOptions.SynchronizationStrategy strategy) Set SyncOptions.SynchronizationStrategy the Sync object.
SyncOptions	withTtl(int ttl) Set time to live for the Sync object in seconds.
SyncOptions	withUniqueName(java.lang.String uniqueName) Creates a new object or opens an existing one with provided unique name.
SyncOptions	withUniqueName(java.lang.String uniqueName, SyncOptions.OpenMode mode) Creates a new object or opens an existing one with provided unique name, also given a specific opening mode.

Field Detail

INFINITE_DURATION

static final int INFINITE_DURATION

Time to live for a Sync object, specifying no expiry.

See Also:

Constant Field Values

Method Detail

create

static SyncOptions create()

Public factory method to create a new instance of SyncOptions.

Returns:

new SyncOptions object.

createWithUniqueName

SyncOptions createWithUniqueName(java.lang.String uniqueName)

Creates a new object with specified unique name, fails if the given name is already in use. This method is the same as withUniqueName(String, OpenMode) with SyncOptions.OpenMode.CREATE_NEW mode.

Parameters:

uniqueName - Unique name to assign to entity upon creation.

Returns:

Self for chaining.

withUniqueName

SyncOptions withUniqueName(java.lang.String uniqueName)

Creates a new object or opens an existing one with provided unique name. This method is the same as withUniqueName(String, OpenMode) with SyncOptions.OpenMode.OPEN_OR_CREATE mode.

Parameters:

uniqueName - Unique name to find existing entity or to assign to new entity upon creation.

Returns:

Self for chaining.

withUniqueName

SyncOptions withUniqueName(java.lang.String uniqueName,
                           SyncOptions.OpenMode mode)

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

Parameters:

uniqueName - Unique name to find existing entity or to assign to new entity upon creation.

mode - Open mode, one of the constants SyncOptions.OpenMode.

Returns:

Self for chaining.

openWithSidOrUniqueName

SyncOptions openWithSidOrUniqueName(java.lang.String sidOrUniqueName)

Opens an existing object with specified SID or unique name. Implementation will automatically detect whether a SID or a unique name has been provided, and behave accordingly. This method is the same as withUniqueName(String, OpenMode) with SyncOptions.OpenMode.OPEN_EXISTING mode.

Parameters:

sidOrUniqueName - SID or unique name to find existing entity or to assign to new entity upon creation.

Returns:

Self for chaining.

withStrategy

SyncOptions withStrategy(SyncOptions.SynchronizationStrategy strategy)

Set SyncOptions.SynchronizationStrategy the Sync object.

Parameters:

strategy - SyncOptions.SynchronizationStrategy to assign to new entity.

Returns:

Self for chaining.

withTtl

SyncOptions withTtl(int ttl)

Set time to live for the Sync object in seconds.

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

This setting works with all object types, however note that it is applicable only when creating an object. When (re)opening an existing object, new TTL is not applied, and instead an old setting is retained, in order to avoid unexpected read-only object change.

Parameters:

ttl - Time to live in seconds from now or INFINITE_DURATION to indicate no expiry.

getSidOrUniqueName

java.lang.String getSidOrUniqueName()

Returns:

SID or unique name.

getOpenMode

SyncOptions.OpenMode getOpenMode()

Returns:

Open mode, one of the constants SyncOptions.OpenMode.

getSynchronizationStrategy

SyncOptions.SynchronizationStrategy getSynchronizationStrategy()

Returns:

Synchronization strategy, one of the constants SyncOptions.SynchronizationStrategy.

getTtl

int getTtl()

Returns:

Time to live in seconds from now or INFINITE_DURATION to indicate no expiry.