1<?php 2/* 3 * Copyright 2014 Google Inc. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 6 * use this file except in compliance with the License. You may obtain a copy of 7 * the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 14 * License for the specific language governing permissions and limitations under 15 * the License. 16 */ 17 18/** 19 * The "guardians" collection of methods. 20 * Typical usage is: 21 * <code> 22 * $classroomService = new Google_Service_Classroom(...); 23 * $guardians = $classroomService->guardians; 24 * </code> 25 */ 26class Google_Service_Classroom_Resource_UserProfilesGuardians extends Google_Service_Resource 27{ 28 /** 29 * Deletes a guardian. The guardian will no longer receive guardian 30 * notifications and the guardian will no longer be accessible via the API. This 31 * method returns the following error codes: * `PERMISSION_DENIED` if no user 32 * that matches the provided `student_id` is visible to the requesting user, if 33 * the requesting user is not permitted to manage guardians for the student 34 * identified by the `student_id`, if guardians are not enabled for the domain 35 * in question, or for other access errors. * `INVALID_ARGUMENT` if a 36 * `student_id` is specified, but its format cannot be recognized (it is not an 37 * email address, nor a `student_id` from the API). * `NOT_FOUND` if the 38 * requesting user is permitted to modify guardians for the requested 39 * `student_id`, but no `Guardian` record exists for that student with the 40 * provided `guardian_id`. (guardians.delete) 41 * 42 * @param string $studentId The student whose guardian is to be deleted. One of 43 * the following: * the numeric identifier for the user * the email address of 44 * the user * the string literal `"me"`, indicating the requesting user 45 * @param string $guardianId The `id` field from a `Guardian`. 46 * @param array $optParams Optional parameters. 47 * @return Google_Service_Classroom_ClassroomEmpty 48 */ 49 public function delete($studentId, $guardianId, $optParams = array()) 50 { 51 $params = array('studentId' => $studentId, 'guardianId' => $guardianId); 52 $params = array_merge($params, $optParams); 53 return $this->call('delete', array($params), "Google_Service_Classroom_ClassroomEmpty"); 54 } 55 /** 56 * Returns a specific guardian. This method returns the following error codes: * 57 * `PERMISSION_DENIED` if no user that matches the provided `student_id` is 58 * visible to the requesting user, if the requesting user is not permitted to 59 * view guardian information for the student identified by the `student_id`, if 60 * guardians are not enabled for the domain in question, or for other access 61 * errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format 62 * cannot be recognized (it is not an email address, nor a `student_id` from the 63 * API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is 64 * permitted to view guardians for the requested `student_id`, but no `Guardian` 65 * record exists for that student that matches the provided `guardian_id`. 66 * (guardians.get) 67 * 68 * @param string $studentId The student whose guardian is being requested. One 69 * of the following: * the numeric identifier for the user * the email address 70 * of the user * the string literal `"me"`, indicating the requesting user 71 * @param string $guardianId The `id` field from a `Guardian`. 72 * @param array $optParams Optional parameters. 73 * @return Google_Service_Classroom_Guardian 74 */ 75 public function get($studentId, $guardianId, $optParams = array()) 76 { 77 $params = array('studentId' => $studentId, 'guardianId' => $guardianId); 78 $params = array_merge($params, $optParams); 79 return $this->call('get', array($params), "Google_Service_Classroom_Guardian"); 80 } 81 /** 82 * Returns a list of guardians that the requesting user is permitted to view, 83 * restricted to those that match the request. To list guardians for any student 84 * that the requesting user may view guardians for, use the literal character 85 * `-` for the student ID. This method returns the following error codes: * 86 * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user 87 * is not permitted to view guardian information for that student, if `"-"` is 88 * specified as the `student_id` and the user is not a domain administrator, if 89 * guardians are not enabled for the domain in question, if the 90 * `invited_email_address` filter is set by a user who is not a domain 91 * administrator, or for other access errors. * `INVALID_ARGUMENT` if a 92 * `student_id` is specified, but its format cannot be recognized (it is not an 93 * email address, nor a `student_id` from the API, nor the literal string `me`). 94 * May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if 95 * a `student_id` is specified, and its format can be recognized, but Classroom 96 * has no record of that student. (guardians.listUserProfilesGuardians) 97 * 98 * @param string $studentId Filter results by the student who the guardian is 99 * linked to. The identifier can be one of the following: * the numeric 100 * identifier for the user * the email address of the user * the string literal 101 * `"me"`, indicating the requesting user * the string literal `"-"`, indicating 102 * that results should be returned for all students that the requesting user has 103 * access to view. 104 * @param array $optParams Optional parameters. 105 * 106 * @opt_param string invitedEmailAddress Filter results by the email address 107 * that the original invitation was sent to, resulting in this guardian link. 108 * This filter can only be used by domain administrators. 109 * @opt_param int pageSize Maximum number of items to return. Zero or 110 * unspecified indicates that the server may assign a maximum. The server may 111 * return fewer than the specified number of results. 112 * @opt_param string pageToken nextPageToken value returned from a previous list 113 * call, indicating that the subsequent page of results should be returned. The 114 * list request must be otherwise identical to the one that resulted in this 115 * token. 116 * @return Google_Service_Classroom_ListGuardiansResponse 117 */ 118 public function listUserProfilesGuardians($studentId, $optParams = array()) 119 { 120 $params = array('studentId' => $studentId); 121 $params = array_merge($params, $optParams); 122 return $this->call('list', array($params), "Google_Service_Classroom_ListGuardiansResponse"); 123 } 124} 125