Ditto  1.0.5
Classes | Enumerations
DittoSDK Namespace Reference

Classes

class  CBORHelpers
 
class  Ditto
 The entrypoint to the Ditto SDK. More...
 
class  DittoAttachment
 A reference to a binary attachment file. More...
 
class  DittoAttachmentFetcher
 These objects are returned by calls to DittoCollection.FetchAttachment(DittoAttachmentToken, Action<DittoAttachmentFetchEvent>). More...
 
class  DittoAttachmentFetcherCtx
 
class  DittoAttachmentFetchEvent
 A representation of the events that can occur in relation to an attachment fetch. More...
 
class  DittoAttachmentToken
 Serves as a token for a specific attachment that you can pass to a call to DittoCollection.FetchAttachment(DittoAttachmentToken, Action<DittoAttachmentFetchEvent>). More...
 
class  DittoCollection
 A reference to a collection in a DittoStore. More...
 
class  DittoConnect
 
class  DittoDocument
 A document in a DittoCollection. More...
 
class  DittoDocumentID
 An identifier for a DittoDocument More...
 
class  DittoDocumentIDCBORConverter
 
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. More...
 
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. More...
 
class  DittoException
 An exception that is thrown when Ditto encounters an error. More...
 
class  DittoHandleWrapper
 Provides a GC object to hold the Rust pointer so disposes can be out of order Same pattern as in C++, Cocoa and (most recently) Android.
 
class  DittoHttpListenConfig
 
struct  DittoIdentity
 Used to identify a given peer in your network. In practice a peer may be a user, a device, or it might be some other entity in your system. More...
 
class  DittoListen
 
class  DittoLiveQuery
 A reference to a Live Query. The live query will respond to any changes relevant to the query that occur in the device's data store. Do not instantiate this by itself. The live query will keep the handler informed of all changes so long as it is not garbage collected or disposed. More...
 
class  DittoLiveQueryCtx
 The meat of the LiveQuery logic / object. This object is the one that handles callbacks from Rust.
 
class  DittoLiveQueryEvent
 Describes events delivered by a DittoLiveQuery. More...
 
class  DittoLiveQueryMove
 An object that describes how a document's position in a live query's list of matching documents has changed since the previous live query event. More...
 
class  DittoLogger
 Class with static methods to customize the logging behavior from Ditto.
 
class  DittoLogLevelHelper
 
class  DittoMutableDocument
 A special reference to a DittoDocument that can be used to perform mutation on a document. Do not instantiate directly. This reference should never leave the scope of the lambda provided as part of a call to DittoPendingCursorOperation.Update(Action<List<DittoMutableDocument>>) or DittoPendingIDSpecificOperation.Update(Action<DittoMutableDocument>) and should not be used across different threads. More...
 
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. More...
 
class  DittoPeerToPeer
 
class  DittoPendingCursorOperation
 These objects are returned when using find-like functionality on DittoCollection objects. More...
 
class  DittoPendingIDSpecificOperation
 These objects are returned when using DittoCollection.FindById(string) functionality. More...
 
class  DittoScopedWriteTransaction
 Exposes functionality that allows you to perform multiple operations on the store within a single write transaction. More...
 
class  DittoSingleDocumentLiveQueryEvent
 Provides information about a live query event relating to a single document live query. More...
 
class  DittoStore
 A class encompassing functionality relating to the embedded storage. This is not a class you instantiate directly. Instead you access DittoStore objects using Ditto.Store. More...
 
class  DittoSubscription
 A reference to a subscription to data with other remote peers. You do not instantiate DittoSubscription objects directly. Instead they are created by calling DittoPendingCursorOperation.Subscribe or DittoPendingIDSpecificOperation.Subscribe. More...
 
class  DittoTcpListenConfig
 
class  DittoTransportConfig
 A configuration object specifying which network transports Ditto should use to sync data. More...
 
class  DittoUpdateResult
 Provides information about a successful update operation on a document. More...
 
class  DittoWriteTransaction
 Exposes functionality that allows you to perform multiple operations on the store within a single write transaction. More...
 
class  DittoWriteTransactionPendingCursorOperation
 These objects are returned when using DittoScopedWriteTransaction.Find(string), DittoScopedWriteTransaction.Find(string, Dictionary<string, object>), or DittoScopedWriteTransaction.FindAll. More...
 
class  DittoWriteTransactionPendingIDSpecificOperation
 These objects are returned when using DittoScopedWriteTransaction.FindById(string) functionality. More...
 
class  DittoWriteTransactionResult
 Provides information about the result of an operation on a document that was part of a write transaction. More...
 
class  DocumentHandleWrapper
 
class  DocumentHelpers
 
class  DocumentOperator
 
class  DocumentPath
 
class  DocumentPathSanitizer
 
class  ErrorHelpers
 
class  FfiHelpers
 
class  LogHelpers
 
class  PathComponentHelpers
 
class  QueryOperator
 
class  RCHandle
 Store an IDisposable object in a reference-counted wrapper, in a way that can be shared over FFI.
 
class  SortDirectionHelper
 

Enumerations

enum  DittoIdentityType { Development, SharedKey, Production }
 The identity types you can use with Ditto. More...
 
enum  DittoLogLevel {
  Error = 1, Warning = 2, Info = 3, Debug = 4,
  Verbose = 5
}
 The different log levels that Ditto supports. More...
 
enum  DittoSortDirection { DittoSortDirection.Ascending = 1, DittoSortDirection.Descending = 2 }
 Describes the lexicographic or numeric sorting direction for a query. More...
 

Enumeration Type Documentation

◆ DittoIdentityType

The identity types you can use with Ditto.

A development identity should be used while in development when you want to control either or both of the app name and the site ID of the peer.

A production identity should be used in a production environment with a certificate authority (CA). This accepts a certificate bundle, which includes identity information as a base 64 encoded string.

A shared key identity may be used for apps where all the devices and users are trusted. Anyone who has the secret key can connect and modify any data. This authentication mode does not require a CA.

◆ DittoLogLevel

The different log levels that Ditto supports.

◆ DittoSortDirection

Describes the lexicographic or numeric sorting direction for a query.

Enumerator
Ascending 

Informs the query to return values sorted in a lexicographic or numeric ascending order.

Descending 

Informs the query to return values sorted in a lexicographic or numeric descending order.