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. You can call fetchAttachment with an attachment token and an object that implements this interface.

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.

DittoAuthenticationCallback
Link copied to clipboard
interface DittoAuthenticationCallback

Provides feedback to the developer about Ditto authentication status.

DittoAuthenticationStatus
Link copied to clipboard
data class DittoAuthenticationStatus(isAuthenticated: Boolean, userId: String?)

Provides info about the authentication status.

interface DittoAuthenticationStatusDidChangeCallback

Typically this will only be used if interacting with the SDK from Java. You can call observeStatus() with an object that implements this interface.

DittoAuthenticator
Link copied to clipboard
class DittoAuthenticator

Log in to a remote authentication service, using an OnlineWithAuthentication or an Online identity.

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.

DittoCollectionsCallback
Link copied to clipboard
interface DittoCollectionsCallback

Typically this will only be used if interacting with the SDK from Java. You can call observe or observeLocal with an object that implements this interface.

DittoCollectionsEvent
Link copied to clipboard
data class DittoCollectionsEvent(isInitial: Boolean, collections: List<DittoCollection>, oldCollections: List<DittoCollection>, insertions: List<Int>, deletions: List<Int>, updates: List<Int>, moves: List<DittoLiveQueryMove>)

Provides information about the changes that have occurred in relation to an event delivered when observing the collections in a DittoStore. It contains information about the collections that are known as well as the collections that were previously known in the previous event, along with information about what collections have been inserted, deleted, updated, or moved since the last event.

DittoCollectionsWithNextSignalCallback
Link copied to clipboard
interface DittoCollectionsWithNextSignalCallback

Typically this will only be used if interacting with the SDK from Java. You can call observeWithNextSignal or observeLocalWithNextSignal with an object that implements this interface.

DittoConditionSource
Link copied to clipboard
enum DittoConditionSource : Enum<DittoConditionSource>
DittoConnectionPriority
Link copied to clipboard
enum DittoConnectionPriority : Enum<DittoConnectionPriority>

The priority with which the local device should reach out to particular remote peers in the Ditto mesh.

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. You obtain a DittoDocumentIDPath by subscripting a DittoDocumentID and you can then further subscript a DittoDocumentIDPath to further specify the key of the document ID that you want to get the value of.

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. You obtain a DittoDocumentPath by subscripting a DittoDocument and you can then further subscript a DittoDocumentPath to further specify the key of the document that you want to get the value of.

DittoError
Link copied to clipboard
sealed class DittoError : Throwable

All errors that are thrown by the Ditto SDK are wrapped as a DittoError. It wraps multiple different types of error that each have an associated reason.

DittoExperimental
Link copied to clipboard
class DittoExperimental

Upcoming SDK features made available for prototyping.

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. It handles the logic for calling the event handler that is provided to the observe call.

DittoLiveQueryCallback
Link copied to clipboard
interface DittoLiveQueryCallback

Typically this will only be used if interacting with the SDK from Java. You can call observe or observeLocal with an object that implements this interface.

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. You can call observeWithNextSignal or observeLocalWithNextSignal with an object that implements this interface.

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. You can call setCustomLogCallback with an object that implements this interface.

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.

DittoLoginCompletionCallback
Link copied to clipboard
interface DittoLoginCompletionCallback

Typically this will only be used if interacting with the SDK from Java. You can call loginWithToken or loginWithCredentials with an object that implements this interface.

DittoLogLevel
Link copied to clipboard
enum DittoLogLevel : Enum<DittoLogLevel>
DittoLogoutCleanupFn
Link copied to clipboard
interface DittoLogoutCleanupFn

Typically this will only be used if interacting with the SDK from Java. You can call logout with an object that implements this interface.

DittoMutableDocument
Link copied to clipboard
class DittoMutableDocument

This is used as part of update operations for documents. It provides access to updating a document through a subscript-based API. A subscript operation returns a DittoMutableDocumentPath that you can then use to chain further subscript operations to in order to access nested values in a document. Once you've defined the path to a key in a document that you'd like to update, by using subscripts, then you can use the functionality defined on DittoMutableDocumentPath to perform the desired document update(s). Note that objects of this type should only be used within the scope of the update closure that they are provided in.

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. You obtain a DittoMutableDocumentPath by subscripting a DittoMutableDocument and you can then further subscript a DittoMutableDocumentPath to further specify the key of the document that you want to update.

DittoMutableDocumentsUpdater
Link copied to clipboard
interface DittoMutableDocumentsUpdater

Typically this will only be used if interacting with the SDK from Java. You can call update with an object that implements this interface.

DittoObserverManager
Link copied to clipboard
class DittoObserverManager : Observable

Provides feedback to the developer about Ditto authentication status.

DittoPeersObserver
Link copied to clipboard
interface DittoPeersObserver : Closeable

A token returned by observePeers() and observePeersV2(). Call close() to unsubscribe this handler.

DittoPeersObserverCallback
Link copied to clipboard
interface DittoPeersObserverCallback

Typically this will only be used if interacting with the SDK from Java. You can call observePeers on a Ditto instance with an object that implements this interface.

DittoPeersObserverV1
Link copied to clipboard
class DittoPeersObserverV1 : DittoPeersObserver

A token returned by observePeers(). Call close() to unsubscribe this handler.

DittoPeersObserverV2
Link copied to clipboard
class DittoPeersObserverV2 : DittoPeersObserver

A token returned by observePeersV2(). Call close() to unsubscribe this handler.

DittoPeersObserverV2Callback
Link copied to clipboard
interface DittoPeersObserverV2Callback

Typically this will only be used if interacting with the SDK from Java. You can call observePeersV2 on a Ditto instance with an object that implements this interface.

DittoPendingCollectionsOperation
Link copied to clipboard
class DittoPendingCollectionsOperation

These objects are returned when calling collections() on DittoStore.

DittoPendingCursorOperation
Link copied to clipboard
class DittoPendingCursorOperation

These objects are returned when using find-like functionality on DittoCollections. They allow chaining of further query-related functions to do things like add a limit to the number of documents you want returned or specify how you want the documents to be sorted and ordered. You can either call exec on the object to get an array of DittoDocuments as an immediate return value, or you can establish either a live query or a subscription, which both work over time. A live query, established by calling observe, will notify you every time there's an update to a document that matches the query you provided in the preceding find-like call. A subscription, established by calling subscribe, will act as a signal to other peers that the device connects to that you would like to receive updates from them about documents that match the query you provided in the preceding find-like call. Calling observe will generate both a subscription and a live query at the same time. If you'd like to only observe local changes then you can call observeLocal. Update and remove functionality is also exposed through this object.

DittoPendingIDSpecificOperation
Link copied to clipboard
class DittoPendingIDSpecificOperation

These objects are returned when using findByID functionality on DittoCollections. You can either call exec on the object to get an immediate return value, or you can establish either a live query or a subscription, which both work over time. A live query, established by calling observe, will notify you every time there's an update to the document with the ID you provided in the preceding findByID call. A subscription, established by calling subscribe, will act as a signal to other peers that you would like to receive updates from them about the document with the ID you provided in the preceding findByID call. Calling observe will generate both a subscription and a live query at the same time. If you'd like to only observe local changes then you can call observeLocal. Update and remove functionality is also exposed through this object.

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. You can call observe or observeLocal with an object that implements this interface.

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. You can call observeWithNextSignal or observeLocalWithNextSignal with an object that implements this interface.

DittoSingleMutableDocumentUpdater
Link copied to clipboard
interface DittoSingleMutableDocumentUpdater

Typically this will only be used if interacting with the SDK from Java. You can call update with an object that implements this interface.

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.

DittoWriteStrategy
Link copied to clipboard
enum DittoWriteStrategy : Enum<DittoWriteStrategy>

Defines the various strategies available when inserting a document into a collection.

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. You must use the scoped function to get collection-scoped access to the write transaction object, which will then allow you to perform insert, update, remove or evict operations using the write transaction.

DittoWriteTransactionHandler
Link copied to clipboard
interface DittoWriteTransactionHandler

Typically this will only be used if interacting with the SDK from Java. You can call write on a DittoStore instance with an object that implements this interface.

class DittoWriteTransactionPendingCursorOperation

These objects are returned when using find-like functionality on DittoScopedWriteTransactions. You can use them to perform updates on a document and remove or evict a document.

class DittoWriteTransactionPendingIDSpecificOperation

These objects are returned when using findByID functionality on DittoScopedWriteTransactions. You can use them to perform updates on a document and remove or evict a document.

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