DittoCollection

A reference to a collection in a DittoStore.

Functions

fetchAttachment

fun fetchAttachment(token: DittoAttachmentToken, onFetchEvent: (DittoAttachmentFetchEvent) -> Unit): DittoAttachmentFetcher

Trigger an attachment to be downloaded locally to the device and observe its progress as it does so.

fun fetchAttachment(token: DittoAttachmentToken, fetchEventHandler: DittoAttachmentFetchEventHandler): DittoAttachmentFetcher

Trigger an attachment to be downloaded locally to the device and observe its progress as it does so.

find

fun find(query: String): DittoPendingCursorOperation

Generates a DittoPendingCursorOperation with the provided query that can be used to find the documents matching the query at a point in time or you can chain a call to observe, observeLocal, or subscribe if you want to get updates about documents matching the query as they occur.

fun find(query: String, queryArgs: Map<String, Any?>): DittoPendingCursorOperation

findAll

fun findAll(): DittoPendingCursorOperation

Generates a DittoPendingCursorOperation that can be used to find all documents in the collection at a point in time or you can chain a call to observe, observeLocal, or subscribe if you want to get updates about documents in the collection over time.

findByID

fun findByID(id: Any): DittoPendingIDSpecificOperation

Generates a DittoPendingIDSpecificOperation with the provided document ID that can be used to find the document at a point in time or you can chain a call to observe, observeLocal, or subscribe if you want to get updates about the document over time.

fun findByID(id: DittoDocumentID): DittoPendingIDSpecificOperation

insert

@JvmOverloads()

fun <T : Any> insert(value: T, id: DittoDocumentID? = null, isDefault: Boolean = false): DittoDocumentID

Inserts a new document into the collection and returns the document's ID.

insertWithStrategy

@JvmOverloads()

fun <T : Any> insertWithStrategy(value: T, id: DittoDocumentID? = null, writeStrategy: DittoWriteStrategy = DittoWriteStrategy.Overwrite): DittoDocumentID

Inserts a new document into the collection and returns the document's ID.

newAttachment

@JvmOverloads()

fun newAttachment(inputStream: InputStream, metadata: Map<String, String> = emptyMap()): DittoAttachment?

Creates a new attachment, which can then be inserted into a document.

@JvmOverloads()

fun newAttachment(path: String, metadata: Map<String, String> = emptyMap()): DittoAttachment?

Creates a new attachment, which can then be inserted into a document.

Properties

name

@JvmField()

val name: String

the name of the collection.