com.google.api.services.classroom

Class Classroom.Invitations

java.lang.Object

com.google.api.services.classroom.Classroom.Invitations

Enclosing class:

Classroom

public class Classroom.Invitations
extends Object

The "invitations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.Invitations.Accept
class	Classroom.Invitations.Create
class	Classroom.Invitations.Delete
class	Classroom.Invitations.Get
class	Classroom.Invitations.List

Constructor Summary

Constructors

Constructor and Description
Invitations()

Method Summary

Modifier and Type	Method and Description
Classroom.Invitations.Accept	accept(String id) Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course.
Classroom.Invitations.Create	create(Invitation content) Creates an invitation.
Classroom.Invitations.Delete	delete(String id) Deletes an invitation.
Classroom.Invitations.Get	get(String id) Returns an invitation.
Classroom.Invitations.List	list() Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Invitations

public Invitations()

Method Detail

accept

public Classroom.Invitations.Accept accept(String id)
                                    throws IOException

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID. Create a request for the method "invitations.accept". 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:

id - Identifier of the invitation to accept.

Returns:

the request

Throws:

IOException

create

public Classroom.Invitations.Create create(Invitation content)
                                    throws IOException

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists. Create a request for the method "invitations.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:

content - the Invitation

Returns:

the request

Throws:

IOException

delete

public Classroom.Invitations.Delete delete(String id)
                                    throws IOException

Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID. Create a request for the method "invitations.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:

id - Identifier of the invitation to delete.

Returns:

the request

Throws:

IOException

get

public Classroom.Invitations.Get get(String id)
                              throws IOException

Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID. Create a request for the method "invitations.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:

id - Identifier of the invitation to return.

Returns:

the request

Throws:

IOException

list

public Classroom.Invitations.List list()
                                throws IOException

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. Create a request for the method "invitations.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.

Returns:

the request

Throws:

IOException