Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]> Toni Cebrián <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Classroom.Invitations.Accept

Contents

Resource
- Constructing a Request

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

type ClassroomInvitationsAcceptResource = "v1" :> ("invitations" :> (CaptureMode "id" "accept" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Empty))))))))
data ClassroomInvitationsAccept = ClassroomInvitationsAccept {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- id :: Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newClassroomInvitationsAccept :: Text -> ClassroomInvitationsAccept

Resource

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

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

Constructing a Request

data ClassroomInvitationsAccept 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: newClassroomInvitationsAccept smart constructor.

Constructors

ClassroomInvitationsAccept
Fields xgafv :: Maybe Xgafv V1 error format. accessToken :: Maybe Text OAuth access token. callback :: Maybe Text JSONP id :: Text Identifier of the invitation to accept. uploadType :: Maybe Text Legacy upload protocol for media (e.g. "media", "multipart"). uploadProtocol :: Maybe Text Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic ClassroomInvitationsAccept Source #

Instance details

Defined in Gogol.Classroom.Invitations.Accept

Associated Types

type Rep ClassroomInvitationsAccept

Instance details

Defined in Gogol.Classroom.Invitations.Accept

type Rep ClassroomInvitationsAccept = D1 ('MetaData "ClassroomInvitationsAccept" "Gogol.Classroom.Invitations.Accept" "gogol-classroom-1.0.0-E0l1a33tlucKcuM1xSJBzt" 'False) (C1 ('MetaCons "ClassroomInvitationsAccept" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: ClassroomInvitationsAccept -> Rep ClassroomInvitationsAccept x #

to :: Rep ClassroomInvitationsAccept x -> ClassroomInvitationsAccept #

Show ClassroomInvitationsAccept Source #

Instance details

Defined in Gogol.Classroom.Invitations.Accept

Methods

showsPrec :: Int -> ClassroomInvitationsAccept -> ShowS #

show :: ClassroomInvitationsAccept -> String #

showList :: [ClassroomInvitationsAccept] -> ShowS #

Eq ClassroomInvitationsAccept Source #

Instance details

Defined in Gogol.Classroom.Invitations.Accept

Methods

(==) :: ClassroomInvitationsAccept -> ClassroomInvitationsAccept -> Bool #

(/=) :: ClassroomInvitationsAccept -> ClassroomInvitationsAccept -> Bool #

GoogleRequest ClassroomInvitationsAccept Source #

Instance details

Defined in Gogol.Classroom.Invitations.Accept

Associated Types

type Rs ClassroomInvitationsAccept
Instance details Defined in Gogol.Classroom.Invitations.Accept type Rs ClassroomInvitationsAccept = Empty
type Scopes ClassroomInvitationsAccept
Instance details Defined in Gogol.Classroom.Invitations.Accept type Scopes ClassroomInvitationsAccept = '[Classroom'Rosters]