clear method

Future<ClearValuesResponse> clear(ClearValuesRequest request, String spreadsheetId, String range, { String? $fields, })

Clears values from a spreadsheet.

The caller must specify the spreadsheet ID and range. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.

request - The metadata request object.

Request parameters:

spreadsheetId - The ID of the spreadsheet to update.

range - The [A1 notation or R1C1 notation](/sheets/api/guides/concepts#cell) of the values to clear.

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

Completes with a ClearValuesResponse.

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<ClearValuesResponse> clear(
  ClearValuesRequest request,
  core.String spreadsheetId,
  core.String range, {
  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_ = 'v4/spreadsheets/' +
      commons.escapeVariable('$spreadsheetId') +
      '/values/' +
      commons.escapeVariable('$range') +
      ':clear';

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