Network.Google.Resource.Classroom.Courses.Announcements.Get

Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.

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

REST Resource

type CoursesAnnouncementsGetResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("announcements" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Announcement))))))))))

A resource alias for classroom.courses.announcements.get method which the CoursesAnnouncementsGet request conforms to.

Creating a Request

coursesAnnouncementsGet

Arguments

:: Text

cagCourseId

-> Text

cagId

-> CoursesAnnouncementsGet

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

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

• cagXgafv
• cagUploadProtocol
• cagCourseId
• cagAccessToken
• cagUploadType
• cagId
• cagCallback

data CoursesAnnouncementsGet

Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.

See: coursesAnnouncementsGet smart constructor.

Instances

Eq CoursesAnnouncementsGet

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Get

Methods

(==) :: CoursesAnnouncementsGet -> CoursesAnnouncementsGet -> Bool

(/=) :: CoursesAnnouncementsGet -> CoursesAnnouncementsGet -> Bool

Data CoursesAnnouncementsGet

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Get

Methods

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

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

toConstr :: CoursesAnnouncementsGet -> Constr

dataTypeOf :: CoursesAnnouncementsGet -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesAnnouncementsGet)

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

gmapT :: (forall b. Data b => b -> b) -> CoursesAnnouncementsGet -> CoursesAnnouncementsGet

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

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

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

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

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

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

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

Show CoursesAnnouncementsGet

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Get

Methods

showsPrec :: Int -> CoursesAnnouncementsGet -> ShowS

show :: CoursesAnnouncementsGet -> String

showList :: [CoursesAnnouncementsGet] -> ShowS

Generic CoursesAnnouncementsGet

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Get

Associated Types

type Rep CoursesAnnouncementsGet :: Type -> Type

Methods

from :: CoursesAnnouncementsGet -> Rep CoursesAnnouncementsGet x

to :: Rep CoursesAnnouncementsGet x -> CoursesAnnouncementsGet

GoogleRequest CoursesAnnouncementsGet

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Get

Associated Types

type Rs CoursesAnnouncementsGet :: Type

type Scopes CoursesAnnouncementsGet :: [Symbol]

Methods

requestClient :: CoursesAnnouncementsGet -> GClient (Rs CoursesAnnouncementsGet)

type Rep CoursesAnnouncementsGet

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Get

type Rep CoursesAnnouncementsGet = D1 (MetaData "CoursesAnnouncementsGet" "Network.Google.Resource.Classroom.Courses.Announcements.Get" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesAnnouncementsGet'" PrefixI True) ((S1 (MetaSel (Just "_cagXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_cagUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cagCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_cagAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cagUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cagId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cagCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes CoursesAnnouncementsGet

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Get

type Scopes CoursesAnnouncementsGet = "https://www.googleapis.com/auth/classroom.announcements" ': ("https://www.googleapis.com/auth/classroom.announcements.readonly" ': ([] :: [Symbol]))

type Rs CoursesAnnouncementsGet

Defined in Network.Google.Resource.Classroom.Courses.Announcements.Get

type Rs CoursesAnnouncementsGet = Announcement

Request Lenses

cagXgafv :: Lens' CoursesAnnouncementsGet (Maybe Xgafv)

V1 error format.

cagUploadProtocol :: Lens' CoursesAnnouncementsGet (Maybe Text)

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

cagCourseId :: Lens' CoursesAnnouncementsGet Text

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

cagAccessToken :: Lens' CoursesAnnouncementsGet (Maybe Text)

OAuth access token.

cagUploadType :: Lens' CoursesAnnouncementsGet (Maybe Text)

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

cagId :: Lens' CoursesAnnouncementsGet Text

Identifier of the announcement.

cagCallback :: Lens' CoursesAnnouncementsGet (Maybe Text)

JSONP