Sync Android SDK/com.twilio.sync/SyncOptions

SyncOptions

interface SyncOptions

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

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

Types

SynchronizationStrategy

enum SynchronizationStrategy

Functions

open fun create(): SyncOptions

Public factory method to create a new instance of SyncOptions.

createWithUniqueName

abstract fun createWithUniqueName(uniqueName: String): SyncOptions

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

abstract fun getOpenMode(): SyncOptions.OpenMode

getSidOrUniqueName

abstract fun getSidOrUniqueName(): String

getSynchronizationStrategy

abstract fun getSynchronizationStrategy(): SyncOptions.SynchronizationStrategy

abstract fun getTtl(): Int

openWithSidOrUniqueName

abstract fun openWithSidOrUniqueName(sidOrUniqueName: String): SyncOptions

Opens an existing object with specified SID or unique name.

abstract fun withStrategy(strategy: SyncOptions.SynchronizationStrategy): SyncOptions

Set SynchronizationStrategy the Sync object.

abstract fun withTtl(ttl: Int): SyncOptions

Set time to live for the Sync object in seconds.

abstract fun withUniqueName(uniqueName: String): SyncOptions

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

abstract fun withUniqueName(uniqueName: String, mode: SyncOptions.OpenMode): SyncOptions

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

Properties

INFINITE_DURATION

val INFINITE_DURATION: Int = 0

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