Cloud Firestore V1 Client - Class ListenResponse (1.40.0)

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

The response for Firestore.Listen.

Generated from protobuf message google.firestore.v1.ListenResponse

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ target_change`	`Google\Cloud\Firestore\V1\TargetChange` Targets have changed.
`↳ document_change`	`Google\Cloud\Firestore\V1\DocumentChange` A Document has changed.
`↳ document_delete`	`Google\Cloud\Firestore\V1\DocumentDelete` A Document has been deleted.
`↳ document_remove`	`Google\Cloud\Firestore\V1\DocumentRemove` A Document has been removed from a target (because it is no longer relevant to that target).
`↳ filter`	`Google\Cloud\Firestore\V1\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.

Returns
Type	Description
`Google\Cloud\Firestore\V1\TargetChange\|null`

hasTargetChange

setTargetChange

Targets have changed.

Parameter
Name	Description
`var`	`Google\Cloud\Firestore\V1\TargetChange`

Returns
Type	Description
`$this`

getDocumentChange

A Document has changed.

Returns
Type	Description
`Google\Cloud\Firestore\V1\DocumentChange\|null`

hasDocumentChange

setDocumentChange

A Document has changed.

Parameter
Name	Description
`var`	`Google\Cloud\Firestore\V1\DocumentChange`

Returns
Type	Description
`$this`

getDocumentDelete

A Document has been deleted.

Returns
Type	Description
`Google\Cloud\Firestore\V1\DocumentDelete\|null`

hasDocumentDelete

setDocumentDelete

A Document has been deleted.

Parameter
Name	Description
`var`	`Google\Cloud\Firestore\V1\DocumentDelete`

Returns
Type	Description
`$this`

getDocumentRemove

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

Returns
Type	Description
`Google\Cloud\Firestore\V1\DocumentRemove\|null`

hasDocumentRemove

setDocumentRemove

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

Parameter
Name	Description
`var`	`Google\Cloud\Firestore\V1\DocumentRemove`

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.

Returns
Type	Description
`Google\Cloud\Firestore\V1\ExistenceFilter\|null`

hasFilter

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
`var`	`Google\Cloud\Firestore\V1\ExistenceFilter`

Returns
Type	Description
`$this`

getResponseType

Returns
Type	Description
`string`