list method

Future<ListWatchesResponse> list(
  1. String formId, {
  2. String? $fields,
})

Return a list of the watches owned by the invoking project.

The maximum number of watches is two: For each invoker, the limit is one for each event type per form.

Request parameters:

formId - Required. ID of the Form whose watches to list.

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

Completes with a ListWatchesResponse.

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<ListWatchesResponse> list(
  core.String formId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/forms/' + commons.escapeVariable('$formId') + '/watches';

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