FieldPath class

Represents a path to a field in a document.

Parameters:

  • components: List of field names forming the path.

Returns: An instance of FieldPath.

Example:

var path = FieldPath(['user', 'address', 'city']);

Constructors

FieldPath(List<String> components)
FieldPath.fromString(String path)
Creates a FieldPath from a dot-separated string.

Properties

components → List<String>
final
hashCode → int
The hash code for this object.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override

Static Properties

documentId → FieldPath
A special FieldPath to refer to the ID of the document.
no setter