com.google.api.services.classroom

Class Classroom.UserProfiles.Guardians

java.lang.Object

com.google.api.services.classroom.Classroom.UserProfiles.Guardians

Enclosing class:

Classroom.UserProfiles

public class Classroom.UserProfiles.Guardians
extends Object

The "guardians" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.UserProfiles.Guardians.Delete
class	Classroom.UserProfiles.Guardians.Get
class	Classroom.UserProfiles.Guardians.List

Constructor Summary

Constructors

Constructor and Description
Guardians()

Method Summary

Modifier and Type	Method and Description
Classroom.UserProfiles.Guardians.Delete	delete(String studentId, String guardianId) Deletes a guardian.
Classroom.UserProfiles.Guardians.Get	get(String studentId, String guardianId) Returns a specific guardian.
Classroom.UserProfiles.Guardians.List	list(String studentId) Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Guardians

public Guardians()

Method Detail

delete

public Classroom.UserProfiles.Guardians.Delete delete(String studentId,
                                                      String guardianId)
                                               throws IOException

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`. Create a request for the method "guardians.delete". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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 `"me"`, indicating the requesting user

guardianId - The `id` field from a `Guardian`.

Returns:

the request

Throws:

IOException

get

public Classroom.UserProfiles.Guardians.Get get(String studentId,
                                                String guardianId)
                                         throws IOException

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`. Create a request for the method "guardians.get". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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 `"me"`, indicating the requesting user

guardianId - The `id` field from a `Guardian`.

Returns:

the request

Throws:

IOException

list

public Classroom.UserProfiles.Guardians.List list(String studentId)
                                           throws IOException

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. Create a request for the method "guardians.list". This request holds the parameters needed by the classroom server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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 `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user has access to view.

Returns:

the request

Throws:

IOException