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

Contents

Description

Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).

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

Synopsis

REST Resource

type CoursesAliasesDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("aliases" :> (Capture "alias" 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.aliases.delete method which the CoursesAliasesDelete request conforms to.

Creating a Request

coursesAliasesDelete Source #

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

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

data CoursesAliasesDelete Source #

Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).

See: coursesAliasesDelete smart constructor.

Instances
Eq CoursesAliasesDelete Source # 
Instance details

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

Data CoursesAliasesDelete Source # 
Instance details

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

Methods

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

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

toConstr :: CoursesAliasesDelete -> Constr #

dataTypeOf :: CoursesAliasesDelete -> DataType #

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

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

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

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

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

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

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

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

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

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

Show CoursesAliasesDelete Source # 
Instance details

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

Generic CoursesAliasesDelete Source # 
Instance details

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

Associated Types

type Rep CoursesAliasesDelete :: Type -> Type #

GoogleRequest CoursesAliasesDelete Source # 
Instance details

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

Associated Types

type Rs CoursesAliasesDelete :: Type #

type Scopes CoursesAliasesDelete :: [Symbol] #

type Rep CoursesAliasesDelete Source # 
Instance details

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

type Rep CoursesAliasesDelete = D1 (MetaData "CoursesAliasesDelete" "Network.Google.Resource.Classroom.Courses.Aliases.Delete" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesAliasesDelete'" PrefixI True) ((S1 (MetaSel (Just "_cadXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_cadUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cadCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_cadAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cadUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cadAlias") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cadCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesAliasesDelete Source # 
Instance details

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

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

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

Request Lenses

cadUploadProtocol :: Lens' CoursesAliasesDelete (Maybe Text) Source #

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

cadCourseId :: Lens' CoursesAliasesDelete Text Source #

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

cadUploadType :: Lens' CoursesAliasesDelete (Maybe Text) Source #

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

cadAlias :: Lens' CoursesAliasesDelete Text Source #

Alias to delete. This may not be the Classroom-assigned identifier.