com.google.api.services.classroom

Class Classroom.Courses.CourseWorkMaterials

java.lang.Object

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

Enclosing class:

Classroom.Courses

public class Classroom.Courses.CourseWorkMaterials
extends Object

The "courseWorkMaterials" collection of methods.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CourseWorkMaterials()

Method Summary

Modifier and Type	Method and Description
Classroom.Courses.CourseWorkMaterials.Create	create(String courseId, CourseWorkMaterial content) Creates a course work material.
Classroom.Courses.CourseWorkMaterials.Delete	delete(String courseId, String id) Deletes a course work material.
Classroom.Courses.CourseWorkMaterials.Get	get(String courseId, String id) Returns a course work material.
Classroom.Courses.CourseWorkMaterials.List	list(String courseId) Returns a list of course work material that the requester is permitted to view.
Classroom.Courses.CourseWorkMaterials.Patch	patch(String courseId, String id, CourseWorkMaterial content) Updates one or more fields of a course work material.

Methods inherited from class java.lang.Object

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

Constructor Detail

CourseWorkMaterials

public CourseWorkMaterials()

Method Detail

create

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

Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible Create a request for the method "courseWorkMaterials.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 CourseWorkMaterial

Returns:

the request

Throws:

IOException

delete

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

Deletes a course work material. 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 material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. Create a request for the method "courseWorkMaterials.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 material to delete. This identifier is a Classroom-assigned identifier.

Returns:

the request

Throws:

IOException

get

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

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

Returns:

the request

Throws:

IOException

list

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

Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. 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 "courseWorkMaterials.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

patch

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

Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if the requested course or course work material does not exist Create a request for the method "courseWorkMaterials.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 material.

content - the CourseWorkMaterial

Returns:

the request

Throws:

IOException