Struct google_classroom1::UserProfileGuardianInvitationGetCall [] [src]

pub struct UserProfileGuardianInvitationGetCall<'a, C, A> where
    C: 'a,
    A: 'a, 
{ /* fields omitted */ }

Returns a specific guardian invitation.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view guardian invitations for the student identified by the student_id, 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).
  • NOT_FOUND if Classroom cannot find any record of the given student or invitation_id. May also be returned if the student exists, but the requesting user does not have access to see that student.

A builder for the guardianInvitations.get method supported by a userProfile resource. It is not used directly, but through a UserProfileMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.user_profiles().guardian_invitations_get("studentId", "invitationId")
             .doit();

Methods

impl<'a, C, A> UserProfileGuardianInvitationGetCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken
[src]

[src]

Perform the operation you have build so far.

[src]

The ID of the student whose guardian invitation is being requested.

Sets the student id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

[src]

The id field of the GuardianInvitation being requested.

Sets the invitation id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

[src]

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

[src]

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

  • upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
  • pp (query-boolean) - Pretty-print response.
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • bearer_token (query-string) - OAuth bearer token.
  • access_token (query-string) - OAuth access token.
  • uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
  • quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • callback (query-string) - JSONP
  • oauth_token (query-string) - OAuth 2.0 token for the current user.
  • key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • alt (query-string) - Data format for response.
  • $.xgafv (query-string) - V1 error format.

Trait Implementations

impl<'a, C, A> CallBuilder for UserProfileGuardianInvitationGetCall<'a, C, A>
[src]