Class Google_Service_Classroom_CoursesTopics_Resource
The "topics" collection of methods. Typical usage is:
$classroomService = new Google_Service_Classroom(...);
$topics = $classroomService->topics;
-
Google_Service_Resource
-
Google_Service_Classroom_CoursesTopics_Resource
Located at Classroom.php
Methods summary
public
Google_Service_Classroom_Topic
|
#
create( string $courseId, Google_Service_Classroom_Topic $postBody, array $optParams = array() )
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)
Parameters
- $courseId
- Identifier of the course. This identifier can be either the Classroom-assigned
identifier or an alias.
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ClassroomEmpty
|
#
delete( string $courseId, string $id, array $optParams = array() )
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)
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.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_Topic
|
#
get( string $courseId, string $id, array $optParams = array() )
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)
Parameters
- $courseId
- Identifier of the course.
- $id
- Identifier of the topic.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ListTopicResponse
|
#
listCoursesTopics( string $courseId, array $optParams = array() )
Returns the list of topics that the requester is permitted to view.
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)
Parameters
- $courseId
- Identifier of the course. This identifier can be either the Classroom-assigned
identifier or an alias.
- $optParams
- Optional parameters.
Returns
Opt_param
string pageToken nextPageToken value returned from a previous list call,
indicating that the subsequent page of results should be returned. The list
request must be otherwise identical to the one that resulted in this token.
int pageSize Maximum number of items to return. Zero or unspecified indicates
that the server may assign a maximum. The server may return fewer than the
specified number of results.
|
public
Google_Service_Classroom_Topic
|
#
patch( string $courseId, string $id, Google_Service_Classroom_Topic $postBody, array $optParams = array() )
Updates one or more fields of a topic.
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)
Parameters
- $courseId
- Identifier of the course. This identifier can be either the Classroom-assigned
identifier or an alias.
- $id
- Identifier of the topic.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
string updateMask Mask that identifies which fields on the topic to update. This
field is required to do an update. The update fails if invalid fields are
specified. If a field supports empty values, it can be cleared by specifying it
in the update mask and not in the Topic object. If a field that does not support
empty values is included in the update mask and not set in the Topic object, an
INVALID_ARGUMENT error is returned. The following fields may be
specified: * name
|