list method

Future<ListAnnouncementsResponse> list(String courseId, { List<String>? announcementStates, String? orderBy, int? pageSize, String? pageToken, String? $fields, })

Returns a list of announcements that the requester is permitted to view.

Course students may only view PUBLISHED announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.

Request parameters:

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

announcementStates - Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.

orderBy - Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime

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.

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

Completes with a ListAnnouncementsResponse.

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

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

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