DittoDocumentID

An identifier for a DittoDocument.

Each DittoDocumentID represents a unique identifier for a document.

  • Initializes a new DittoDocumentID.

    A document ID can be created from any of the following:

    • string
    • integer
    • boolean
    • null
    • byte array
    • array (containing any of the items in this list)
    • map (where the keys must be strings and the values can be made up of any of the items in this list)

    Note that you cannot use floats or other custom types to create a document ID.

    Document IDs are also limited in size, based on their serialized representation, to 256 bytes. You will receive an error if you try to create a document ID that exceeds the size limit.

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

  • Returns a stringified representation of a document identifier.

    The returned string can be used directly in queries that you use with other Ditto functions. For example you could create a query that was like this:

    myCollection.find("_id == \(docID.toString())")

Value accessors

  • Returns the document ID as an Any?. It will be nil if no value exists.

  • Returns the document ID as a String if possible, otherwise the return value will be nil.

  • Returns the document ID as a String. If the key was invalid the return value will be an empty string.

  • Returns the document ID as a Bool if possible, otherwise the return value will be nil.

  • Returns the document ID as a String. If the key was invalid the return value will be an empty string.

  • int

    Returns the document ID as an Int if possible, otherwise the return value will be nil.

  • Returns the document ID as an Int. If the key was invalid the return value will be 0.

  • Returns the document ID as a UInt if possible, otherwise the return value will be nil.

  • Returns the document ID as a UInt. If the key was invalid the return value will be 0.

  • Returns the document ID as a Float if possible, otherwise the return value will be nil.

  • Returns the document ID as a Float. If the key was invalid the return value will be 0.

  • Returns the document ID as a Double if possible, otherwise the return value will be nil.

  • Returns the document ID as a Double. If the key was invalid the return value will be 0.

  • Returns the document ID as an Array<Any?> if possible, otherwise the return value will be nil.

  • Returns the document ID as an Array<Any?>. If the key was invalid the return value will be an empty array.

  • Returns the document ID as a Dictionary<String, Any?> if possible, otherwise the return value will be nil.

  • Returns the document ID as a Dictionary<String, Any?>. If the key was invalid the return value will be an empty dictionary.

CustomStringConvertible & CustomDebugStringConvertible