Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

See: Google Classroom API Reference for classroom.userProfiles.guardianInvitations.list.

REST Resource

type UserProFilesGuardianInvitationsListResource = "v1" :> ("userProfiles" :> (Capture "studentId" Text :> ("guardianInvitations" :> (QueryParams "states" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "invitedEmailAddress" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListGuardianInvitationsResponse)))))))))))))

A resource alias for classroom.userProfiles.guardianInvitations.list method which the UserProFilesGuardianInvitationsList request conforms to.

Creating a Request

userProFilesGuardianInvitationsList

Arguments

:: Text

upfgilStudentId

-> UserProFilesGuardianInvitationsList

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

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

• upfgilStudentId
• upfgilStates
• upfgilXgafv
• upfgilUploadProtocol
• upfgilAccessToken
• upfgilUploadType
• upfgilInvitedEmailAddress
• upfgilPageToken
• upfgilPageSize
• upfgilCallback

data UserProFilesGuardianInvitationsList

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.

See: userProFilesGuardianInvitationsList smart constructor.

Instances

Eq UserProFilesGuardianInvitationsList

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

Methods

(==) :: UserProFilesGuardianInvitationsList -> UserProFilesGuardianInvitationsList -> Bool

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

Data UserProFilesGuardianInvitationsList

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

Methods

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

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

toConstr :: UserProFilesGuardianInvitationsList -> Constr

dataTypeOf :: UserProFilesGuardianInvitationsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show UserProFilesGuardianInvitationsList

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

Methods

showsPrec :: Int -> UserProFilesGuardianInvitationsList -> ShowS

show :: UserProFilesGuardianInvitationsList -> String

showList :: [UserProFilesGuardianInvitationsList] -> ShowS

Generic UserProFilesGuardianInvitationsList

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

Associated Types

type Rep UserProFilesGuardianInvitationsList :: Type -> Type

Methods

from :: UserProFilesGuardianInvitationsList -> Rep UserProFilesGuardianInvitationsList x

to :: Rep UserProFilesGuardianInvitationsList x -> UserProFilesGuardianInvitationsList

GoogleRequest UserProFilesGuardianInvitationsList

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

Associated Types

type Rs UserProFilesGuardianInvitationsList :: Type

type Scopes UserProFilesGuardianInvitationsList :: [Symbol]

Methods

requestClient :: UserProFilesGuardianInvitationsList -> GClient (Rs UserProFilesGuardianInvitationsList)

type Rep UserProFilesGuardianInvitationsList

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

type Rep UserProFilesGuardianInvitationsList = D1 (MetaData "UserProFilesGuardianInvitationsList" "Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "UserProFilesGuardianInvitationsList'" PrefixI True) (((S1 (MetaSel (Just "_upfgilStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_upfgilStates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_upfgilXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_upfgilUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_upfgilAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_upfgilUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_upfgilInvitedEmailAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_upfgilPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_upfgilPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_upfgilCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes UserProFilesGuardianInvitationsList

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

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

type Rs UserProFilesGuardianInvitationsList

Defined in Network.Google.Resource.Classroom.UserProFiles.GuardianInvitations.List

type Rs UserProFilesGuardianInvitationsList = ListGuardianInvitationsResponse

Request Lenses

upfgilStudentId :: Lens' UserProFilesGuardianInvitationsList Text

The ID of the student whose guardian invitations are to be returned. 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 * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.

upfgilStates :: Lens' UserProFilesGuardianInvitationsList [Text]

If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.

upfgilXgafv :: Lens' UserProFilesGuardianInvitationsList (Maybe Xgafv)

V1 error format.

upfgilUploadProtocol :: Lens' UserProFilesGuardianInvitationsList (Maybe Text)

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

upfgilAccessToken :: Lens' UserProFilesGuardianInvitationsList (Maybe Text)

OAuth access token.

upfgilUploadType :: Lens' UserProFilesGuardianInvitationsList (Maybe Text)

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

upfgilInvitedEmailAddress :: Lens' UserProFilesGuardianInvitationsList (Maybe Text)

If specified, only results with the specified `invited_email_address` will be returned.

upfgilPageToken :: Lens' UserProFilesGuardianInvitationsList (Maybe Text)

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.

upfgilPageSize :: Lens' UserProFilesGuardianInvitationsList (Maybe Int32)

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

upfgilCallback :: Lens' UserProFilesGuardianInvitationsList (Maybe Text)

JSONP