DittoSharp  0.1.1-alpha2
Public Member Functions | Properties | List of all members
DittoSharp.DittoStore Class Reference

A class encompassing functionality relating to the embedded storage. This is not a class you instantiate directly. Instead you access DittoStore objects using DittoKit.Store. More...

Public Member Functions

DittoCollection Collection (string collectionName)
 A method to reference a DittoCollection. More...
 
List< DittoWriteTransactionResultWrite (Action< DittoWriteTransaction > handler)
 Allows you to group multiple operations together that affect multiple documents, potentially across multiple collections. More...
 

Properties

unsafe List< string > CollectionNames [get]
 Gets the names of all collections known about on this device. More...
 
DittoCollection this[string collectionName] [get]
 Retrieve a DittoCollection. var collection = dittoKit.store["cars"]; More...
 

Detailed Description

A class encompassing functionality relating to the embedded storage. This is not a class you instantiate directly. Instead you access DittoStore objects using DittoKit.Store.

Member Function Documentation

◆ Collection()

DittoCollection DittoSharp.DittoStore.Collection ( string  collectionName)
inline

A method to reference a DittoCollection.

Parameters
collectionNameThe name of the collection.
Returns
A reference to the DittoCollection.

◆ Write()

List<DittoWriteTransactionResult> DittoSharp.DittoStore.Write ( Action< DittoWriteTransaction handler)
inline

Allows you to group multiple operations together that affect multiple documents, potentially across multiple collections.

Parameters
handlerAn Action that provides access to a write transaction object that can be used to perform operations on the store.
Returns
A list ofDittoWriteTransactionResult objects. There is a result for each operation performed as part of the write transaction.

Property Documentation

◆ CollectionNames

unsafe List<string> DittoSharp.DittoStore.CollectionNames
get

Gets the names of all collections known about on this device.

Note, this will return immediately what is in the store.

◆ this[string collectionName]

DittoCollection DittoSharp.DittoStore.this[string collectionName]
get

Retrieve a DittoCollection. var collection = dittoKit.store["cars"];

Parameters
collectionNameThe name of the collection.
Returns
A reference to the DittoCollection.