gogol-classroom-0.1.1: Google Classroom SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Classroom.Invitations.Accept

Contents

Description

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.

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

Synopsis

REST Resource

type InvitationsAcceptResource = "v1" :> ("invitations" :> (CaptureMode "id" "accept" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Empty)))))))))) Source #

A resource alias for classroom.invitations.accept method which the InvitationsAccept request conforms to.

Creating a Request

invitationsAccept Source #

Arguments

:: Text

iaId

-> InvitationsAccept 

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

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

data InvitationsAccept Source #

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.

See: invitationsAccept smart constructor.

Instances

Eq InvitationsAccept Source # 
Data InvitationsAccept Source # 

Methods

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

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

toConstr :: InvitationsAccept -> Constr #

dataTypeOf :: InvitationsAccept -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c InvitationsAccept) #

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

gmapT :: (forall b. Data b => b -> b) -> InvitationsAccept -> InvitationsAccept #

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

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

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

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

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

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

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

Show InvitationsAccept Source # 
Generic InvitationsAccept Source # 
GoogleRequest InvitationsAccept Source # 
type Rep InvitationsAccept Source # 
type Scopes InvitationsAccept Source # 
type Scopes InvitationsAccept = (:) Symbol "https://www.googleapis.com/auth/classroom.rosters" ([] Symbol)
type Rs InvitationsAccept Source # 

Request Lenses

iaUploadProtocol :: Lens' InvitationsAccept (Maybe Text) Source #

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

iaPp :: Lens' InvitationsAccept Bool Source #

Pretty-print response.

iaUploadType :: Lens' InvitationsAccept (Maybe Text) Source #

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

iaId :: Lens' InvitationsAccept Text Source #

Identifier of the invitation to accept.