com.google.api.services.classroom

Class Classroom.Courses.CourseWork

java.lang.Object

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

Enclosing class:

Classroom.Courses

public class Classroom.Courses.CourseWork
extends Object

The "courseWork" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.Courses.CourseWork.Create
class	Classroom.Courses.CourseWork.Delete
class	Classroom.Courses.CourseWork.Get
class	Classroom.Courses.CourseWork.List
class	Classroom.Courses.CourseWork.ModifyAssignees
class	Classroom.Courses.CourseWork.Patch
class	Classroom.Courses.CourseWork.StudentSubmissions The "studentSubmissions" collection of methods.

Constructor Summary

Constructors

Constructor and Description
CourseWork()

Method Summary

Modifier and Type	Method and Description
Classroom.Courses.CourseWork.Create	create(String courseId, CourseWork content) Creates course work.
Classroom.Courses.CourseWork.Delete	delete(String courseId, String id) Deletes a course work.
Classroom.Courses.CourseWork.Get	get(String courseId, String id) Returns course work.
Classroom.Courses.CourseWork.List	list(String courseId) Returns a list of course work that the requester is permitted to view.
Classroom.Courses.CourseWork.ModifyAssignees	modifyAssignees(String courseId, String id, ModifyCourseWorkAssigneesRequest content) Modifies assignee mode and options of a coursework.
Classroom.Courses.CourseWork.Patch	patch(String courseId, String id, CourseWork content) Updates one or more fields of a course work.
Classroom.Courses.CourseWork.StudentSubmissions	studentSubmissions() An accessor for creating requests from the StudentSubmissions collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

CourseWork

public CourseWork()

Method Detail

create

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

Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible Create a request for the method "courseWork.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 CourseWork

Returns:

the request

Throws:

IOException

delete

public Classroom.Courses.CourseWork.Delete delete(String courseId,
                                                  String id)
                                           throws IOException

Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. Create a request for the method "courseWork.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.

id - Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.

Returns:

the request

Throws:

IOException

get

public Classroom.Courses.CourseWork.Get get(String courseId,
                                            String id)
                                     throws IOException

Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. Create a request for the method "courseWork.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.

id - Identifier of the course work.

Returns:

the request

Throws:

IOException

list

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

Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. Create a request for the method "courseWork.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

modifyAssignees

public Classroom.Courses.CourseWork.ModifyAssignees modifyAssignees(String courseId,
                                                                    String id,
                                                                    ModifyCourseWorkAssigneesRequest content)
                                                             throws IOException

Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. Create a request for the method "courseWork.modifyAssignees". 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.

id - Identifier of the coursework.

content - the ModifyCourseWorkAssigneesRequest

Returns:

the request

Throws:

IOException

patch

public Classroom.Courses.CourseWork.Patch patch(String courseId,
                                                String id,
                                                CourseWork content)
                                         throws IOException

Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. Create a request for the method "courseWork.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:

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

id - Identifier of the course work.

content - the CourseWork

Returns:

the request

Throws:

IOException

studentSubmissions

public Classroom.Courses.CourseWork.StudentSubmissions studentSubmissions()

An accessor for creating requests from the StudentSubmissions collection.

The typical use is:

    Classroom classroom = new Classroom(...);
    Classroom.StudentSubmissions.List request = classroom.studentSubmissions().list(parameters ...)
 

Returns:

the resource collection