DittoDocumentPath

class DittoDocumentPath

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.

Parameters

docHandleWrapper

A wrapper around the Rust document pointer.

path

The initial path into the DittoDocument. Given that all DittoDocuments are maps at the top level, initialPath should only ever be a string key into the top level map. Multiple path components are not supported via this constructor (i.e. "key[0]" or "key.nextKey" are invalid). Further levels of paths should be added via repeated subscripting on the returned DittoDocumentPath (i.e. doc["key"][0] or doc["key"]["nextKey"]).

Functions

Link copied to clipboard
operator fun get(index: Int): DittoDocumentPath

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.

operator fun get(key: String): DittoDocumentPath

Used to specify a path to a key in the document that you can subscript further to access a nested key in the document.

Properties

Link copied to clipboard
val attachmentToken: DittoAttachmentToken?

Returns the value at the previously specified key in the document as a DittoAttachmentToken. If the key was invalid the return value will be null.

Link copied to clipboard
val boolean: Boolean?

Returns the value at the previously specified key in the document as a Boolean if possible, otherwise the return value will be null.

Link copied to clipboard
val booleanValue: Boolean

Returns the value at the previously specified key in the document as a Boolean. If the key was invalid the return value will be false.

Link copied to clipboard
val counter: DittoCounter?

Returns the value at the previously specified key in the document as a DittoCounter if possible, otherwise the return value will be null.

Link copied to clipboard
val double: Double?

Returns the value at the previously specified key in the document as a Double if possible, otherwise the return value will be null.

Link copied to clipboard
val doubleValue: Double

Returns the value at the previously specified key in the document as a Double. If the key was invalid the return value will be 0.0.

Link copied to clipboard
val float: Float?

Returns the value at the previously specified key in the document as a Float if possible, otherwise the return value will be null.

Link copied to clipboard
val floatValue: Float

Returns the value at the previously specified key in the document as a Float. If the key was invalid the return value will be 0f.

Link copied to clipboard
val int: Int?

Returns the value at the previously specified key in the document as an Int if possible, otherwise the return value will be null.

Link copied to clipboard
val intValue: Int

Returns the value at the previously specified key in the document as an Int. If the key was invalid the return value will be 0.

Link copied to clipboard
val list: List<Any?>?

Returns the value at the previously specified key in the document as a List<Any?> if possible, otherwise the return value will be null.

Link copied to clipboard
val listValue: List<Any?>

Returns the value at the previously specified key in the document as a List<Any?>. If the key was invalid the return value will be an empty list.

Link copied to clipboard
val map: Map<String, Any?>?

Returns the value at the previously specified key in the document as a Map<String, Any?> if possible, otherwise the return value will be null.

Link copied to clipboard
val mapValue: Map<String, Any?>

Returns the value at the previously specified key in the document as a Map<String, Any?>. If the key was invalid the return value will be an empty dictionary.

Link copied to clipboard
val register: DittoRegister?

Returns the value at the previously specified key in the document as a DittoRegister if possible, otherwise the return value will be null.

Link copied to clipboard
val string: String?

Returns the value at the previously specified key in the document as a String if possible, otherwise the return value will be null.

Link copied to clipboard
val stringValue: String

Returns the value at the previously specified key in the document as a String. If the key was invalid the return value will be an empty string.

Link copied to clipboard
val value: Any?

Returns the value at the previously specified key in the document as an Any? if possible, otherwise the return value will be null