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_CoursesAnnouncements_Resource

The "announcements" collection of methods. Typical usage is:

 $classroomService = new Google_Service_Classroom(...);
 $announcements = $classroomService->announcements;
Google_Service_Resource
Extended by Google_Service_Classroom_CoursesAnnouncements_Resource
Located at Classroom.php
Methods summary
public Google_Service_Classroom_Announcement
# create( string $courseId, Google_Service_Classroom_Announcement $postBody, array $optParams = array() )

Creates an announcement.

Creates an announcement.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the

requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist. * FAILED_PRECONDITION for the following request error: * AttachmentNotVisible (announcements.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_Announcement
Google_Service_Classroom_Announcement
public Google_Service_Classroom_ClassroomEmpty
# delete( string $courseId, string $id, array $optParams = array() )

Deletes an announcement.

Deletes an announcement.

This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting developer project did not create the

corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * FAILED_PRECONDITION if the requested announcement has already been deleted. * NOT_FOUND if no course exists with the requested ID. (announcements.delete)

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$id
Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.
$optParams
Optional parameters.

Returns

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

Returns an announcement.

Returns an announcement.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the

requested course or announcement, or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or announcement does not exist. (announcements.get)

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$id
Identifier of the announcement.
$optParams
Optional parameters.

Returns

Google_Service_Classroom_Announcement
Google_Service_Classroom_Announcement
public Google_Service_Classroom_ListAnnouncementsResponse
# listCoursesAnnouncements( string $courseId, array $optParams = array() )

Returns a list of announcements that the requester is permitted to view.

Returns a list of announcements that the requester is permitted to view.

Course students may only view PUBLISHED announcements. Course teachers and domain administrators may view all announcements.

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. (announcements.listCoursesAnnouncements)

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_ListAnnouncementsResponse
Google_Service_Classroom_ListAnnouncementsResponse

Opt_param

string announcementStates Restriction on the state of announcements returned. If this argument is left unspecified, the default value is PUBLISHED.
string orderBy Optional sort ordering for results. A comma- separated list of fields with an optional sort direction keyword. Supported field is updateTime. Supported direction keywords are asc and desc. If not specified, updateTime desc is the default behavior. Examples: updateTime asc, updateTime
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_Announcement
# modifyAssignees( string $courseId, string $id, Google_Service_Classroom_ModifyAnnouncementAssigneesRequest $postBody, array $optParams = array() )

Modifies assignee mode and options of an announcement.

Modifies assignee mode and options of an announcement.

Only a teacher of the course that contains the announcement may call this method.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to access the

requested course or course work or for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or course work does not exist. (announcements.modifyAssignees)

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$id
Identifier of the announcement.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Classroom_Announcement
Google_Service_Classroom_Announcement
public Google_Service_Classroom_Announcement
# patch( string $courseId, string $id, Google_Service_Classroom_Announcement $postBody, array $optParams = array() )

Updates one or more fields of an announcement.

Updates one or more fields of an announcement.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting developer project did not create the

corresponding announcement or for access errors. * INVALID_ARGUMENT if the request is malformed. * FAILED_PRECONDITION if the requested announcement has already been deleted. * NOT_FOUND if the requested course or announcement does not exist (announcements.patch)

Parameters

$courseId
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
$id
Identifier of the announcement.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Classroom_Announcement
Google_Service_Classroom_Announcement

Opt_param

string updateMask Mask that identifies which fields on the announcement 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 Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * text * state * scheduled_time
© 2020 Google Inc.
Google Classroom API documentation generated by ApiGen 2.8.0