DocumentRemove: DocumentRemove Object

View source: R/firestore_objects.R

DocumentRemoveR Documentation

DocumentRemove Object

Description

DocumentRemove Object

Usage

DocumentRemove(removedTargetIds = NULL, document = NULL, readTime = NULL)

Arguments

removedTargetIds

A set of target IDs for targets that previously matched this document

document

The resource name of the Document that has gone out of view

readTime

The read timestamp at which the remove was observed

Details

Autogenerated via gar_create_api_objects A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.

Value

DocumentRemove object


robonomist/googleFirestore documentation built on Jan. 30, 2023, 6:39 p.m.