FirestoreSentinel class

An instruction to the server rather than a value.

Firestore never returns these; they only travel on a write. Decoding one would mean the server sent something this mapping does not describe.

Inheritance

Constructors

FirestoreSentinel.arrayRemove(List<Object?> values)
Removes every instance of values from an array field.
factory
FirestoreSentinel.arrayUnion(List<Object?> values)
Adds values to an array field, skipping ones already present.
factory
FirestoreSentinel.increment(num by)
Adds by to a numeric field, atomically.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
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.
inherited

Operators

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

Constants

delete → const FirestoreSentinel
Removes the field.
serverTimestamp → const FirestoreSentinel
Sets the field to the server's write time.