list method

Future<ApprovalList> list(
  1. String fileId, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists the approvals on a file.

For more information, see Manage approvals. By default, this method returns a minimal response that may not include the items array. To retrieve approval details, you must explicitly specify the fields you want using the fields query parameter. To return the exact fields you need, see Return specific fields.

Request parameters:

fileId - Required. The ID of the file that the approval is on.

pageSize - The maximum number of approvals to return. When not set, at most 100 approvals are returned.

pageToken - The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response.

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

Completes with a ApprovalList.

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<ApprovalList> list(
  core.String fileId, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'files/' + commons.escapeVariable('$fileId') + '/approvals';

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