com.google.api.services.classroom

Class Classroom.Courses.Teachers

java.lang.Object

com.google.api.services.classroom.Classroom.Courses.Teachers

Enclosing class:

Classroom.Courses

public class Classroom.Courses.Teachers
extends Object

The "teachers" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.Courses.Teachers.Create
class	Classroom.Courses.Teachers.Delete
class	Classroom.Courses.Teachers.Get
class	Classroom.Courses.Teachers.List

Constructor Summary

Constructors

Constructor and Description
Teachers()

Method Summary

Modifier and Type	Method and Description
Classroom.Courses.Teachers.Create	create(String courseId, Teacher content) Creates a teacher of a course.
Classroom.Courses.Teachers.Delete	delete(String courseId, String userId) Removes the specified teacher from the specified course.
Classroom.Courses.Teachers.Get	get(String courseId, String userId) Returns a teacher of a course.
Classroom.Courses.Teachers.List	list(String courseId) Returns a list of teachers of this course that the requester is permitted to view.

Methods inherited from class java.lang.Object

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

Constructor Detail

Teachers

public Teachers()

Method Detail

create

public Classroom.Courses.Teachers.Create create(String courseId,
                                                Teacher content)
                                         throws IOException

Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course. Create a request for the method "teachers.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:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

content - the Teacher

Returns:

the request

Throws:

IOException

delete

public Classroom.Courses.Teachers.Delete delete(String courseId,
                                                String userId)
                                         throws IOException

Removes the specified teacher from the specified course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner. Create a request for the method "teachers.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:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

userId - Identifier of the teacher to delete. 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

Returns:

the request

Throws:

IOException

get

public Classroom.Courses.Teachers.Get get(String courseId,
                                          String userId)
                                   throws IOException

Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. Create a request for the method "teachers.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:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

userId - Identifier of the teacher to return. 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

Returns:

the request

Throws:

IOException

list

public Classroom.Courses.Teachers.List list(String courseId)
                                     throws IOException

Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors. Create a request for the method "teachers.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:

courseId - Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Returns:

the request

Throws:

IOException