dittosynckit / live.ditto / DittoDocumentPath

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.

Properties

attachmentToken	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. `val attachmentToken: DittoAttachmentToken?`
boolean	Returns the value at the previously specified key in the document as a `Boolean` if possible, otherwise the return value will be `null`. `val boolean: Boolean?`
booleanValue	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. `val booleanValue: Boolean`
docID	`val docID: String`
double	Returns the value at the previously specified key in the document as a `Double` if possible, otherwise the return value will be `null`. `val double: Double?`
doubleValue	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. `val doubleValue: Double`
float	Returns the value at the previously specified key in the document as a `Float` if possible, otherwise the return value will be `null`. `val float: Float?`
floatValue	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. `val floatValue: Float`
int	Returns the value at the previously specified key in the document as an `Int` if possible, otherwise the return value will be `null`. `val int: Int?`
intValue	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. `val intValue: Int`
list	Returns the value at the previously specified key in the document as a `List<Any?>` if possible, otherwise the return value will be `null`. `val list: List<Any?>?`
listValue	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. `val listValue: List<Any?>`
map	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`. `val map: Map<String, Any?>?`
mapValue	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. `val mapValue: Map<String, Any?>`
string	Returns the value at the previously specified key in the document as a `String` if possible, otherwise the return value will be `null`. `val string: String?`
stringValue	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. `val stringValue: String`
value	`val value: Map<String, Any?>`

Functions

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.

operator fun get(key: String): 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(index: Int): DittoDocumentPath