Struct google_classroom1::UserProfileGuardianInvitationCreateCall

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

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.

Once the guardian accepts the invitation, their state will change to COMPLETED and they will start receiving guardian notifications. A Guardian resource will also be created to represent the active guardian.

The request object must have the student_id and invited_email_address fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.

This method returns the following error codes:

• PERMISSION_DENIED if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors.
• RESOURCE_EXHAUSTED if the student or guardian has exceeded the guardian link limit.
• INVALID_ARGUMENT if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API). This error will also be returned if read-only fields are set, or if the state field is set to to a value other than PENDING.
• NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student.
• ALREADY_EXISTS if there is already a pending guardian invitation for the student and invited_email_address provided, or if the provided invited_email_address matches the Google account of an existing Guardian for this user.

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

Example

Instantiate a resource method builder

use classroom1::GuardianInvitation;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = GuardianInvitation::default();
 
// 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_create(req, "studentId")
             .doit();

Methods

impl<'a, C, A> UserProfileGuardianInvitationCreateCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

fn doit(self) -> Result<(Response, GuardianInvitation)>

Perform the operation you have build so far.

fn request(
    self,
    new_value: GuardianInvitation
) -> UserProfileGuardianInvitationCreateCall<'a, C, A>

Sets the request property to the given value.

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

fn student_id(
    self,
    new_value: &str
) -> UserProfileGuardianInvitationCreateCall<'a, C, A>

ID of the student (in standard format)

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.

fn delegate(
    self,
    new_value: &'a mut Delegate
) -> UserProfileGuardianInvitationCreateCall<'a, C, A>

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.

fn param<T>(
    self,
    name: T,
    value: T
) -> UserProfileGuardianInvitationCreateCall<'a, C, A> where
    T: AsRef<str>, 

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 UserProfileGuardianInvitationCreateCall<'a, C, A>