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

Contents

Description

Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

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

Synopsis

REST Resource

type CoursesDeleteResource = "v1" :> ("courses" :> (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.delete method which the CoursesDelete request conforms to.

Creating a Request

coursesDelete Source #

Arguments

:: Text

cdId

-> CoursesDelete 

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

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

data CoursesDelete Source #

Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

See: coursesDelete smart constructor.

Instances
Eq CoursesDelete Source # 
Instance details

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

Methods

(==) :: CoursesDelete -> CoursesDelete -> Bool #

(/=) :: CoursesDelete -> CoursesDelete -> Bool #

Data CoursesDelete Source # 
Instance details

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

Methods

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

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

toConstr :: CoursesDelete -> Constr #

dataTypeOf :: CoursesDelete -> DataType #

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

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

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

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

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

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

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

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

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

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

Show CoursesDelete Source # 
Instance details

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

Methods

showsPrec :: Int -> CoursesDelete -> ShowS #

show :: CoursesDelete -> String #

showList :: [CoursesDelete] -> ShowS #

Generic CoursesDelete Source # 
Instance details

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

Associated Types

type Rep CoursesDelete :: Type -> Type #

Methods

from :: CoursesDelete -> Rep CoursesDelete x #

to :: Rep CoursesDelete x -> CoursesDelete #

GoogleRequest CoursesDelete Source # 
Instance details

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

Associated Types

type Rs CoursesDelete :: Type #

type Scopes CoursesDelete :: [Symbol] #

Methods

requestClient :: CoursesDelete -> GClient (Rs CoursesDelete) #

type Rep CoursesDelete Source # 
Instance details

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

type Rep CoursesDelete = D1 (MetaData "CoursesDelete" "Network.Google.Resource.Classroom.Courses.Delete" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesDelete'" PrefixI True) ((S1 (MetaSel (Just "_cdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_cdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_cdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_cdId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesDelete Source # 
Instance details

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

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

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

type Rs CoursesDelete = Empty

Request Lenses

cdXgafv :: Lens' CoursesDelete (Maybe Xgafv) Source #

V1 error format.

cdUploadProtocol :: Lens' CoursesDelete (Maybe Text) Source #

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

cdAccessToken :: Lens' CoursesDelete (Maybe Text) Source #

OAuth access token.

cdUploadType :: Lens' CoursesDelete (Maybe Text) Source #

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

cdId :: Lens' CoursesDelete Text Source #

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

cdCallback :: Lens' CoursesDelete (Maybe Text) Source #

JSONP