Overview

Classes

  • Google_Service_Classroom
  • Google_Service_Classroom_Announcement
  • Google_Service_Classroom_Assignment
  • Google_Service_Classroom_AssignmentSubmission
  • Google_Service_Classroom_Attachment
  • Google_Service_Classroom_ClassroomEmpty
  • Google_Service_Classroom_CloudPubsubTopic
  • Google_Service_Classroom_Course
  • Google_Service_Classroom_CourseAlias
  • Google_Service_Classroom_CourseMaterial
  • Google_Service_Classroom_CourseMaterialSet
  • Google_Service_Classroom_CourseRosterChangesInfo
  • Google_Service_Classroom_Courses_Resource
  • Google_Service_Classroom_CoursesAliases_Resource
  • Google_Service_Classroom_CoursesAnnouncements_Resource
  • Google_Service_Classroom_CoursesCourseWork_Resource
  • Google_Service_Classroom_CoursesCourseWorkStudentSubmissions_Resource
  • Google_Service_Classroom_CoursesStudents_Resource
  • Google_Service_Classroom_CoursesTeachers_Resource
  • Google_Service_Classroom_CoursesTopics_Resource
  • Google_Service_Classroom_CourseWork
  • Google_Service_Classroom_CourseWorkChangesInfo
  • Google_Service_Classroom_Date
  • Google_Service_Classroom_DriveFile
  • Google_Service_Classroom_DriveFolder
  • Google_Service_Classroom_Feed
  • Google_Service_Classroom_Form
  • Google_Service_Classroom_GlobalPermission
  • Google_Service_Classroom_GradeHistory
  • Google_Service_Classroom_Guardian
  • Google_Service_Classroom_GuardianInvitation
  • Google_Service_Classroom_IndividualStudentsOptions
  • Google_Service_Classroom_Invitation
  • Google_Service_Classroom_Invitations_Resource
  • Google_Service_Classroom_Link
  • Google_Service_Classroom_ListAnnouncementsResponse
  • Google_Service_Classroom_ListCourseAliasesResponse
  • Google_Service_Classroom_ListCoursesResponse
  • Google_Service_Classroom_ListCourseWorkResponse
  • Google_Service_Classroom_ListGuardianInvitationsResponse
  • Google_Service_Classroom_ListGuardiansResponse
  • Google_Service_Classroom_ListInvitationsResponse
  • Google_Service_Classroom_ListStudentsResponse
  • Google_Service_Classroom_ListStudentSubmissionsResponse
  • Google_Service_Classroom_ListTeachersResponse
  • Google_Service_Classroom_ListTopicResponse
  • Google_Service_Classroom_Material
  • Google_Service_Classroom_ModifyAnnouncementAssigneesRequest
  • Google_Service_Classroom_ModifyAttachmentsRequest
  • Google_Service_Classroom_ModifyCourseWorkAssigneesRequest
  • Google_Service_Classroom_ModifyIndividualStudentsOptions
  • Google_Service_Classroom_MultipleChoiceQuestion
  • Google_Service_Classroom_MultipleChoiceSubmission
  • Google_Service_Classroom_Name
  • Google_Service_Classroom_ReclaimStudentSubmissionRequest
  • Google_Service_Classroom_Registration
  • Google_Service_Classroom_Registrations_Resource
  • Google_Service_Classroom_ReturnStudentSubmissionRequest
  • Google_Service_Classroom_SharedDriveFile
  • Google_Service_Classroom_ShortAnswerSubmission
  • Google_Service_Classroom_StateHistory
  • Google_Service_Classroom_Student
  • Google_Service_Classroom_StudentSubmission
  • Google_Service_Classroom_SubmissionHistory
  • Google_Service_Classroom_Teacher
  • Google_Service_Classroom_TimeOfDay
  • Google_Service_Classroom_Topic
  • Google_Service_Classroom_TurnInStudentSubmissionRequest
  • Google_Service_Classroom_UserProfile
  • Google_Service_Classroom_UserProfiles_Resource
  • Google_Service_Classroom_UserProfilesGuardianInvitations_Resource
  • Google_Service_Classroom_UserProfilesGuardians_Resource
  • Google_Service_Classroom_YouTubeVideo
  • Overview
  • Class
  • Tree

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
Extended by 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.

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

Google_Service_Classroom_Topic
Google_Service_Classroom_Topic
public Google_Service_Classroom_ClassroomEmpty
# delete( string $courseId, string $id, array $optParams = array() )

Deletes a topic.

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

Google_Service_Classroom_ClassroomEmpty
Google_Service_Classroom_ClassroomEmpty
public Google_Service_Classroom_Topic
# get( string $courseId, string $id, array $optParams = array() )

Returns a topic.

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

Google_Service_Classroom_Topic
Google_Service_Classroom_Topic
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

Google_Service_Classroom_ListTopicResponse
Google_Service_Classroom_ListTopicResponse

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

Google_Service_Classroom_Topic
Google_Service_Classroom_Topic

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
© 2020 Google Inc.
Google Classroom API documentation generated by ApiGen 2.8.0