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.Announcements.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. 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.announcements.list.

Synopsis

type CoursesAnnouncementsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("announcements" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParams "announcementStates" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListAnnouncementsResponse)))))))))))))
coursesAnnouncementsList :: Text -> CoursesAnnouncementsList
data CoursesAnnouncementsList
calXgafv :: Lens' CoursesAnnouncementsList (Maybe Xgafv)
calUploadProtocol :: Lens' CoursesAnnouncementsList (Maybe Text)
calOrderBy :: Lens' CoursesAnnouncementsList (Maybe Text)
calAnnouncementStates :: Lens' CoursesAnnouncementsList [Text]
calCourseId :: Lens' CoursesAnnouncementsList Text
calAccessToken :: Lens' CoursesAnnouncementsList (Maybe Text)
calUploadType :: Lens' CoursesAnnouncementsList (Maybe Text)
calPageToken :: Lens' CoursesAnnouncementsList (Maybe Text)
calPageSize :: Lens' CoursesAnnouncementsList (Maybe Int32)
calCallback :: Lens' CoursesAnnouncementsList (Maybe Text)

REST Resource

type CoursesAnnouncementsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("announcements" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParams "announcementStates" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListAnnouncementsResponse))))))))))))) Source #

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

Creating a Request

coursesAnnouncementsList Source #

Arguments

:: Text	`calCourseId`
-> CoursesAnnouncementsList

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

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

data CoursesAnnouncementsList Source #

Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. 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: coursesAnnouncementsList smart constructor.

Instances

Eq CoursesAnnouncementsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Announcements.List Methods (==) :: CoursesAnnouncementsList -> CoursesAnnouncementsList -> Bool # (/=) :: CoursesAnnouncementsList -> CoursesAnnouncementsList -> Bool #
Data CoursesAnnouncementsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Announcements.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesAnnouncementsList -> c CoursesAnnouncementsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesAnnouncementsList # toConstr :: CoursesAnnouncementsList -> Constr # dataTypeOf :: CoursesAnnouncementsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesAnnouncementsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesAnnouncementsList) # gmapT :: (forall b. Data b => b -> b) -> CoursesAnnouncementsList -> CoursesAnnouncementsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesAnnouncementsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesAnnouncementsList -> r # gmapQ :: (forall d. Data d => d -> u) -> CoursesAnnouncementsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesAnnouncementsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesAnnouncementsList -> m CoursesAnnouncementsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesAnnouncementsList -> m CoursesAnnouncementsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesAnnouncementsList -> m CoursesAnnouncementsList #
Show CoursesAnnouncementsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Announcements.List Methods showsPrec :: Int -> CoursesAnnouncementsList -> ShowS # show :: CoursesAnnouncementsList -> String # showList :: [CoursesAnnouncementsList] -> ShowS #
Generic CoursesAnnouncementsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Announcements.List Associated Types type Rep CoursesAnnouncementsList :: Type -> Type # Methods from :: CoursesAnnouncementsList -> Rep CoursesAnnouncementsList x # to :: Rep CoursesAnnouncementsList x -> CoursesAnnouncementsList #
GoogleRequest CoursesAnnouncementsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Announcements.List Associated Types type Rs CoursesAnnouncementsList :: Type # type Scopes CoursesAnnouncementsList :: [Symbol] # Methods requestClient :: CoursesAnnouncementsList -> GClient (Rs CoursesAnnouncementsList) #
type Rep CoursesAnnouncementsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Announcements.List type Rep CoursesAnnouncementsList = D1 (MetaData "CoursesAnnouncementsList" "Network.Google.Resource.Classroom.Courses.Announcements.List" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesAnnouncementsList'" PrefixI True) (((S1 (MetaSel (Just "_calXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_calUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_calOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_calAnnouncementStates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_calCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :: ((S1 (MetaSel (Just "_calAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_calUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_calPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_calPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_calCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes CoursesAnnouncementsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Announcements.List type Scopes CoursesAnnouncementsList = "https://www.googleapis.com/auth/classroom.announcements" ': ("https://www.googleapis.com/auth/classroom.announcements.readonly" ': ([] :: [Symbol]))
type Rs CoursesAnnouncementsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Announcements.List type Rs CoursesAnnouncementsList = ListAnnouncementsResponse

Request Lenses

calXgafv :: Lens' CoursesAnnouncementsList (Maybe Xgafv) Source #

V1 error format.

calUploadProtocol :: Lens' CoursesAnnouncementsList (Maybe Text) Source #

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

calOrderBy :: Lens' CoursesAnnouncementsList (Maybe Text) Source #

Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`

calAnnouncementStates :: Lens' CoursesAnnouncementsList [Text] Source #

Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.

calCourseId :: Lens' CoursesAnnouncementsList Text Source #

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

calAccessToken :: Lens' CoursesAnnouncementsList (Maybe Text) Source #

OAuth access token.

calUploadType :: Lens' CoursesAnnouncementsList (Maybe Text) Source #

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

calPageToken :: Lens' CoursesAnnouncementsList (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.

calPageSize :: Lens' CoursesAnnouncementsList (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.

calCallback :: Lens' CoursesAnnouncementsList (Maybe Text) Source #

JSONP