Struct google_classroom1::UserProfileGuardianInvitationPatchCall

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

Modifies a guardian invitation.

Currently, the only valid modification is to change the state from PENDING to COMPLETE. This has the effect of withdrawing the invitation.

This method returns the following error codes:

• PERMISSION_DENIED if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors.
• FAILED_PRECONDITION if the guardian link is not in the PENDING state.
• INVALID_ARGUMENT if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API), or if the passed GuardianInvitation has a state other than COMPLETE, or if it modifies fields other than state.
• NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the id field does not refer to a guardian invitation known to Classroom.

A builder for the guardianInvitations.patch 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_patch(req, "studentId", "invitationId")
             .update_mask("diam")
             .doit();

Implementations

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

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

Perform the operation you have build so far.

pub fn request(
    self,
    new_value: GuardianInvitation
) -> UserProfileGuardianInvitationPatchCall<'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.

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

The ID of the student whose guardian invitation is to be modified.

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.

pub fn invitation_id(
    self,
    new_value: &str
) -> UserProfileGuardianInvitationPatchCall<'a, C, A>

The id field of the GuardianInvitation to be modified.

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.

pub fn update_mask(
    self,
    new_value: &str
) -> UserProfileGuardianInvitationPatchCall<'a, C, A>

Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid:

• state

When set in a query parameter, this field should be specified as

updateMask=<field1>,<field2>,...

Sets the update mask query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> UserProfileGuardianInvitationPatchCall<'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.

pub fn param<T>(
    self,
    name: T,
    value: T
) -> UserProfileGuardianInvitationPatchCall<'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 parameters 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").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• 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.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(
    self,
    scope: T
) -> UserProfileGuardianInvitationPatchCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::GuardianlinkStudent.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

impl<'a, C, A> CallBuilder for UserProfileGuardianInvitationPatchCall<'a, C, A>