DittoSDK.DittoDocumentPath Class Reference

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

Inherits DittoSDK.DocumentPath.

Protected Member Functions
override CBORObject	GetCborObjectAtCurrentPath (PathAccessorType_t pathType)

Properties
DittoCounter	Counter [get]
	Gets the value at the previously specified key in the document as a DittoCounter if possible, otherwise the return value will be null.
DittoRegister	Register [get]
	Gets the value at the previously specified key in the document as a DittoRegister if possible, otherwise the return value will be null.
DittoDocumentPath	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.
DittoDocumentPath	this[int index] [get]
	Used to specify an index in the array at the preceding key-path specified through the subscripting defined previously. You can subscript the return value further to access a further nested key in the document.

Detailed Description

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

You obtain a DittoDocumentPath by subscripting a DittoDocument and you can then further subscript a DittoDocumentPath to further specify the key of the document that you want to get the value of.

Property Documentation

this[int index]

DittoDocumentPath DittoSDK.DittoDocumentPath.this[int index]

get

Used to specify an index in the array at the preceding key-path specified through the subscripting defined previously. You can subscript the return value further to access a further nested key in the document.

Parameters

index

The index of the array that you wish to access in the key previously specified with the preceding subscripting.

Returns

The same DittoDocumentPath object with the provided index incorporated into the document path.

this[string key]

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

Parameters

key	The next part of the path needed to get to the key in the document you wish to get the value of.

Returns

The same DittoDocumentPath object with the provided key incorporated into the document path.