com.google.api.services.classroom

Class Classroom.Courses.Topics

java.lang.Object

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

Enclosing class:

Classroom.Courses

public class Classroom.Courses.Topics
extends Object

The "topics" collection of methods.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Topics()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Topics

public Topics()

Method Detail

create

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

Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in 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 "topics.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 Topic

Returns:

the request

Throws:

IOException

delete

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

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

Returns:

the request

Throws:

IOException

get

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

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

id - Identifier of the topic.

Returns:

the request

Throws:

IOException

list

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

Returns the list of topics that the requester is permitted to view. 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 "topics.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.Topics.Patch patch(String courseId,
                                            String id,
                                            Topic content)
                                     throws IOException

Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist Create a request for the method "topics.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 topic.

content - the Topic

Returns:

the request

Throws:

IOException