list method

Future<ListGuardianInvitationsResponse> list(
  1. String studentId, {
  2. String? invitedEmailAddress,
  3. int? pageSize,
  4. String? pageToken,
  5. List<String>? states,
  6. String? $fields,
})

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.

This method returns the following error codes: * PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian invitations for that student, if "-" is specified as the student_id and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * INVALID_ARGUMENT if a student_id is specified, but its format cannot be recognized (it is not an email address, nor a student_id from the API, nor the literal string me). May also be returned if an invalid page_token or state is provided. * NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student.

Request parameters:

studentId - The ID of the student whose guardian invitations are to be returned. 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 * the string literal "-", indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.

invitedEmailAddress - If specified, only results with the specified invited_email_address are returned.

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.

states - If specified, only results with the specified state values are returned. Otherwise, results with a state of PENDING are returned.

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

Completes with a ListGuardianInvitationsResponse.

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

  final url_ = 'v1/userProfiles/' +
      commons.escapeVariable('$studentId') +
      '/guardianInvitations';

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