Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 1234]

NDittoSDK
NAuth
CDittoAuthenticationProvider	Represents a string-based authentication provider identifier used for login with Ditto
CDittoAuthenticationRequestEventArgs	Data passed to the Ditto.DittoIdentityProviderAuthenticationRequest event handler when a peer wishes to use the current device as an authentication server
CDittoAuthenticationStatus	Provides info about the authentication status
CDittoAuthenticationSuccess	Defines the properties and permissions of a user who has authenticated successfully and will be able to participate in the Ditto mesh
CDittoAuthenticator	Provides access to authentication information and methods for logging on to Ditto Server. Relevant when using DittoConfigConnect.Server config
NDiskUsage
CDittoDiskUsage	Entrypoint for accessing information about the amount of disk storage used by Ditto. This class can't be instantiated. You can access an instance through the ditto.DiskUsage API
CDittoDiskUsageItem	Returned by DittoDiskUsage.Exec
CDittoDiskUsageObserver	An observer monitoring disk usage changes
NExceptions
CDittoException	An exception that is thrown when Ditto encounters an error
CDittoFFIException	An exception that is thrown when Ditto FFI encounters an error. This exception contains additional details that can be useful for debugging and support
CDittoUnsupportedException	Operation is not supported
CDittoStoreException	Exception thrown for Ditto store related issues
CDittoStoreDocumentNotFoundExpcetion	Exception thrown when a document could not be found
CDittoStoreBackendException	Exception thrown for errors with the storage backend
CDittoQueryException	Exception thrown for query execution errors
CDittoCrdtException	Exception thrown for generic CRDT errors
CDittoQueryInvalidException	Exception thrown for invalid queries
CDittoQueryArgumentsInvalidException	Exception thrown when the query arguments used were invalid
CDittoTransactionReadOnlyException	A mutating DQL query was executed in a read-only transaction
CDittoQueryNotSupportedException	The query is syntactically valid but uses features that are either not supported at all yet or not supported in a particular context
CDittoPersistenceDirectoryLockedException	The chosen persistence directory is already in use by another Ditto instance
CDittoValidationException	Exception thrown for input validation failures
CDittoSizeLimitExceededValidationException	Exception thrown when the size limit for some piece of data has been exceeded
CDittoDepthLimitExceededValidationException	Exception thrown when the depth limit for dictionary-like data has been exceeded
CDittoNotADictionaryValidationException	Exception thrown if given an invalid object when a dictionary was expected
CDittoNotJsonCompatibleException	JSON Serialization for a provided object failed
CDittoInvalidJsonException	The data does not represent a valid JSON string
CDittoInvalidCborException	The data does not represent valid CBOR data
CDittoInvalidConfigException	The provided DittoConfig is invalid
CDittoAttachmentException	Exception thrown for attachments related errors
CDittoAttachmentNotFoundException	Exception thrown when an attachment could not be found
CDittoAttachmentFileNotFoundException	Exception thrown while trying to create an attachment for a file that does not exist
CDittoAttachmentTokenInvalidException	Exception thrown for an invalid attachment token
CDittoFailedToFetchAttachmentException	Exception thrown if an error ocurred while fetching an attachment
CDittoAttachmentFilePermissionDeniedException	Exception thrown when permission has been denied for a file operation while working with attachments
CDittoFailedToCreateAttachmentException	Exception thrown if an error ocurred while creating an attachment
CDittoIOException	An error occurred relating to I/O
CDittoAlreadyExistsIOException	A file or directory already exists
CDittoNotFoundIOException	A file or directory could not be found
CDittoPermissionDeniedIOException	The operation failed due to insufficient permissions
CDittoOperationFailedIOException	The operation failed for an unspecified reason. See error message for details
CDittoAuthenticationException	An error occurred relating to Authentication
CExpirationHandlerMissingException	Thrown if the Ditto instance was initialized with Connect set to DittoConfigConnect.Server while ExpirationHandler is null. For sync to work with server connections, Ditto requires (a) a DittoAuthenticationExpirationHandler to be set via ditto.Auth.ExpirationHandler, and (b) that handler to properly authenticate when requested
NInternal
CDrop	Abstract class hooking the finalizer into the Dispose functionality. Disposal will be triggered regardless of whether the caller explicitly invokes Dispose() or they forget and the type is being cleaned up by the finalizer
NLogging
CDittoLogger	Class with static methods to customize the logging behavior from Ditto
NStore
CDittoAttachment	A reference to a binary attachment file
CDittoAttachmentFetcher	These objects are returned by calls to DittoStore.FetchAttachment
CDittoAttachmentFetchEvent	A representation of the events that can occur in relation to an attachment fetch
CCompleted	An attachment fetch event used when the attachment's download has completed
CProgress	An attachment fetch event used when the attachment's download has progressed but is not yet complete
CDeleted	An attachment fetch event used when the attachment is deleted
CDittoDiff	Represents a diff between two lists
CDittoDiffer	Calculates diffs between lists of DittoQueryResultItem
CDittoDocumentId	Each DittoDocumentId represents a unique identifier for a document
CDittoQueryResult	Represents the result of executing a DQL query
CDittoQueryResultItem	Represents a single match of a DQL query, similar to a "row" in SQL terms. It's a reference type serving as a "cursor", allowing for efficient access of the underlying data in various formats
CDittoStore	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
CDittoStoreObserver	A store observer invokes an observation handler whenever results for its query change
CDittoTransaction	Represents a transaction in the Ditto store
CDittoTransactionInfo	Encapsulates information about a transaction
CIDittoQueryExecuting	Defines the interface for executing DQL queries
NSync
CDittoSync	Provides access to sync related functionality of Ditto
CDittoSyncSubscription	A sync subscription configures Ditto to receive updates from remote peers about documents matching the subscription's query
NTransport
CDittoConnection	Represents a connection between two peers in a Ditto mesh network
CDittoConnectionRequest	Contains information about a remote peer that has requested a connection
CDittoPeer	Represents a peer in a Ditto mesh network
CDittoPresence	The entrypoint for all actions that relate presence of other peers known by the current peer, either directly or through other peers
CDittoPresenceGraph	Represent the states of all known peers
CDittoPresenceObserver	A token returned by ObservePresence. Retain this object to continue receiving callback updates
CDittoRemotePeer	A summary snapshot of the connections currently active with a remote peer
CDittoTransportConditionChangedEventArgs	Data passed to the Ditto.DittoTransportConditionChanged event handler when the condition of one of the underlying transports that Ditto uses changes
CDittoTransportHandle	Wrapper around an Action for cleaning up native transport resources
CDitto	The entrypoint to the Ditto SDK
CDittoConfig	A configuration object for initializing a Ditto instance
CDittoConfigConnect	Specifies how this instance discovers and connects to peers, including network settings and authentication options. This is a substructure of DittoConfig
CDittoSmallPeerInfo	The entrypoint for small peer user info collection
CIDittoObserver	An observation token returned by any observation API in the Ditto SDK