| Method | Defined By | ||
|---|---|---|---|
Creates a new write batch | WriteBatch | ||
commit(listener:Function = null):void
Commits all of the writes in this write batch as a single atomic unit. | WriteBatch | ||
deleteDocument(documentReference:DocumentReference):void
Deletes the document referred to by documentReference. | WriteBatch | ||
setData(data:*, forDocument:DocumentReference, merge:Boolean = false):void
Writes to the document referred to by documentReference. | WriteBatch | ||
updateData(data:*, forDocument:DocumentReference):void
Updates fields in the document referred to by documentReference. | WriteBatch | ||
| WriteBatch | () | Constructor |
Objectpublic function WriteBatch()Creates a new write batch
| commit | () | method |
public function commit(listener:Function = null):voidCommits all of the writes in this write batch as a single atomic unit.
Parameters
listener:Function (default = null)
function callback(error:FirestoreError):void {
}
|
| deleteDocument | () | method |
public function deleteDocument(documentReference:DocumentReference):void
Deletes the document referred to by documentReference.
Parameters
documentReference:DocumentReference |
| setData | () | method |
public function setData(data:*, forDocument:DocumentReference, merge:Boolean = false):void
Writes to the document referred to by documentReference. If the document doesn't yet exist,
this method creates it and then sets the data. If the document exists, this method overwrites
the document data with the new values.
Parameters
data:* | |
forDocument:DocumentReference — A reference to the document whose data should be overwritten.
| |
merge:Boolean (default = false) |
| updateData | () | method |
public function updateData(data:*, forDocument:DocumentReference):void
Updates fields in the document referred to by documentReference.
If document does not exist, the write batch will fail.
Parameters
data:* — A reference to the document whose data should be overwritten.
| |
forDocument:DocumentReference |