Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Classroom.Courses.Topics.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access 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.list.

Synopsis

type CoursesTopicsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("topics" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTopicResponse)))))))))))
coursesTopicsList :: Text -> CoursesTopicsList
data CoursesTopicsList
ctlXgafv :: Lens' CoursesTopicsList (Maybe Xgafv)
ctlUploadProtocol :: Lens' CoursesTopicsList (Maybe Text)
ctlCourseId :: Lens' CoursesTopicsList Text
ctlAccessToken :: Lens' CoursesTopicsList (Maybe Text)
ctlUploadType :: Lens' CoursesTopicsList (Maybe Text)
ctlPageToken :: Lens' CoursesTopicsList (Maybe Text)
ctlPageSize :: Lens' CoursesTopicsList (Maybe Int32)
ctlCallback :: Lens' CoursesTopicsList (Maybe Text)

REST Resource

type CoursesTopicsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("topics" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTopicResponse))))))))))) Source #

A resource alias for classroom.courses.topics.list method which the CoursesTopicsList request conforms to.

Creating a Request

coursesTopicsList Source #

Arguments

:: Text	`ctlCourseId`
-> CoursesTopicsList

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

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

data CoursesTopicsList Source #

Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

See: coursesTopicsList smart constructor.

Instances

Eq CoursesTopicsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Topics.List Methods (==) :: CoursesTopicsList -> CoursesTopicsList -> Bool # (/=) :: CoursesTopicsList -> CoursesTopicsList -> Bool #
Data CoursesTopicsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Topics.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesTopicsList -> c CoursesTopicsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesTopicsList # toConstr :: CoursesTopicsList -> Constr # dataTypeOf :: CoursesTopicsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesTopicsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesTopicsList) # gmapT :: (forall b. Data b => b -> b) -> CoursesTopicsList -> CoursesTopicsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesTopicsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesTopicsList -> r # gmapQ :: (forall d. Data d => d -> u) -> CoursesTopicsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesTopicsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesTopicsList -> m CoursesTopicsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesTopicsList -> m CoursesTopicsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesTopicsList -> m CoursesTopicsList #
Show CoursesTopicsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Topics.List Methods showsPrec :: Int -> CoursesTopicsList -> ShowS # show :: CoursesTopicsList -> String # showList :: [CoursesTopicsList] -> ShowS #
Generic CoursesTopicsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Topics.List Associated Types type Rep CoursesTopicsList :: Type -> Type # Methods from :: CoursesTopicsList -> Rep CoursesTopicsList x # to :: Rep CoursesTopicsList x -> CoursesTopicsList #
GoogleRequest CoursesTopicsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Topics.List Associated Types type Rs CoursesTopicsList :: Type # type Scopes CoursesTopicsList :: [Symbol] # Methods requestClient :: CoursesTopicsList -> GClient (Rs CoursesTopicsList) #
type Rep CoursesTopicsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Topics.List type Rep CoursesTopicsList = D1 (MetaData "CoursesTopicsList" "Network.Google.Resource.Classroom.Courses.Topics.List" "gogol-classroom-0.5.0-Dil3ZfW4IuD9vJQ6Q2970g" False) (C1 (MetaCons "CoursesTopicsList'" PrefixI True) (((S1 (MetaSel (Just "_ctlXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_ctlUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ctlCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_ctlAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_ctlUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ctlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ctlPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_ctlCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesTopicsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Topics.List type Scopes CoursesTopicsList = "https://www.googleapis.com/auth/classroom.topics" ': ("https://www.googleapis.com/auth/classroom.topics.readonly" ': ([] :: [Symbol]))
type Rs CoursesTopicsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Topics.List type Rs CoursesTopicsList = ListTopicResponse

Request Lenses

ctlXgafv :: Lens' CoursesTopicsList (Maybe Xgafv) Source #

V1 error format.

ctlUploadProtocol :: Lens' CoursesTopicsList (Maybe Text) Source #

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

ctlCourseId :: Lens' CoursesTopicsList Text Source #

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

ctlAccessToken :: Lens' CoursesTopicsList (Maybe Text) Source #

OAuth access token.

ctlUploadType :: Lens' CoursesTopicsList (Maybe Text) Source #

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

ctlPageToken :: Lens' CoursesTopicsList (Maybe Text) Source #

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

ctlPageSize :: Lens' CoursesTopicsList (Maybe Int32) Source #

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

ctlCallback :: Lens' CoursesTopicsList (Maybe Text) Source #

JSONP