delete method

Future<void> delete(
  1. String userId,
  2. String id, {
  3. String? $fields,
})

Immediately and permanently deletes the specified filter.

Request parameters:

userId - User's email address. The special value "me" can be used to indicate the authenticated user.

id - The ID of the filter to be deleted.

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

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

  final url_ = 'gmail/v1/users/' +
      commons.escapeVariable('$userId') +
      '/settings/filters/' +
      commons.escapeVariable('$id');

  await _requester.request(
    url_,
    'DELETE',
    queryParams: queryParams_,
    downloadOptions: null,
  );
}