com.google.api.services.classroom

Class Classroom.Courses

java.lang.Object

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

Enclosing class:

Classroom

public class Classroom.Courses
extends Object

The "courses" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Classroom.Courses.Aliases The "aliases" collection of methods.
class	Classroom.Courses.Announcements The "announcements" collection of methods.
class	Classroom.Courses.CourseWork The "courseWork" collection of methods.
class	Classroom.Courses.CourseWorkMaterials The "courseWorkMaterials" collection of methods.
class	Classroom.Courses.Create
class	Classroom.Courses.Delete
class	Classroom.Courses.Get
class	Classroom.Courses.List
class	Classroom.Courses.Patch
class	Classroom.Courses.Students The "students" collection of methods.
class	Classroom.Courses.Teachers The "teachers" collection of methods.
class	Classroom.Courses.Topics The "topics" collection of methods.
class	Classroom.Courses.Update

Constructor Summary

Constructors

Constructor and Description
Courses()

Method Summary

Modifier and Type	Method and Description
Classroom.Courses.Aliases	aliases() An accessor for creating requests from the Aliases collection.
Classroom.Courses.Announcements	announcements() An accessor for creating requests from the Announcements collection.
Classroom.Courses.CourseWork	courseWork() An accessor for creating requests from the CourseWork collection.
Classroom.Courses.CourseWorkMaterials	courseWorkMaterials() An accessor for creating requests from the CourseWorkMaterials collection.
Classroom.Courses.Create	create(Course content) Creates a course.
Classroom.Courses.Delete	delete(String id) Deletes a course.
Classroom.Courses.Get	get(String id) Returns a course.
Classroom.Courses.List	list() Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request.
Classroom.Courses.Patch	patch(String id, Course content) Updates one or more fields in a course.
Classroom.Courses.Students	students() An accessor for creating requests from the Students collection.
Classroom.Courses.Teachers	teachers() An accessor for creating requests from the Teachers collection.
Classroom.Courses.Topics	topics() An accessor for creating requests from the Topics collection.
Classroom.Courses.Update	update(String id, Course content) Updates a course.

Methods inherited from class java.lang.Object

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

Constructor Detail

Courses

public Courses()

Method Detail

create

public Classroom.Courses.Create create(Course content)
                                throws IOException

Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists. Create a request for the method "courses.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:

content - the Course

Returns:

the request

Throws:

IOException

delete

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

Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. Create a request for the method "courses.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:

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

Returns:

the request

Throws:

IOException

get

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

Returns a course. 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. * `NOT_FOUND` if no course exists with the requested ID. Create a request for the method "courses.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:

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

Returns:

the request

Throws:

IOException

list

public Classroom.Courses.List list()
                            throws IOException

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist. Create a request for the method "courses.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.

Returns:

the request

Throws:

IOException

patch

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

Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable Create a request for the method "courses.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:

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

content - the Course

Returns:

the request

Throws:

IOException

update

public Classroom.Courses.Update update(String id,
                                       Course content)
                                throws IOException

Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable Create a request for the method "courses.update". 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:

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

content - the Course

Returns:

the request

Throws:

IOException

aliases

public Classroom.Courses.Aliases aliases()

An accessor for creating requests from the Aliases collection.

The typical use is:

    Classroom classroom = new Classroom(...);
    Classroom.Aliases.List request = classroom.aliases().list(parameters ...)
 

Returns:

the resource collection

announcements

public Classroom.Courses.Announcements announcements()

An accessor for creating requests from the Announcements collection.

The typical use is:

    Classroom classroom = new Classroom(...);
    Classroom.Announcements.List request = classroom.announcements().list(parameters ...)
 

Returns:

the resource collection

courseWork

public Classroom.Courses.CourseWork courseWork()

An accessor for creating requests from the CourseWork collection.

The typical use is:

    Classroom classroom = new Classroom(...);
    Classroom.CourseWork.List request = classroom.courseWork().list(parameters ...)
 

Returns:

the resource collection

courseWorkMaterials

public Classroom.Courses.CourseWorkMaterials courseWorkMaterials()

An accessor for creating requests from the CourseWorkMaterials collection.

The typical use is:

    Classroom classroom = new Classroom(...);
    Classroom.CourseWorkMaterials.List request = classroom.courseWorkMaterials().list(parameters ...)
 

Returns:

the resource collection

students

public Classroom.Courses.Students students()

An accessor for creating requests from the Students collection.

The typical use is:

    Classroom classroom = new Classroom(...);
    Classroom.Students.List request = classroom.students().list(parameters ...)
 

Returns:

the resource collection

teachers

public Classroom.Courses.Teachers teachers()

An accessor for creating requests from the Teachers collection.

The typical use is:

    Classroom classroom = new Classroom(...);
    Classroom.Teachers.List request = classroom.teachers().list(parameters ...)
 

Returns:

the resource collection

topics

public Classroom.Courses.Topics topics()

An accessor for creating requests from the Topics collection.

The typical use is:

    Classroom classroom = new Classroom(...);
    Classroom.Topics.List request = classroom.topics().list(parameters ...)
 

Returns:

the resource collection