Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Deletes an announcement. This request must be made by the Developer Console project of the OAuth client ID 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.
See: Google Classroom API Reference for classroom.courses.announcements.delete
.
Synopsis
- type CoursesAnnouncementsDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("announcements" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty))))))))))
- coursesAnnouncementsDelete :: Text -> Text -> CoursesAnnouncementsDelete
- data CoursesAnnouncementsDelete
- cXgafv :: Lens' CoursesAnnouncementsDelete (Maybe Xgafv)
- cUploadProtocol :: Lens' CoursesAnnouncementsDelete (Maybe Text)
- cCourseId :: Lens' CoursesAnnouncementsDelete Text
- cAccessToken :: Lens' CoursesAnnouncementsDelete (Maybe Text)
- cUploadType :: Lens' CoursesAnnouncementsDelete (Maybe Text)
- cId :: Lens' CoursesAnnouncementsDelete Text
- cCallback :: Lens' CoursesAnnouncementsDelete (Maybe Text)
REST Resource
type CoursesAnnouncementsDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("announcements" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty)))))))))) Source #
A resource alias for classroom.courses.announcements.delete
method which the
CoursesAnnouncementsDelete
request conforms to.
Creating a Request
coursesAnnouncementsDelete Source #
Creates a value of CoursesAnnouncementsDelete
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesAnnouncementsDelete Source #
Deletes an announcement. This request must be made by the Developer Console project of the OAuth client ID 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.
See: coursesAnnouncementsDelete
smart constructor.
Instances
Request Lenses
cUploadProtocol :: Lens' CoursesAnnouncementsDelete (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
cCourseId :: Lens' CoursesAnnouncementsDelete Text Source #
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
cAccessToken :: Lens' CoursesAnnouncementsDelete (Maybe Text) Source #
OAuth access token.
cUploadType :: Lens' CoursesAnnouncementsDelete (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").