ditto/live.ditto/DittoDocumentId

DittoDocumentId

data class DittoDocumentId

An identifier for a DittoDocument.

Each DittoDocumentId represents a unique identifier for a document.

Constructors

Link copied to clipboard
constructor(value: Any)

Creates a new DittoDocumentId.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val value: Any?

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

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
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 identifier.

operator fun get(key: String): DittoDocumentIdPath

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

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun toDebugString(): String

Returns a stringified debug representation of a document identifier.

Link copied to clipboard
open override fun toString(): String

Returns a stringified representation of a document identifier.