cancelSubmission method

Future<CancelSubmissionResponse> cancelSubmission(
  1. CancelSubmissionRequest request,
  2. String name, {
  3. String? $fields,
})

Cancel the current active submission of an item if present.

This can be used to cancel the review of a pending submission.

request - The metadata request object.

Request parameters:

name - Required. Name of the item to cancel the submission of in the form publishers/{publisherId}/items/{itemId} Value must have pattern ^publishers/\[^/\]+/items/\[^/\]+$.

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

Completes with a CancelSubmissionResponse.

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<CancelSubmissionResponse> cancelSubmission(
  CancelSubmissionRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v2/' + core.Uri.encodeFull('$name') + ':cancelSubmission';

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