gogol-classroom-0.5.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.Topics.Create

Contents

Description

Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

See: Google Classroom API Reference for classroom.courses.topics.create.

Synopsis

REST Resource

type CoursesTopicsCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("topics" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Topic :> Post '[JSON] Topic)))))))))) Source #

A resource alias for classroom.courses.topics.create method which the CoursesTopicsCreate request conforms to.

Creating a Request

coursesTopicsCreate Source #

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

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

data CoursesTopicsCreate Source #

Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

See: coursesTopicsCreate smart constructor.

Instances
Eq CoursesTopicsCreate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Topics.Create

Data CoursesTopicsCreate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Topics.Create

Methods

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

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

toConstr :: CoursesTopicsCreate -> Constr #

dataTypeOf :: CoursesTopicsCreate -> DataType #

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

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

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

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

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

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

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

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

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

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

Show CoursesTopicsCreate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Topics.Create

Generic CoursesTopicsCreate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Topics.Create

Associated Types

type Rep CoursesTopicsCreate :: Type -> Type #

GoogleRequest CoursesTopicsCreate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Topics.Create

Associated Types

type Rs CoursesTopicsCreate :: Type #

type Scopes CoursesTopicsCreate :: [Symbol] #

type Rep CoursesTopicsCreate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Topics.Create

type Rep CoursesTopicsCreate = D1 (MetaData "CoursesTopicsCreate" "Network.Google.Resource.Classroom.Courses.Topics.Create" "gogol-classroom-0.5.0-Dil3ZfW4IuD9vJQ6Q2970g" False) (C1 (MetaCons "CoursesTopicsCreate'" PrefixI True) ((S1 (MetaSel (Just "_ctctXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_ctctUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctctCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_ctctAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctctUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ctctPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Topic) :*: S1 (MetaSel (Just "_ctctCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesTopicsCreate Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Topics.Create

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

Defined in Network.Google.Resource.Classroom.Courses.Topics.Create

Request Lenses

ctctUploadProtocol :: Lens' CoursesTopicsCreate (Maybe Text) Source #

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

ctctCourseId :: Lens' CoursesTopicsCreate Text Source #

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

ctctUploadType :: Lens' CoursesTopicsCreate (Maybe Text) Source #

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

ctctPayload :: Lens' CoursesTopicsCreate Topic Source #

Multipart request metadata.