CloudDocumentsAction class final

Writes documents of a cloud collection: one at a time by id, or many at once.

Inheritance

Constructors

CloudDocumentsAction({CloudDocumentsOperation operation = CloudDocumentsOperation.add, String path = '', String id = '', bool autoId = false, bool skipIfExists = true, String value = '', bool raw = false, String field = '', VariableType valueType = VariableType.text, ValueWrite write = const ValueWrite(), String ids = '', List<WhereFilter> where = const [], String idField = 'id', bool merge = false, bool replaceCollection = false, bool enabled = true, bool nonBlocking = false, Predicate? when})
const

Properties

autoId → bool
CloudDocumentsOperation.add: a generated id.
final
enabled → bool
False skips the action.
finalinherited
field → String
CloudDocumentsOperation.update: the field (a path) and how it changes.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
The document id (an expression).
final
idField → String
final
ids → String
CloudDocumentsOperation.removeMany: ids, comma separated or a list (an expression).
final
merge → bool
final
nested → List<ActionDef>
The actions it runs itself (branches, follow-ups), in order.
no setterinherited
nonBlocking → bool
The chain doesn't wait for it, and its failure doesn't stop the chain.
finalinherited
operation → CloudDocumentsOperation
final
path → String
The collection path (an expression).
final
raw → bool
value is taken as written: no expressions.
final
replaceCollection → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selfAndNested → Iterable<ActionDef>
This action, then every action nested in it, depth first.
no setterinherited
skipIfExists → bool
final
type → String
The JSON type.
no setteroverride
value → String
The document (CloudDocumentsOperation.add) or list of documents (CloudDocumentsOperation.setMany): an expression, or JSON text.
final
valueType → VariableType
final
when → Predicate?
Runs only when it holds; null: always.
finalinherited
where → List<WhereFilter>
final
write → ValueWrite
final

Methods

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

Operators

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

Constants

typeName → const String