list method

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

Returns a list of groups in a course.

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

Request parameters:

courseId - Required. The identifier of the course.

pageSize - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum, which is currently set to 75 items. 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 ListStudentGroupsResponse.

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<ListStudentGroupsResponse> list(
  core.String courseId, {
  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_ =
      'v1/courses/' + commons.escapeVariable('$courseId') + '/studentGroups';

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