DittoDocumentID

data class DittoDocumentID

An identifier for a DittoDocument.

Each DittoDocumentID represents a unique identifier for a document.

Constructors

DittoDocumentID

fun DittoDocumentID(value: Any)

Creates a new DittoDocumentID.

Types

Companion

object Companion

Functions

equals

open operator override fun equals(other: Any?): Boolean

get

operator fun get(index: Int): DittoDocumentIDPath

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

operator fun get(key: String): DittoDocumentIDPath

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

hashCode

open override fun hashCode(): Int

toDebugString

fun toDebugString(): String

Returns a stringified debug representation of a document identifier.

toNative

~~fun~~ ~~toNative~~(): Any?

Returns a native representation of a document identifier.

toString

open override fun toString(): String

Returns a stringified representation of a document identifier.

Properties

value

val value: Any?

The underlying value of the document identifier as a native type.