FirestoreReference class final

Sentinel value for Firestore referenceValue — a document path of the form projects/<project>/databases/<db>/documents/<col>/<doc>....

Embed inside the map passed to FirestoreFields.encode:

FirestoreFields.encode({
  'preferred_plan': FirestoreReference(
    'projects/my-project/databases/(default)/documents/plans/premium',
  ),
})

The encoder detects this sentinel and emits {"referenceValue": "<path>"} in the wire format.

Annotations

• @immutable

Constructors

FirestoreReference(String path)

const

Properties

hashCode → int

The hash code for this object.

no setter, override

path → String

Full Firestore document path: projects/<project>/databases/<db>/documents/<col>/<doc>. The encoder writes this verbatim — there is no path validation.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

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.

override