com.google.api.services.classroom

Class Classroom.Courses.CourseWork.StudentSubmissions

java.lang.Object

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

Enclosing class:

Classroom.Courses.CourseWork

public class Classroom.Courses.CourseWork.StudentSubmissions
extends Object

The "studentSubmissions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.Courses.CourseWork.StudentSubmissions.ClassroomReturn
class	Classroom.Courses.CourseWork.StudentSubmissions.Get
class	Classroom.Courses.CourseWork.StudentSubmissions.List
class	Classroom.Courses.CourseWork.StudentSubmissions.ModifyAttachments
class	Classroom.Courses.CourseWork.StudentSubmissions.Patch
class	Classroom.Courses.CourseWork.StudentSubmissions.Reclaim
class	Classroom.Courses.CourseWork.StudentSubmissions.TurnIn

Constructor Summary

Constructors

Constructor and Description
StudentSubmissions()

Method Summary

Modifier and Type	Method and Description
Classroom.Courses.CourseWork.StudentSubmissions.ClassroomReturn	classroomReturn(String courseId, String courseWorkId, String id, ReturnStudentSubmissionRequest content) Returns a student submission.
Classroom.Courses.CourseWork.StudentSubmissions.Get	get(String courseId, String courseWorkId, String id) Returns a student submission.
Classroom.Courses.CourseWork.StudentSubmissions.List	list(String courseId, String courseWorkId) Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request.
Classroom.Courses.CourseWork.StudentSubmissions.ModifyAttachments	modifyAttachments(String courseId, String courseWorkId, String id, ModifyAttachmentsRequest content) Modifies attachments of student submission.
Classroom.Courses.CourseWork.StudentSubmissions.Patch	patch(String courseId, String courseWorkId, String id, StudentSubmission content) Updates one or more fields of a student submission.
Classroom.Courses.CourseWork.StudentSubmissions.Reclaim	reclaim(String courseId, String courseWorkId, String id, ReclaimStudentSubmissionRequest content) Reclaims a student submission on behalf of the student that owns it.
Classroom.Courses.CourseWork.StudentSubmissions.TurnIn	turnIn(String courseId, String courseWorkId, String id, TurnInStudentSubmissionRequest content) Turns in a student submission.

Methods inherited from class java.lang.Object

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

Constructor Detail

StudentSubmissions

public StudentSubmissions()

Method Detail

get

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

Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. Create a request for the method "studentSubmissions.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.

courseWorkId - Identifier of the course work.

id - Identifier of the student submission.

Returns:

the request

Throws:

IOException

list

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

Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. 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 does not exist. Create a request for the method "studentSubmissions.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.

courseWorkId - Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course.

Returns:

the request

Throws:

IOException

modifyAttachments

public Classroom.Courses.CourseWork.StudentSubmissions.ModifyAttachments modifyAttachments(String courseId,
                                                                                           String courseWorkId,
                                                                                           String id,
                                                                                           ModifyAttachmentsRequest content)
                                                                                    throws IOException

Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. 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 user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. Create a request for the method "studentSubmissions.modifyAttachments". 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.

courseWorkId - Identifier of the course work.

id - Identifier of the student submission.

content - the ModifyAttachmentsRequest

Returns:

the request

Throws:

IOException

patch

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

Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission 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. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. Create a request for the method "studentSubmissions.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.

courseWorkId - Identifier of the course work.

id - Identifier of the student submission.

content - the StudentSubmission

Returns:

the request

Throws:

IOException

reclaim

public Classroom.Courses.CourseWork.StudentSubmissions.Reclaim reclaim(String courseId,
                                                                       String courseWorkId,
                                                                       String id,
                                                                       ReclaimStudentSubmissionRequest content)
                                                                throws IOException

Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. 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 user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. Create a request for the method "studentSubmissions.reclaim". 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.

courseWorkId - Identifier of the course work.

id - Identifier of the student submission.

content - the ReclaimStudentSubmissionRequest

Returns:

the request

Throws:

IOException

classroomReturn

public Classroom.Courses.CourseWork.StudentSubmissions.ClassroomReturn classroomReturn(String courseId,
                                                                                       String courseWorkId,
                                                                                       String id,
                                                                                       ReturnStudentSubmissionRequest content)
                                                                                throws IOException

Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. 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 user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. Create a request for the method "studentSubmissions.return". 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.

courseWorkId - Identifier of the course work.

id - Identifier of the student submission.

content - the ReturnStudentSubmissionRequest

Returns:

the request

Throws:

IOException

turnIn

public Classroom.Courses.CourseWork.StudentSubmissions.TurnIn turnIn(String courseId,
                                                                     String courseWorkId,
                                                                     String id,
                                                                     TurnInStudentSubmissionRequest content)
                                                              throws IOException

Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. 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 user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. Create a request for the method "studentSubmissions.turnIn". 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.

courseWorkId - Identifier of the course work.

id - Identifier of the student submission.

content - the TurnInStudentSubmissionRequest

Returns:

the request

Throws:

IOException