list method

Future<ListCoursesResponse> list({ List<String>? courseStates, int? pageSize, String? pageToken, String? studentId, String? teacherId, String? $fields, })

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request.

Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * PERMISSION_DENIED for access errors. * INVALID_ARGUMENT if the query argument is malformed. * NOT_FOUND if any users specified in the query arguments do not exist.

Request parameters:

courseStates - Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.

pageSize - Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. 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.

studentId - Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

teacherId - Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user

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

Completes with a ListCoursesResponse.

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

  const url_ = 'v1/courses';

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