Struct google_classroom1::UserProfileGuardianDeleteCall [] [src]

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 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 Classroom cannot find any record of the given student_id or guardian_id, or if the guardian has already been disabled.

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
[src]

Perform the operation you have build so far.

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.

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.

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.

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

  • bearer_token (query-string) - OAuth bearer token.
  • pp (query-boolean) - Pretty-print response.
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
  • 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.

Trait Implementations

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