Ditto 4.14.6
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 NDittoSDK
 CAwdlConfigConfiguration for Apple Wireless Direct Link (AWDL) network transport. Not supported on all platforms
 CBluetoothLEConfigConfiguration for Bluetooth Low Energy network transport. Not supported on all platforms (yet)
 CDittoThe entrypoint to the Ditto SDK
 CDittoAddressAn address uniquely representing another device on the Ditto network
 CDittoAlreadyExistsIOExceptionA file or directory already exists
 CDittoAttachmentA reference to a binary attachment file
 CDittoAttachmentExceptionException thrown for attachments related errors
 CDittoAttachmentFetcherThese objects are returned by calls to DittoCollection.FetchAttachment(DittoAttachmentToken, Action<DittoAttachmentFetchEvent>)
 CDittoAttachmentFetchEventA representation of the events that can occur in relation to an attachment fetch
 CCompletedAn attachment fetch event used when the attachment's download has completed
 CProgressAn attachment fetch event used when the attachment's download has progressed but is not yet complete
 CDeletedAn attachment fetch event used when the attachment is deleted
 CDittoAttachmentFileNotFoundExceptionException thrown while trying to create an attachment for a file that does not exist
 CDittoAttachmentFilePermissionDeniedExceptionException thrown when permission has been denied for a file operation while working with attachments
 CDittoAttachmentNotFoundExceptionException thrown when an attachment could not be found
 CDittoAttachmentTokenServes as a token for a specific attachment that you can pass to a call to DittoCollection.FetchAttachment(DittoAttachmentToken, Action<DittoAttachmentFetchEvent>)
 CDittoAttachmentTokenInvalidExceptionException thrown for an invalid attachment token
 CDittoAuthenticationExceptionAn error occurred relating to Authentication
 CDittoAuthenticationProviderRepresents a string-based authentication provider identifier used for login with Ditto
 CDittoAuthenticationRequestEventArgsData passed to the Ditto.DittoIdentityProviderAuthenticationRequest event handler when a peer wishes to use the current device as an authentication server
 CDittoAuthenticationStatusProvides info about the authentication status
 CDittoAuthenticationSuccessDefines the properties and permissions of a user who has authenticated successfully and will be able to participate in the Ditto mesh
 CDittoAuthenticatorProvides access to authentication information and methods for logging on to Ditto Cloud. Relevant when using an OnlineWithAuthentication or an Online identity
 CDittoCollectionA reference to a collection in a DittoStore
 CDittoCollectionsEventProvides 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 about as well as the collections that were previously known about in the previous event, along with information about what collections have been inserted, deleted, updated, or moved since the last event
 CDittoConfigA configuration object for initializing a Ditto instance
 CDittoConfigConnectSpecifies how this instance discovers and connects to peers, including network settings and authentication options. This is a substructure of DittoConfig
 CDittoConnectConfiguration for network transports used to connect with Ditto big peers
 CDittoConnectionRepresents a connection between two peers in a Ditto mesh network
 CDittoConnectionRequestContains information about a remote peer that has requested a connection
 CDittoCounterRepresents a CRDT counter that can be upserted as part of a document or assigned to a property during an update of a document
 CDittoCrdtExceptionException thrown for generic CRDT errors
 CDittoDepthLimitExceededValidationExceptionException thrown when the depth limit for dictionary-like data has been exceeded
 CDittoDiffRepresents a diff between two lists
 CDittoDifferCalculates diffs between lists of DittoQueryResultItem
 CDittoDiskUsageEntrypoint 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
 CDittoDiskUsageChildA token returned by ObservePeers. Retain this object to continue receiving callback updates
 CDittoDiskUsageObserverAn observer monitoring disk usage changes
 CDittoDocumentA document in a DittoCollection
 CDittoDocumentIdAn identifier for a DittoDocument
 CDittoDocumentIdPathProvides an interface to specify a path to a key in a document identifier that you can then call a function on to get the value at the specified key as a specific type
 CDittoDocumentPathProvides 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
 CDittoErrorUsed to represent all Ditto-related errors that aren't thrown as exceptions
 CDittoExceptionAn exception that is thrown when Ditto encounters an error
 CDittoFailedToCreateAttachmentExceptionException thrown if an error ocurred while creating an attachment
 CDittoFailedToFetchAttachmentExceptionException thrown if an error ocurred while fetching an attachment
 CDittoFFIExceptionAn exception that is thrown when Ditto FFI encounters an error. This exception contains additional details that can be useful for debugging and support
 CDittoGlobalConfiguration for all network transports
 CDittoHttpListenConfigConfiguration for less common data sync scenarios. Please read the documentation on the Ditto website for examples. Incorrect use of Listen can result in insecure configurations
 CDittoIdentityUsed 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
 CDittoInvalidCborExceptionThe data does not represent valid CBOR data
 CDittoInvalidConfigExceptionThe provided DittoConfig is invalid
 CDittoInvalidJsonExceptionThe data does not represent a valid JSON string
 CDittoIOExceptionAn error occurred relating to I/O
 CDittoLanConfigConfiguration for local LAN Wi-Fi network transport
 CDittoListenConfiguration for network transports used to allow incoming connections from other Ditto peers
 CDittoLiveQueryA 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
 CDittoLiveQueryEventDescribes events delivered by a DittoLiveQuery
 CInitialA type used for the first event delivered for a live query
 CUpdateA description of updates that occurred between the current and previous times that the live query handler was fired
 CDittoLiveQueryMoveAn 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
 CDittoLoggerClass with static methods to customize the logging behavior from Ditto
 CDittoMutableCounterRepresents a mutable CRDT counter that can be incremented by a specific amount while updating a document
 CDittoMutableDocumentA 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
 CDittoMutableDocumentPathProvides 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
 CDittoMutableRegisterRepresents a mutable CRDT register that can be updated while updating a document
 CDittoNotADictionaryValidationExceptionException thrown if given an invalid object when a dictionary was expected
 CDittoNotFoundIOExceptionA file or directory could not be found
 CDittoNotJsonCompatibleExceptionJSON Serialization for a provided object failed
 CDittoOperationFailedIOExceptionThe operation failed for an unspecified reason. See error message for details
 CDittoPeerRepresents a peer in a Ditto mesh network
 CDittoPeersObserverA token returned by ObservePeers. Retain this object to continue receiving callback updates
 CDittoPeerToPeerConfiguration for network transport used to connect with other Ditto small peers. Some transports are not supported on all platforms
 CDittoPendingCollectionsOperationThese objects are returned when calling Collections() on DittoStore
 CDittoPendingCursorOperationThese objects are returned when using find-like functionality on DittoCollection objects
 CDittoPendingIdSpecificOperationThese objects are returned when using DittoCollection.FindById(string) functionality
 CDittoPermissionDeniedIOExceptionThe operation failed due to insufficient permissions
 CDittoPersistenceDirectoryLockedExceptionThe chosen persistence directory is already in use by another Ditto instance
 CDittoPresenceThe entrypoint for all actions that relate presence of other peers known by the current peer, either directly or through other peers
 CDittoPresenceGraphRepresent the states of all known peers
 CDittoPresenceObserverA token returned by ObservePresence. Retain this object to continue receiving callback updates
 CDittoQueryArgumentsInvalidExceptionException thrown when the query arguments used were invalid
 CDittoQueryExceptionException thrown for query execution errors
 CDittoQueryInvalidExceptionException thrown for invalid queries
 CDittoQueryNotSupportedExceptionThe query is syntactically valid but uses features that are either not supported at all yet or not supported in a particular context
 CDittoQueryResultRepresents the result of executing a DQL query
 CDittoQueryResultItemRepresents 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
 CDittoRegisterRepresents a CRDT register that can be upserted as part of a document or assigned to a property during an update of a document
 CDittoRemotePeerA summary snapshot of the connections currently active with a remote peer
 CDittoScopedWriteTransactionExposes functionality that allows you to perform multiple operations on the store within a single write transaction
 CDittoSingleDocumentLiveQueryEventProvides information about a live query event relating to a single document live query
 CDittoSizeLimitExceededValidationExceptionException thrown when the size limit for some piece of data has been exceeded
 CDittoSmallPeerInfoThe entrypoint for small peer user info collection
 CDittoStoreA class encompassing functionality relating to the embedded storage. This is not a class you instantiate directly. Instead you access DittoStore objects using Ditto.Store
 CDittoStoreBackendExceptionException thrown for errors with the storage backend
 CDittoStoreDocumentNotFoundExpcetionException thrown when a document could not be found
 CDittoStoreExceptionException thrown for Ditto store related issues
 CDittoStoreObserverA store observer invokes an observation handler whenever results for its query change
 CDittoSubscriptionA 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
 CDittoSyncProvides access to sync related functionality of Ditto
 CDittoSyncSubscriptionA sync subscription configures Ditto to receive updates from remote peers about documents matching the subscription's query
 CDittoTcpListenConfigConfiguration for less common data sync scenarios. Please read the documentation on the Ditto website for examples. Incorrect use of Listen can result in insecure configurations
 CDittoTransactionRepresents a transaction in the Ditto store
 CDittoTransactionInfoEncapsulates information about a transaction
 CDittoTransactionReadOnlyExceptionA mutating DQL query was executed in a read-only transaction
 CDittoTransportConditionChangedEventArgsData passed to the Ditto.DittoTransportConditionChanged event handler when the condition of one of the underlying transports that Ditto uses changes
 CDittoTransportConfigConfiguration object specifying which network transports Ditto should use to sync data
 CDittoTransportDiagnosticsProvides a view into the state of the transports being used by Ditto at a point in time
 CDittoTransportHandleWrapper around an Action for cleaning up native transport resources
 CDittoTransportSnapshotProvides information about a given transport at a point in time
 CDittoUnsupportedExceptionOperation is not supported
 CDittoUpdateResultProvides information about a successful update operation on a document
 CSetAn update result when a Set operation was performed
 CRemovedAn update result when a Remove operation was performed
 CIncrementedAn update result when an Increment operation was performed
 CDittoValidationExceptionException thrown for input validation failures
 CDittoWriteTransactionExposes functionality that allows you to perform multiple operations on the store within a single write transaction
 CDittoWriteTransactionPendingCursorOperationThese objects are returned when using DittoScopedWriteTransaction.Find(string), DittoScopedWriteTransaction.Find(string, Dictionary<string, object>), or DittoScopedWriteTransaction.FindAll
 CDittoWriteTransactionPendingIdSpecificOperationThese objects are returned when using DittoScopedWriteTransaction.FindById(string) functionality
 CDittoWriteTransactionResultProvides information about the result of an operation on a document that was part of a write transaction
 CInsertedRepresents a write transaction result when a document has been inserted
 CRemovedRepresents a write transaction result when a document has been removed
 CEvictedRepresents a write transaction result when a document has been evicted
 CUpdatedRepresents a write transaction result when a document has been updated
 CExpirationHandlerMissingExceptionThrown 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
 CIDittoAuthenticationDelegateProvides feedback to the developer about Ditto authentication status
 CIDittoObserverAn observation token returned by any observation API in the Ditto SDK
 CIDittoQueryExecutingDefines the interface for executing DQL queries
 CWifiAwareConfigConfiguration for Wi-Fi Aware network transport. Not supported on all platforms