Sync Android SDK for Java/com.twilio.sync.client.java/DocumentsJava

DocumentsJava

interface DocumentsJava

Functions

Link copied to clipboard
open fun create(output: SuccessListener<SyncDocumentJava>): CancellationToken
open fun create(uniqueName: String?, output: SuccessListener<SyncDocumentJava>): CancellationToken
open fun create(uniqueName: String?, ttlSeconds: Long, output: SuccessListener<SyncDocumentJava>): CancellationToken
abstract fun create(uniqueName: String?, ttlSeconds: Long, listener: SyncDocumentJava.Listener?, output: SuccessListener<SyncDocumentJava>): CancellationToken

Create new SyncDocumentJava object.

Link copied to clipboard
abstract fun mutateDocument(sidOrUniqueName: String, mutator: SyncMutator, callback: SuccessListener<String>): CancellationToken

Mutate value of the SyncDocumentJava without opening it using provided Mutator function.

Link copied to clipboard
abstract fun mutateDocumentWithTtl(sidOrUniqueName: String, ttlSeconds: Long, mutator: SyncMutator, callback: SuccessListener<String>): CancellationToken

Mutate value of the SyncDocumentJava without opening it using provided Mutator function.

Link copied to clipboard
open fun openExisting(sidOrUniqueName: String, output: SuccessListener<SyncDocumentJava>): CancellationToken
abstract fun openExisting(sidOrUniqueName: String, listener: SyncDocumentJava.Listener?, output: SuccessListener<SyncDocumentJava>): CancellationToken

Open existing SyncDocumentJava by SID or unique name.

Link copied to clipboard
open fun openOrCreate(uniqueName: String, output: SuccessListener<SyncDocumentJava>): CancellationToken
open fun openOrCreate(uniqueName: String, ttlSeconds: Long, output: SuccessListener<SyncDocumentJava>): CancellationToken
abstract fun openOrCreate(uniqueName: String, ttlSeconds: Long, listener: SyncDocumentJava.Listener?, output: SuccessListener<SyncDocumentJava>): CancellationToken

Open existing SyncDocumentJava by unique name or create a new one if specified name does not exist.

Link copied to clipboard
abstract fun remove(sidOrUniqueName: String, callback: SuccessListener<Unit>): CancellationToken

Remove SyncDocumentJava without opening it.

Link copied to clipboard
abstract fun setTtl(sidOrUniqueName: String, ttlSeconds: Long, callback: SuccessListener<Unit>): CancellationToken

Set time to live for SyncDocumentJava without opening it.

Link copied to clipboard
abstract fun updateDocument(sidOrUniqueName: String, jsonData: String, callback: SuccessListener<Unit>): CancellationToken

Set value of the SyncDocumentJava as a JSON object without opening it.

Link copied to clipboard
abstract fun updateDocumentWithTtl(sidOrUniqueName: String, jsonData: String, ttlSeconds: Long, callback: SuccessListener<Unit>): CancellationToken

Set value of the SyncDocumentJava as a JSON object without opening it.