WriteBatchPlatform class abstract
A write batch, used to perform multiple writes as a single atomic unit.
A WriteBatch provides methods for adding writes to the write batch.
Operations done on a WriteBatch do not take effect until you commit().
Once committed, no further operations can be performed on the WriteBatch,
nor can it be committed again.
- Inheritance
-
- Object
- PlatformInterface
- WriteBatchPlatform
Constructors
- WriteBatchPlatform()
- Overridable constructor
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
-
commit(
) → Future< void> - Commits all of the writes in this write batch as a single atomic unit.
-
delete(
String documentPath) → void -
Deletes the document referred to by a
documentPath. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
set(
String documentPath, Map< String, dynamic> data, [SetOptions? options]) → void - Writes to the document referred to by document.
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
String documentPath, Map< String, dynamic> data) → void - Updates fields in the document referred to by document.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
verify(
WriteBatchPlatform instance) → void -
Throws an AssertionError if
instancedoes not extend WriteBatchPlatform. This is used by the app-facingWriteBatchto ensure that the object in which it's going to delegate calls has been constructed properly.override