Cloud Firestore V1 Client - Class ListenRequest (1.30.0)

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

A request for Firestore.Listen

Generated from protobuf message google.firestore.v1.ListenRequest

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ database
string

Required. The database name. In the format: projects/{project_id}/databases/{database_id} .

↳ add_target
Google\Cloud\Firestore\V1\Target

A target to add to this stream.

↳ remove_target
int

The ID of a target to remove from this stream.

↳ labels
array| Google\Protobuf\Internal\MapField

Labels associated with this target change.

getDatabase

Required. The database name. In the format: projects/{project_id}/databases/{database_id} .

Returns
Type
Description
string

setDatabase

Required. The database name. In the format: projects/{project_id}/databases/{database_id} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAddTarget

A target to add to this stream.

Returns
Type
Description

hasAddTarget

setAddTarget

A target to add to this stream.

Parameter
Name
Description
Returns
Type
Description
$this

getRemoveTarget

The ID of a target to remove from this stream.

Returns
Type
Description
int

hasRemoveTarget

setRemoveTarget

The ID of a target to remove from this stream.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getLabels

Labels associated with this target change.

Returns
Type
Description

setLabels

Labels associated with this target change.

Parameter
Name
Description
Returns
Type
Description
$this

getTargetChange

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