FieldPath class

A FieldPath refers to a field in a document.

Usage of a FieldPath allows querying of Firestore paths whose document ID contains a '.'.

Annotations

Constructors

FieldPath(List<String> components)
Creates a new FieldPath.
FieldPath.fromString(String path)
Creates a new FieldPath from a string path.

Properties

components List<String>
The List of components which make up this FieldPath.
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 FieldPathType
Returns a special sentinel FieldPath to refer to the ID of a document.
no setter