Cloud Firestore V1beta1 Client - Class ListenResponse (1.38.0)

Reference documentation and code samples for the Cloud Firestore V1beta1 Client class ListenResponse.

The response for Firestore.Listen .

Generated from protobuf message google.firestore.v1beta1.ListenResponse

Namespace

Google \ Cloud \ Firestore \ V1beta1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ target_change
↳ document_change
↳ document_delete
↳ document_remove
Google\Cloud\Firestore\V1beta1\DocumentRemove

A Document has been removed from a target (because it is no longer relevant to that target).

↳ filter
Google\Cloud\Firestore\V1beta1\ExistenceFilter

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

getTargetChange

Targets have changed.

setTargetChange

Targets have changed.

Parameter
Name
Description
Returns
Type
Description
$this

getDocumentChange

A Document has changed.

setDocumentChange

A Document has changed.

Parameter
Name
Description
Returns
Type
Description
$this

getDocumentDelete

A Document has been deleted.

setDocumentDelete

A Document has been deleted.

Parameter
Name
Description
Returns
Type
Description
$this

getDocumentRemove

A Document has been removed from a target (because it is no longer relevant to that target).

setDocumentRemove

A Document has been removed from a target (because it is no longer relevant to that target).

Parameter
Name
Description
Returns
Type
Description
$this

getFilter

A filter to apply to the set of documents previously returned for the given target.

Returned when documents may have been removed from the given target, but the exact documents are unknown.

setFilter

A filter to apply to the set of documents previously returned for the given target.

Returned when documents may have been removed from the given target, but the exact documents are unknown.

Parameter
Name
Description
Returns
Type
Description
$this

getResponseType

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: