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.CourseWork.Delete

Contents

Description

Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

See: Google Classroom API Reference for classroom.courses.courseWork.delete.

Synopsis

REST Resource

type CoursesCourseWorkDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (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.courseWork.delete method which the CoursesCourseWorkDelete request conforms to.

Creating a Request

coursesCourseWorkDelete Source #

Creates a value of CoursesCourseWorkDelete with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CoursesCourseWorkDelete Source #

Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

See: coursesCourseWorkDelete smart constructor.

Instances
Eq CoursesCourseWorkDelete Source # 
Instance details

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

Data CoursesCourseWorkDelete Source # 
Instance details

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

Methods

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

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

toConstr :: CoursesCourseWorkDelete -> Constr #

dataTypeOf :: CoursesCourseWorkDelete -> DataType #

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

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

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

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

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

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

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

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

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

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

Show CoursesCourseWorkDelete Source # 
Instance details

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

Generic CoursesCourseWorkDelete Source # 
Instance details

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

Associated Types

type Rep CoursesCourseWorkDelete :: Type -> Type #

GoogleRequest CoursesCourseWorkDelete Source # 
Instance details

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

type Rep CoursesCourseWorkDelete Source # 
Instance details

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

type Rep CoursesCourseWorkDelete = D1 (MetaData "CoursesCourseWorkDelete" "Network.Google.Resource.Classroom.Courses.CourseWork.Delete" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesCourseWorkDelete'" PrefixI True) ((S1 (MetaSel (Just "_ccwdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_ccwdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ccwdCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_ccwdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ccwdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ccwdId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ccwdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesCourseWorkDelete Source # 
Instance details

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

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

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

Request Lenses

ccwdUploadProtocol :: Lens' CoursesCourseWorkDelete (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

ccwdCourseId :: Lens' CoursesCourseWorkDelete Text Source #

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

ccwdUploadType :: Lens' CoursesCourseWorkDelete (Maybe Text) Source #

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

ccwdId :: Lens' CoursesCourseWorkDelete Text Source #

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