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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.

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

Synopsis

type InvitationsListResource = "v1" :> ("invitations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "courseId" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "userId" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListInvitationsResponse)))))))))))
invitationsList :: InvitationsList
data InvitationsList
ilXgafv :: Lens' InvitationsList (Maybe Xgafv)
ilUploadProtocol :: Lens' InvitationsList (Maybe Text)
ilCourseId :: Lens' InvitationsList (Maybe Text)
ilAccessToken :: Lens' InvitationsList (Maybe Text)
ilUploadType :: Lens' InvitationsList (Maybe Text)
ilUserId :: Lens' InvitationsList (Maybe Text)
ilPageToken :: Lens' InvitationsList (Maybe Text)
ilPageSize :: Lens' InvitationsList (Maybe Int32)
ilCallback :: Lens' InvitationsList (Maybe Text)

REST Resource

type InvitationsListResource = "v1" :> ("invitations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "courseId" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "userId" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListInvitationsResponse))))))))))) Source #

A resource alias for classroom.invitations.list method which the InvitationsList request conforms to.

Creating a Request

invitationsList :: InvitationsList Source #

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

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

data InvitationsList Source #

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.

See: invitationsList smart constructor.

Instances

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

Request Lenses

ilXgafv :: Lens' InvitationsList (Maybe Xgafv) Source #

V1 error format.

ilUploadProtocol :: Lens' InvitationsList (Maybe Text) Source #

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

ilCourseId :: Lens' InvitationsList (Maybe Text) Source #

Restricts returned invitations to those for a course with the specified identifier.

ilAccessToken :: Lens' InvitationsList (Maybe Text) Source #

OAuth access token.

ilUploadType :: Lens' InvitationsList (Maybe Text) Source #

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

ilUserId :: Lens' InvitationsList (Maybe Text) Source #

Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

ilPageToken :: Lens' InvitationsList (Maybe Text) Source #

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

ilPageSize :: Lens' InvitationsList (Maybe Int32) Source #

Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

ilCallback :: Lens' InvitationsList (Maybe Text) Source #

JSONP