gogol-classroom-0.1.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.List

Contents

Description

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

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

Synopsis

REST Resource

type CoursesListResource = "v1" :> ("courses" :> (QueryParam "studentId" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "teacherId" Text :> (QueryParam "bearer_token" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCoursesResponse))))))))))))) Source #

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

Creating a Request

coursesList :: CoursesList Source #

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

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

data CoursesList Source #

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

See: coursesList smart constructor.

Instances

Eq CoursesList Source # 
Data CoursesList Source # 

Methods

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

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

toConstr :: CoursesList -> Constr #

dataTypeOf :: CoursesList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show CoursesList Source # 
Generic CoursesList Source # 

Associated Types

type Rep CoursesList :: * -> * #

GoogleRequest CoursesList Source # 

Associated Types

type Rs CoursesList :: * #

type Scopes CoursesList :: [Symbol] #

type Rep CoursesList Source # 
type Rep CoursesList = D1 (MetaData "CoursesList" "Network.Google.Resource.Classroom.Courses.List" "gogol-classroom-0.1.0-21rh7SRXdL3B6ZyyiLDhlq" False) (C1 (MetaCons "CoursesList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_clStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_clXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_clUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_clPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_clAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_clUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_clTeacherId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_clBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_clPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_clPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) (S1 (MetaSel (Just Symbol "_clCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))
type Scopes CoursesList Source # 
type Scopes CoursesList = (:) Symbol "https://www.googleapis.com/auth/classroom.courses" ((:) Symbol "https://www.googleapis.com/auth/classroom.courses.readonly" ([] Symbol))
type Rs CoursesList Source # 

Request Lenses

clStudentId :: Lens' CoursesList (Maybe Text) Source #

Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

clXgafv :: Lens' CoursesList (Maybe Text) Source #

V1 error format.

clUploadProtocol :: Lens' CoursesList (Maybe Text) Source #

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

clPp :: Lens' CoursesList Bool Source #

Pretty-print response.

clAccessToken :: Lens' CoursesList (Maybe Text) Source #

OAuth access token.

clUploadType :: Lens' CoursesList (Maybe Text) Source #

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

clTeacherId :: Lens' CoursesList (Maybe Text) Source #

Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

clBearerToken :: Lens' CoursesList (Maybe Text) Source #

OAuth bearer token.

clPageToken :: Lens' CoursesList (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.

clPageSize :: Lens' CoursesList (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.