📄 Source: CoursesAnnouncements.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Classroom\Resource;
use Google\Service\Classroom\AddOnContext;
use Google\Service\Classroom\Announcement;
use Google\Service\Classroom\ClassroomEmpty;
use Google\Service\Classroom\ListAnnouncementsResponse;
use Google\Service\Classroom\ModifyAnnouncementAssigneesRequest;
/**
* The "announcements" collection of methods.
* Typical usage is:
* <code>
* $classroomService = new Google\Service\Classroom(...);
* $announcements = $classroomService->courses_announcements;
* </code>
*/
class CoursesAnnouncements extends \Google\Service\Resource
{
/**
* 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)
*
* @param string $courseId Identifier of the course. This identifier can be
* either the Classroom-assigned identifier or an alias.
* @param Announcement $postBody
* @param array $optParams Optional parameters.
* @return Announcement
* @throws \Google\Service\Exception
*/
public function create($courseId, Announcement $postBody, $optParams = [])
{
$params = ['courseId' => $courseId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Announcement::class);
}
/**
* 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)
*
* @param string $courseId Identifier of the course. This identifier can be
* either the Classroom-assigned identifier or an alias.
* @param string $id Identifier of the announcement to delete. This identifier
* is a Classroom-assigned identifier.
* @param array $optParams Optional parameters.
* @return ClassroomEmpty
* @throws \Google\Service\Exception
*/
public function delete($courseId, $id, $optParams = [])
{
$params = ['courseId' => $courseId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], ClassroomEmpty::class);
}
/**
* 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)
*
* @param string $courseId Identifier of the course. This identifier can be
* either the Classroom-assigned identifier or an alias.
* @param string $id Identifier of the announcement.
* @param array $optParams Optional parameters.
* @return Announcement
* @throws \Google\Service\Exception
*/
public function get($courseId, $id, $optParams = [])
{
$params = ['courseId' => $courseId, 'id' => $id];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Announcement::class);
}
/**
* Gets metadata for Classroom add-ons in the context of a specific post. To
* maintain the integrity of its own data and permissions model, an add-on
* should call this to validate query parameters and the requesting user's role
* whenever the add-on is opened in an
* [iframe](https://developers.google.com/workspace/classroom/add-ons/get-
* started/iframes/iframes-overview). This method returns the following error
* codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the
* request is malformed. * `NOT_FOUND` if one of the identified resources does
* not exist. (announcements.getAddOnContext)
*
* @param string $courseId Required. Identifier of the course.
* @param string $itemId Identifier of the `Announcement`, `CourseWork`, or
* `CourseWorkMaterial` under which the attachment is attached. This field is
* required, but is not marked as such while we are migrating from post_id.
* @param array $optParams Optional parameters.
*
* @opt_param string addOnToken Optional. Token that authorizes the request. The
* token is passed as a query parameter when the user is redirected from
* Classroom to the add-on's URL. The authorization token is required when
* neither of the following is true: * The add-on has attachments on the post. *
* The developer project issuing the request is the same project that created
* the post.
* @opt_param string attachmentId Optional. The identifier of the attachment.
* This field is required for all requests except when the user is in the
* [Attachment Discovery
* iframe](https://developers.google.com/workspace/classroom/add-ons/get-
* started/iframes/attachment-discovery-iframe).
* @opt_param string postId Optional. Deprecated, use `item_id` instead.
* @return AddOnContext
* @throws \Google\Service\Exception
*/
public function getAddOnContext($courseId, $itemId, $optParams = [])
{
$params = ['courseId' => $courseId, 'itemId' => $itemId];
$params = array_merge($params, $optParams);
return $this->call('getAddOnContext', [$params], AddOnContext::class);
}
/**
* 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)
*
* @param string $courseId Identifier of the course. This identifier can be
* either the Classroom-assigned identifier or an alias.
* @param array $optParams Optional parameters.
*
* @opt_param string announcementStates Restriction on the `state` of
* announcements returned. If this argument is left unspecified, the default
* value is `PUBLISHED`.
* @opt_param 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`
* @opt_param 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.
* @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.
* @return ListAnnouncementsResponse
* @throws \Google\Service\Exception
*/
public function listCoursesAnnouncements($courseId, $optParams = [])
{
$params = ['courseId' => $courseId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListAnnouncementsResponse::class);
}
/**
* 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. *
* `FAILED_PRECONDITION` for the following request error: * EmptyAssignees
* (announcements.modifyAssignees)
*
* @param string $courseId Identifier of the course. This identifier can be
* either the Classroom-assigned identifier or an alias.
* @param string $id Identifier of the announcement.
* @param ModifyAnnouncementAssigneesRequest $postBody
* @param array $optParams Optional parameters.
* @return Announcement
* @throws \Google\Service\Exception
*/
public function modifyAssignees($courseId, $id, ModifyAnnouncementAssigneesRequest $postBody, $optParams = [])
{
$params = ['courseId' => $courseId, 'id' => $id, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('modifyAssignees', [$params], Announcement::class);
}
/**
* 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)
*
* @param string $courseId Identifier of the course. This identifier can be
* either the Classroom-assigned identifier or an alias.
* @param string $id Identifier of the announcement.
* @param Announcement $postBody
* @param array $optParams Optional parameters.
*
* @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`
* @return Announcement
* @throws \Google\Service\Exception
*/
public function patch($courseId, $id, Announcement $postBody, $optParams = [])
{
$params = ['courseId' => $courseId, 'id' => $id, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Announcement::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CoursesAnnouncements::class, 'Google_Service_Classroom_Resource_CoursesAnnouncements');
← Back