CoursesTopics
class CoursesTopics extends Resource (View source)
The "topics" collection of methods.
Typical usage is:
$classroomService = new Google\Service\Classroom(...);
$topics = $classroomService->courses_topics;
Methods
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. (topics.create)
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. (topics.delete)
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. (topics.get)
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. (topics.listCoursesTopics)
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 (topics.patch)
Details
Topic
create(string $courseId, Topic $postBody, array $optParams = [])
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. (topics.create)
ClassroomEmpty
delete(string $courseId, string $id, array $optParams = [])
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. (topics.delete)
Topic
get(string $courseId, string $id, array $optParams = [])
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. (topics.get)
ListTopicResponse
listCoursesTopics(string $courseId, array $optParams = [])
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. (topics.listCoursesTopics)
Topic
patch(string $courseId, string $id, Topic $postBody, array $optParams = [])
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 (topics.patch)