DittoSharp  0.1.1-alpha1
Public Attributes | Properties | List of all members
DittoSharp.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...

Public Attributes

string Id => this.Doc.Id
 Gets the ID of the document. More...
 
Dictionary< string, object > Value => this.Doc.Value
 Gets the document's inner value. More...
 

Properties

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.

Member Data Documentation

◆ Id

string DittoSharp.DittoMutableDocument.Id => this.Doc.Id

Gets the ID of the document.

◆ Value

Dictionary<string, object> DittoSharp.DittoMutableDocument.Value => this.Doc.Value

Gets the document's inner value.

Property Documentation

◆ this[string key]

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