com.google.api.services.classroom

Class Classroom.UserProfiles.GuardianInvitations

java.lang.Object

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

Enclosing class:

Classroom.UserProfiles

public class Classroom.UserProfiles.GuardianInvitations
extends Object

The "guardianInvitations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.UserProfiles.GuardianInvitations.Create
class	Classroom.UserProfiles.GuardianInvitations.Get
class	Classroom.UserProfiles.GuardianInvitations.List
class	Classroom.UserProfiles.GuardianInvitations.Patch

Constructor Summary

Constructors

Constructor and Description
GuardianInvitations()

Method Summary

Modifier and Type	Method and Description
Classroom.UserProfiles.GuardianInvitations.Create	create(String studentId, GuardianInvitation content) Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.
Classroom.UserProfiles.GuardianInvitations.Get	get(String studentId, String invitationId) Returns a specific guardian invitation.
Classroom.UserProfiles.GuardianInvitations.List	list(String studentId) Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.
Classroom.UserProfiles.GuardianInvitations.Patch	patch(String studentId, String invitationId, GuardianInvitation content) Modifies a guardian invitation.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuardianInvitations

public GuardianInvitations()

Method Detail

create

public Classroom.UserProfiles.GuardianInvitations.Create create(String studentId,
                                                                GuardianInvitation content)
                                                         throws IOException

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user. Create a request for the method "guardianInvitations.create". 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 - ID of the student (in standard format)

content - the GuardianInvitation

Returns:

the request

Throws:

IOException

get

public Classroom.UserProfiles.GuardianInvitations.Get get(String studentId,
                                                          String invitationId)
                                                   throws IOException

Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations 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 Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student. Create a request for the method "guardianInvitations.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 ID of the student whose guardian invitation is being requested.

invitationId - The `id` field of the `GuardianInvitation` being requested.

Returns:

the request

Throws:

IOException

list

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

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. Create a request for the method "guardianInvitations.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 - 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.

Returns:

the request

Throws:

IOException

patch

public Classroom.UserProfiles.GuardianInvitations.Patch patch(String studentId,
                                                              String invitationId,
                                                              GuardianInvitation content)
                                                       throws IOException

Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom. Create a request for the method "guardianInvitations.patch". 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 ID of the student whose guardian invitation is to be modified.

invitationId - The `id` field of the `GuardianInvitation` to be modified.

content - the GuardianInvitation

Returns:

the request

Throws:

IOException