DittoMutableDocumentPath

class DittoMutableDocumentPath

Provides an interface to specify a path to a key in a document that you can then call various update functions on. You obtain a DittoMutableDocumentPath by subscripting a DittoMutableDocument and you can then further subscript a DittoMutableDocumentPath to further specify the key of the document that you want to update.

Functions

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

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 and eventually perform an update operation.

operator fun get(key: String): DittoMutableDocumentPath

Used to specify a path to a key in the document that you can subscript further to access a nested key in the document and eventually perform an update operation on.

Link copied to clipboard
fun remove()

Remove a value at the document's key defined by the preceding subscripting.

Link copied to clipboard
fun set(value: Any?, isDefault: Boolean = false)

Set a value at the document's key defined by the preceding subscripting.

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: DittoMutableCounter?

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

Link copied to clipboard
val docId: DittoDocumentId
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 path: String
Link copied to clipboard
val register: DittoMutableRegister?

Returns the value at the previously specified key in the document as a DittoMutableRegister 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