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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist

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

Synopsis

type CoursesAnnouncementsPatchResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("announcements" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Announcement :> Patch '[JSON] Announcement))))))))))))
coursesAnnouncementsPatch :: Text -> Announcement -> Text -> CoursesAnnouncementsPatch
data CoursesAnnouncementsPatch
capXgafv :: Lens' CoursesAnnouncementsPatch (Maybe Xgafv)
capUploadProtocol :: Lens' CoursesAnnouncementsPatch (Maybe Text)
capUpdateMask :: Lens' CoursesAnnouncementsPatch (Maybe GFieldMask)
capCourseId :: Lens' CoursesAnnouncementsPatch Text
capAccessToken :: Lens' CoursesAnnouncementsPatch (Maybe Text)
capUploadType :: Lens' CoursesAnnouncementsPatch (Maybe Text)
capPayload :: Lens' CoursesAnnouncementsPatch Announcement
capId :: Lens' CoursesAnnouncementsPatch Text
capCallback :: Lens' CoursesAnnouncementsPatch (Maybe Text)

REST Resource

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

A resource alias for classroom.courses.announcements.patch method which the CoursesAnnouncementsPatch request conforms to.

Creating a Request

coursesAnnouncementsPatch Source #

Arguments

:: Text	`capCourseId`
-> Announcement	`capPayload`
-> Text	`capId`
-> CoursesAnnouncementsPatch

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

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

data CoursesAnnouncementsPatch Source #

Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist

See: coursesAnnouncementsPatch smart constructor.

Instances

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

Request Lenses

capXgafv :: Lens' CoursesAnnouncementsPatch (Maybe Xgafv) Source #

V1 error format.

capUploadProtocol :: Lens' CoursesAnnouncementsPatch (Maybe Text) Source #

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

capUpdateMask :: Lens' CoursesAnnouncementsPatch (Maybe GFieldMask) Source #

Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`

capCourseId :: Lens' CoursesAnnouncementsPatch Text Source #

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

capAccessToken :: Lens' CoursesAnnouncementsPatch (Maybe Text) Source #

OAuth access token.

capUploadType :: Lens' CoursesAnnouncementsPatch (Maybe Text) Source #

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

capPayload :: Lens' CoursesAnnouncementsPatch Announcement Source #

Multipart request metadata.

capId :: Lens' CoursesAnnouncementsPatch Text Source #

Identifier of the announcement.

capCallback :: Lens' CoursesAnnouncementsPatch (Maybe Text) Source #

JSONP