Class Google_Service_Classroom_UserProfilesGuardians_Resource

The "guardians" collection of methods. Typical usage is:

 $classroomService = new Google_Service_Classroom(...);
 $guardians = $classroomService->guardians;

Google_Service_Resource

Google_Service_Classroom_UserProfilesGuardians_Resource

Located at Classroom.php

Methods summary
`public Google_Service_Classroom_ClassroomEmpty`	# `delete( string $studentId, string $guardianId, array $optParams = array() )` Deletes a guardian. Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, 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). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`. (guardians.delete) Parameters `$studentId` The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal <code>"me"</code>, indicating the requesting user `$guardianId` The <code>id</code> field from a <code>Guardian</code>. `$optParams` Optional parameters. Returns `Google_Service_Classroom_ClassroomEmpty` Google_Service_Classroom_ClassroomEmpty
`public Google_Service_Classroom_Guardian`	# `get( string $studentId, string $guardianId, array $optParams = array() )` Returns a specific guardian. Returns a specific guardian. This method returns the following error codes: `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, 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`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`. (guardians.get) Parameters `$studentId` The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal <code>"me"</code>, indicating the requesting user `$guardianId` The <code>id</code> field from a <code>Guardian</code>. `$optParams` Optional parameters. Returns `Google_Service_Classroom_Guardian` Google_Service_Classroom_Guardian
`public Google_Service_Classroom_ListGuardiansResponse`	# `listUserProfilesGuardians( string $studentId, array $optParams = array() )` Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. 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 information 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, if the `invited_email_address` filter is set by a user who is not a domain administrator, 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` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. (guardians.listUserProfilesGuardians) Parameters `$studentId` Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal <code>"me"</code>, indicating the requesting user * the string literal <code>"-"</code>, indicating that results should be returned for all students that the requesting user has access to view. `$optParams` Optional parameters. Returns `Google_Service_Classroom_ListGuardiansResponse` Google_Service_Classroom_ListGuardiansResponse Opt_param string 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. string invitedEmailAddress Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators. int 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.

Classes

Class Google_Service_Classroom_UserProfilesGuardians_Resource

Parameters

Returns

Parameters

Returns

Parameters

Returns

Opt_param