com.google.api.services.classroom

Class Classroom.Courses.Students

java.lang.Object

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

Enclosing class:

Classroom.Courses

public class Classroom.Courses.Students
extends Object

The "students" collection of methods.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Students()

Method Summary

Modifier and Type	Method and Description
Classroom.Courses.Students.Create	create(String courseId, Student content) Adds a user as a student of a course.
Classroom.Courses.Students.Delete	delete(String courseId, String userId) Deletes a student of a course.
Classroom.Courses.Students.Get	get(String courseId, String userId) Returns a student of a course.
Classroom.Courses.Students.List	list(String courseId) Returns a list of students 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

Students

public Students()

Method Detail

create

public Classroom.Courses.Students.Create create(String courseId,
                                                Student content)
                                         throws IOException

Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students 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 * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course. Create a request for the method "students.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 to create the student in. This identifier can be either the Classroom- assigned identifier or an alias.

content - the Student

Returns:

the request

Throws:

IOException

delete

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

Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. Create a request for the method "students.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 student 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.Students.Get get(String courseId,
                                          String userId)
                                   throws IOException

Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. Create a request for the method "students.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 student 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.Students.List list(String courseId)
                                     throws IOException

Returns a list of students 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 "students.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