Package live.ditto

Types

Ditto
Link copied to clipboard
class Ditto @JvmOverloads() constructor(dependencies: DittoDependencies, identity: DittoIdentity)
Ditto is the entry point for accessing Ditto-related functionality.
DittoAttachment
Link copied to clipboard
class DittoAttachment : Closeable
Represents an attachment and can be used to insert the associated attachment into a document at a specific key.
DittoAttachmentFetcher
Link copied to clipboard
class DittoAttachmentFetcher
These objects are returned by calls to fetchAttachment on DittoCollections.
DittoAttachmentFetchEvent
Link copied to clipboard
sealed class DittoAttachmentFetchEvent
The different events that can occur in relation to an attachment fetch.
DittoAttachmentFetchEventHandler
Link copied to clipboard
interface DittoAttachmentFetchEventHandler
Typically this will only be used if interacting with the SDK from Java.
DittoAttachmentFetchEventType
Link copied to clipboard
The different types of DittoAttachmentFetchEvent.
DittoAttachmentToken
Link copied to clipboard
class DittoAttachmentToken
Serves as a token for a specific attachment that you can pass to a call to fetchAttachment on a DittoCollection.
DittoCallback
Link copied to clipboard
interface DittoCallback
The callback property of Ditto instances can be set to be an object that implements this interface.
DittoCollection
Link copied to clipboard
class DittoCollection
A reference to a collection in a DittoStore.
DittoConditionSource
Link copied to clipboard
enum DittoConditionSource : Enum<DittoConditionSource>
DittoDependencies
Link copied to clipboard
interface DittoDependencies
An interface describing the dependencies required to initialise a Ditto instance.
DittoDocument
Link copied to clipboard
class DittoDocument
A document belonging to a DittoCollection with an inner value.
DittoDocumentID
Link copied to clipboard
data class DittoDocumentID
An identifier for a DittoDocument.
DittoDocumentIDPath
Link copied to clipboard
class DittoDocumentIDPath
Provides an interface to specify a path to a key in a document ID that you can then call a function on to get the value at the specified key as a specific type.
DittoDocumentPath
Link copied to clipboard
class DittoDocumentPath
Provides an interface to specify a path to a key in a document that you can then call a function on to get the value at the specified key as a specific type.
DittoError
Link copied to clipboard
sealed class DittoError : Throwable
All errors that are thrown by the Ditto SDK are wrapped as a DittoError.
DittoIdentity
Link copied to clipboard
sealed class DittoIdentity
The various identity configurations that you can use when initializing a Ditto instance.
DittoLiveQuery
Link copied to clipboard
class DittoLiveQuery
The type that is returned when calling observe on a DittoCollection object.
DittoLiveQueryCallback
Link copied to clipboard
interface DittoLiveQueryCallback
Typically this will only be used if interacting with the SDK from Java.
DittoLiveQueryEvent
Link copied to clipboard
sealed class DittoLiveQueryEvent
Describes the different types of event that you can receive when dealing with live queries.
DittoLiveQueryMove
Link copied to clipboard
data class DittoLiveQueryMove(from: Int, to: Int)
Describes the index in a list of documents that a document was previously found at (from) and the index that it can now be found at (to).
DittoLiveQueryWithNextSignalCallback
Link copied to clipboard
interface DittoLiveQueryWithNextSignalCallback
Typically this will only be used if interacting with the SDK from Java.
DittoLog
Link copied to clipboard
object DittoLog
Main singleton (global instance) to use / call into ditto_log and thus our logging API.
DittoLogCallback
Link copied to clipboard
interface DittoLogCallback
Typically this will only be used if interacting with the SDK from Java.
DittoLogDecorator
Link copied to clipboard
interface DittoLogDecorator
This is an interface allowing to shim / wrap a call to ditto_log from the dittoffi.
DittoLogger
Link copied to clipboard
object DittoLogger : LoggerCb
Main singleton (global instance) to tweak the behavior of Ditto's logging infrastructure.
DittoLogLevel
Link copied to clipboard
enum DittoLogLevel : Enum<DittoLogLevel>
DittoMutableDocument
Link copied to clipboard
class DittoMutableDocument
This is used as part of update operations for documents.
DittoMutableDocumentPath
Link copied to clipboard
class DittoMutableDocumentPath
Provides an interface to specify a path to a key in a document that you can then call various update functions on.
DittoMutableDocumentsUpdater
Link copied to clipboard
interface DittoMutableDocumentsUpdater
Typically this will only be used if interacting with the SDK from Java.
DittoPeersObserver
Link copied to clipboard
class DittoPeersObserver : Closeable
A token returned by observePeers().
DittoPeersObserverCallback
Link copied to clipboard
interface DittoPeersObserverCallback
Typically this will only be used if interacting with the SDK from Java.
DittoPendingCursorOperation
Link copied to clipboard
class DittoPendingCursorOperation
These objects are returned when using find-like functionality on DittoCollections.
DittoPendingIDSpecificOperation
Link copied to clipboard
class DittoPendingIDSpecificOperation
These objects are returned when using findByID functionality on DittoCollections.
DittoRemotePeer
Link copied to clipboard
class DittoRemotePeer(networkId: String, deviceName: String, approximateDistance: Double?, connections: Array<String>)
A summary snapshot of the types of connections currently active to a remote Ditto peer.
DittoScopedWriteTransaction
Link copied to clipboard
class DittoScopedWriteTransaction(baseTransaction: DittoWriteTransaction, collectionName: String)
DittoScopedWriteTransaction exposes functionality that allows you to perform multiple operations on the store within a single write transaction.
DittoSignalNext
Link copied to clipboard
typealias DittoSignalNext = () -> Unit
DittoSignalNextCallback
Link copied to clipboard
interface DittoSignalNextCallback
The interface that you must implement with the third parameter provided to observeWithNextSignal and observeLocalWithNextSignal calls.
DittoSingleDocumentLiveQueryCallback
Link copied to clipboard
interface DittoSingleDocumentLiveQueryCallback
Typically this will only be used if interacting with the SDK from Java.
DittoSingleDocumentLiveQueryEvent
Link copied to clipboard
class DittoSingleDocumentLiveQueryEvent(isInitial: Boolean, oldDocument: DittoDocument?)
Provides information about a live query event relating to a single document live query.
interface DittoSingleDocumentLiveQueryWithNextSignalCallback
Typically this will only be used if interacting with the SDK from Java.
DittoSingleMutableDocumentUpdater
Link copied to clipboard
interface DittoSingleMutableDocumentUpdater
Typically this will only be used if interacting with the SDK from Java.
DittoSortDirection
Link copied to clipboard
enum DittoSortDirection : Enum<DittoSortDirection>
Describes the direction when sorting a query.
DittoStore
Link copied to clipboard
class DittoStore
Provides access to DittoCollections and a write transaction API.
DittoSubscription
Link copied to clipboard
class DittoSubscription : Closeable
While DittoSubscription objects remain in scope they ensure that documents in the collection specified and that match the query provided will try to be kept up-to-date with the latest changes from remote peers.
DittoTransportCondition
Link copied to clipboard
enum DittoTransportCondition : Enum<DittoTransportCondition>
DittoTransportDiagnostics
Link copied to clipboard
class DittoTransportDiagnostics
DittoTransportSnapshot
Link copied to clipboard
class DittoTransportSnapshot
DittoUpdateResult
Link copied to clipboard
sealed class DittoUpdateResult
Describes the result of an update operation performed on a DittoMutableDocument.
DittoWriteTransaction
Link copied to clipboard
class DittoWriteTransaction
DittoWriteTransaction exposes functionality that allows you to perform multiple operations on the store within a single write transaction.
DittoWriteTransactionHandler
Link copied to clipboard
interface DittoWriteTransactionHandler
Typically this will only be used if interacting with the SDK from Java.
class DittoWriteTransactionPendingCursorOperation
These objects are returned when using find-like functionality on DittoScopedWriteTransactions.
class DittoWriteTransactionPendingIDSpecificOperation
These objects are returned when using findByID functionality on DittoScopedWriteTransactions.
DittoWriteTransactionResult
Link copied to clipboard
sealed class DittoWriteTransactionResult
Describes one part of the result of a write transaction.
LMDBError
Link copied to clipboard
data class LMDBError(returnCode: Int) : Throwable