Struct google_classroom1::UserProfileGuardianDeleteCall

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

Deletes a guardian.

The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API.

This method returns the following error codes:

• PERMISSION_DENIED if no user that matches the provided student_id is visible to the requesting user, if the requesting user is not permitted to manage guardians 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).
• NOT_FOUND if the requesting user is permitted to modify guardians for the requested student_id, but no Guardian record exists for that student with the provided guardian_id.

A builder for the guardians.delete 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().guardians_delete("studentId", "guardianId")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The student whose guardian is to be deleted. One of the following:

• the numeric identifier for the user
• the email address of the user
• the string literal "me", indicating the requesting user

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 guardian_id(
    self,
    new_value: &str
) -> UserProfileGuardianDeleteCall<'a, C, A>

The id field from a Guardian.

Sets the guardian 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 delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> UserProfileGuardianDeleteCall<'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
) -> UserProfileGuardianDeleteCall<'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
) -> UserProfileGuardianDeleteCall<'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 UserProfileGuardianDeleteCall<'a, C, A>