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.Invitations.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

See: Google Classroom API Reference for classroom.invitations.get.

Synopsis

type InvitationsGetResource = "v1" :> ("invitations" :> (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] Invitation))))))))
invitationsGet :: Text -> InvitationsGet
data InvitationsGet
igXgafv :: Lens' InvitationsGet (Maybe Xgafv)
igUploadProtocol :: Lens' InvitationsGet (Maybe Text)
igAccessToken :: Lens' InvitationsGet (Maybe Text)
igUploadType :: Lens' InvitationsGet (Maybe Text)
igId :: Lens' InvitationsGet Text
igCallback :: Lens' InvitationsGet (Maybe Text)

REST Resource

type InvitationsGetResource = "v1" :> ("invitations" :> (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] Invitation)))))))) Source #

A resource alias for classroom.invitations.get method which the InvitationsGet request conforms to.

Creating a Request

invitationsGet Source #

Arguments

:: Text	`igId`
-> InvitationsGet

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

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

data InvitationsGet Source #

Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

See: invitationsGet smart constructor.

Instances

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

Request Lenses

igXgafv :: Lens' InvitationsGet (Maybe Xgafv) Source #

V1 error format.

igUploadProtocol :: Lens' InvitationsGet (Maybe Text) Source #

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

igAccessToken :: Lens' InvitationsGet (Maybe Text) Source #

OAuth access token.

igUploadType :: Lens' InvitationsGet (Maybe Text) Source #

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

igId :: Lens' InvitationsGet Text Source #

Identifier of the invitation to return.

igCallback :: Lens' InvitationsGet (Maybe Text) Source #

JSONP