list method

Future<ListStudentsResponse> list(String courseId, { int? pageSize, String? pageToken, String? $fields, })

Returns a list of students of this course that the requester is permitted to view.

This method returns the following error codes: * NOT_FOUND if the course does not exist. * PERMISSION_DENIED for access errors.

Request parameters:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

pageSize - Maximum number of items to return. The default is 30 if unspecified or 0. The server may return fewer than the specified number of results.

pageToken - nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

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

Completes with a ListStudentsResponse.

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

  final url_ =
      'v1/courses/' + commons.escapeVariable('$courseId') + '/students';

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