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.Create

Contents

REST Resource
Creating a Request
Request Lenses

Description

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

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

Synopsis

type CoursesAnnouncementsCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("announcements" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Announcement :> Post '[JSON] Announcement))))))))))
coursesAnnouncementsCreate :: Text -> Announcement -> CoursesAnnouncementsCreate
data CoursesAnnouncementsCreate
couXgafv :: Lens' CoursesAnnouncementsCreate (Maybe Xgafv)
couUploadProtocol :: Lens' CoursesAnnouncementsCreate (Maybe Text)
couCourseId :: Lens' CoursesAnnouncementsCreate Text
couAccessToken :: Lens' CoursesAnnouncementsCreate (Maybe Text)
couUploadType :: Lens' CoursesAnnouncementsCreate (Maybe Text)
couPayload :: Lens' CoursesAnnouncementsCreate Announcement
couCallback :: Lens' CoursesAnnouncementsCreate (Maybe Text)

REST Resource

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

A resource alias for classroom.courses.announcements.create method which the CoursesAnnouncementsCreate request conforms to.

Creating a Request

coursesAnnouncementsCreate Source #

Arguments

:: Text	`couCourseId`
-> Announcement	`couPayload`
-> CoursesAnnouncementsCreate

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

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

data CoursesAnnouncementsCreate Source #

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

See: coursesAnnouncementsCreate smart constructor.

Instances

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

Request Lenses

couXgafv :: Lens' CoursesAnnouncementsCreate (Maybe Xgafv) Source #

V1 error format.

couUploadProtocol :: Lens' CoursesAnnouncementsCreate (Maybe Text) Source #

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

couCourseId :: Lens' CoursesAnnouncementsCreate Text Source #

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

couAccessToken :: Lens' CoursesAnnouncementsCreate (Maybe Text) Source #

OAuth access token.

couUploadType :: Lens' CoursesAnnouncementsCreate (Maybe Text) Source #

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

couPayload :: Lens' CoursesAnnouncementsCreate Announcement Source #

Multipart request metadata.

couCallback :: Lens' CoursesAnnouncementsCreate (Maybe Text) Source #

JSONP