DittoDocumentIDPath

Provides an interface to specify a path to a key in a document ID that you can then call a function on to get the value at the specified key as a specific type. You obtain a DittoDocumentIDPath by subscripting a DittoDocumentID and you can then further subscript a DittoDocumentIDPath to further specify the key of the document ID that you want to get the value of. This is only really useful if you’re working with a document ID whose underlying value is a dictionary or an array.

Initialization

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

Value accessors

  • Returns the value at the previously specified path in the document ID as an Any?. It will be nil if no value exists.

  • Returns the value at the previously specified path in the document ID as a String if possible, otherwise the return value will be nil.

  • Returns the value at the previously specified path in the document ID as a String. If the path was invalid the return value will be an empty string.

  • Returns the value at the previously specified path in the document ID as a Bool if possible, otherwise the return value will be nil.

  • Returns the value at the previously specified path in the document ID as a String. If the path was invalid the return value will be an empty string.

  • int

    Returns the value at the previously specified path in the document ID as an Int if possible, otherwise the return value will be nil.

  • Returns the value at the previously specified path in the document ID as an Int. If the path was invalid the return value will be 0.

  • Returns the value at the previously specified path in the document ID as a UInt if possible, otherwise the return value will be nil.

  • Returns the value at the previously specified path in the document ID as a UInt. If the path was invalid the return value will be 0.

  • Returns the value at the previously specified path in the document ID as a Float if possible, otherwise the return value will be nil.

  • Returns the value at the previously specified path in the document ID as a Float. If the path was invalid the return value will be 0.

  • Returns the value at the previously specified path in the document ID as a Double if possible, otherwise the return value will be nil.

  • Returns the value at the previously specified path in the document ID as a Double. If the path was invalid the return value will be 0.

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

  • Returns the value at the previously specified path in the document ID as an Array<Any?>. If the path was invalid the return value will be an empty array.

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

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