The "announcements" collection of methods. Typical usage is:
$classroomService = new Google_Service_Classroom(...);
$announcements = $classroomService->announcements;
Methods summary
public
Google_Service_Classroom_Announcement
|
#
create( string $courseId, Google_Service_Classroom_Announcement $postBody, array $optParams = array() )
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
|
public
Google_Service_Classroom_ClassroomEmpty
|
#
delete( string $courseId, string $id, array $optParams = array() )
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
|
public
Google_Service_Classroom_Announcement
|
#
get( string $courseId, string $id, array $optParams = array() )
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
|
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
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
|
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
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
|
Google_Service_Classroom_CoursesAnnouncements_Resource