Ditto  1.0.15-alpha1
Properties | List of all members
DittoSDK.DittoMutableDocument Class Reference

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...

Properties

DittoDocumentID Id [get]
 Gets the unique identifier for this document. This is the primary key. More...
 
Dictionary< string, object > Value [get]
 Gets the value as a Dictionary<string, object>. More...
 
DittoMutableDocumentPath this[string key] [get]
 Used to specify a path to a key in the document that you can subscript further to access a nested key in the document or perform an update operation on it immediately. More...
 

Detailed Description

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.

Property Documentation

◆ Id

DittoDocumentID DittoSDK.DittoMutableDocument.Id
get

Gets the unique identifier for this document. This is the primary key.

◆ this[string key]

DittoMutableDocumentPath DittoSDK.DittoMutableDocument.this[string key]
get

Used to specify a path to a key in the document that you can subscript further to access a nested key in the document or perform an update operation on it immediately.

Parameters
keyThe initial part of the path needed to get to the key in the document you wish to update.
Returns
A DittoMutableDocumentPath object with the provided key incorporated into the path.

◆ Value

Dictionary<string, object> DittoSDK.DittoMutableDocument.Value
get

Gets the value as a Dictionary<string, object>.