listen method

Future<ListenResponse> listen(
  1. ListenRequest request,
  2. String database, {
  3. String? $fields,
})

Listens to changes.

This method is only available via gRPC or WebChannel (not REST).

request - The metadata request object.

Request parameters:

database - Required. The database name. In the format: projects/{project_id}/databases/{database_id}. Value must have pattern ^projects/\[^/\]+/databases/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListenResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ListenResponse> listen(
  ListenRequest request,
  core.String database, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1beta1/' + core.Uri.encodeFull('$database') + '/documents:listen';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return ListenResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}