FieldPath class

A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a top-level field in the document), or a list of field names (referring to a nested field in the document).

See: firebase.google.com/docs/reference/js/firebase.firestore.FieldPath.

Annotations

• @JS()

Constructors

FieldPath(String fieldName0, [String fieldName1, String fieldName2, String fieldName3, String fieldName4, String fieldName5, String fieldName6, String fieldName7, String fieldName8, String fieldName9])

Creates a FieldPath from the provided field names. If more than one field name is provided, the path will point to a nested field in a document.

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

isEqual(Object other) → bool

Returns true if this FieldPath is equal to the other.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

documentId() → FieldPath

Returns a special sentinel FieldPath to refer to the ID of a document. It can be used in queries to sort or filter by the document ID.