DittoDocumentID

data class DittoDocumentID
Content copied to clipboard

An identifier for a DittoDocument.

Each DittoDocumentID represents a unique identifier for a document.

Constructors

DittoDocumentID
Link copied to clipboard
fun DittoDocumentID(value: Any)
Content copied to clipboard
Creates a new DittoDocumentID.

Types

Companion
Link copied to clipboard
object Companion
Content copied to clipboard

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Content copied to clipboard
get
Link copied to clipboard
operator fun get(index: Int): DittoDocumentIDPath
Content copied to clipboard
Used to specify an index in the array at the preceding key-path specified through the subscripting defined previously.
operator fun get(key: String): DittoDocumentIDPath
Content copied to clipboard
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
Link copied to clipboard
open override fun hashCode(): Int
Content copied to clipboard
toDebugString
Link copied to clipboard
fun toDebugString(): String
Content copied to clipboard
Returns a stringified debug representation of a document identifier.
toNative
Link copied to clipboard
fun toNative(): Any?
Content copied to clipboard
Returns a native representation of a document identifier.
toString
Link copied to clipboard
open override fun toString(): String
Content copied to clipboard
Returns a stringified representation of a document identifier.

Properties

value
Link copied to clipboard
val value: Any?
Content copied to clipboard
The underlying value of the document identifier as a native type.