com.twilio.sync

Class Options

java.lang.Object

com.twilio.sync.Options

public class Options
extends java.lang.Object

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

• SyncClient.openDocument(com.twilio.sync.Options, com.twilio.sync.DocumentObserver, com.twilio.sync.SuccessListener<com.twilio.sync.Document>)
• SyncClient.openMap(com.twilio.sync.Options, com.twilio.sync.MapObserver, com.twilio.sync.SuccessListener<com.twilio.sync.Map>)
• SyncClient.openList(com.twilio.sync.Options, com.twilio.sync.ListObserver, com.twilio.sync.SuccessListener<com.twilio.sync.List>)
• SyncClient.openStream(com.twilio.sync.Options, com.twilio.sync.StreamObserver, com.twilio.sync.SuccessListener<com.twilio.sync.Stream>)

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Options.OpenMode
static class	Options.SynchronizationStrategy

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
Options	createWithUniqueName(java.lang.String uniqueName) Creates a new object with specified unique name, fails if the given name is already in use.
void	dispose()
Options.OpenMode	getOpenMode()
java.lang.String	getSidOrUniqueName()
Options.SynchronizationStrategy	getSynchronizationStrategy()
Options	openWithSidOrUniqueName(java.lang.String sidOrUniqueName) Opens an existing object with specified SID or unique name.
Options	withStrategy(Options.SynchronizationStrategy strategy)
Options	withTtl(int ttl) Specifies the Time-to-Live of the Sync object in seconds.
Options	withUniqueName(java.lang.String uniqueName) Creates a new object or opens an existing one with provided unique name.
Options	withUniqueName(java.lang.String uniqueName, Options.OpenMode mode) Creates a new object or opens an existing one with provided unique name, also given a specific opening mode.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Options

public Options()

Method Detail

createWithUniqueName

public Options createWithUniqueName(java.lang.String uniqueName)

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

Parameters:

uniqueName - Unique name to assign to entity upon creation.

Returns:

Self for chaining.

withUniqueName

public Options withUniqueName(java.lang.String uniqueName)

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

Parameters:

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

Returns:

Self for chaining.

withUniqueName

public Options withUniqueName(java.lang.String uniqueName,
                              Options.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 @todo OpenMode

Returns:

Self for chaining.

openWithSidOrUniqueName

public Options 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.

Parameters:

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

Returns:

Self for chaining.

withStrategy

public Options withStrategy(Options.SynchronizationStrategy strategy)

withTtl

public Options withTtl(int ttl)

Specifies the Time-to-Live of the Sync object in seconds. 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.

getSidOrUniqueName

public java.lang.String getSidOrUniqueName()

getOpenMode

public Options.OpenMode getOpenMode()

getSynchronizationStrategy

public Options.SynchronizationStrategy getSynchronizationStrategy()

dispose

public void dispose()