gogol-classroom-0.4.0: Google Classroom SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Classroom.Courses.Announcements.Delete

Contents

Description

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

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
Eq CoursesAnnouncementsDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Delete

Data CoursesAnnouncementsDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Delete

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesAnnouncementsDelete -> c CoursesAnnouncementsDelete #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesAnnouncementsDelete #

toConstr :: CoursesAnnouncementsDelete -> Constr #

dataTypeOf :: CoursesAnnouncementsDelete -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesAnnouncementsDelete) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesAnnouncementsDelete) #

gmapT :: (forall b. Data b => b -> b) -> CoursesAnnouncementsDelete -> CoursesAnnouncementsDelete #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesAnnouncementsDelete -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesAnnouncementsDelete -> r #

gmapQ :: (forall d. Data d => d -> u) -> CoursesAnnouncementsDelete -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesAnnouncementsDelete -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesAnnouncementsDelete -> m CoursesAnnouncementsDelete #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesAnnouncementsDelete -> m CoursesAnnouncementsDelete #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesAnnouncementsDelete -> m CoursesAnnouncementsDelete #

Show CoursesAnnouncementsDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Delete

Generic CoursesAnnouncementsDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Delete

Associated Types

type Rep CoursesAnnouncementsDelete :: Type -> Type #

GoogleRequest CoursesAnnouncementsDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Delete

type Rep CoursesAnnouncementsDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Delete

type Rep CoursesAnnouncementsDelete = D1 (MetaData "CoursesAnnouncementsDelete" "Network.Google.Resource.Classroom.Courses.Announcements.Delete" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesAnnouncementsDelete'" PrefixI True) ((S1 (MetaSel (Just "_cXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_cUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_cAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesAnnouncementsDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Delete

type Scopes CoursesAnnouncementsDelete = "https://www.googleapis.com/auth/classroom.announcements" ': ([] :: [Symbol])
type Rs CoursesAnnouncementsDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Delete

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.

cUploadType :: Lens' CoursesAnnouncementsDelete (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

cId :: Lens' CoursesAnnouncementsDelete Text Source #

Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.