Struct google_classroom1::CourseStudentDeleteCall[][src]

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

Deletes a student of a course.

This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to delete students of this course or for access errors.
  • NOT_FOUND if no student of this course has the requested ID or if the course does not exist.

A builder for the students.delete method supported by a course resource. It is not used directly, but through a CourseMethods 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.courses().students_delete("courseId", "userId")
             .doit();

Methods

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

Perform the operation you have build so far.

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Sets the course 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.

Identifier of the student to delete. The identifier can be 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 user 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.
  • 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.

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::Roster.

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 CourseStudentDeleteCall<'a, C, A>
[src]

Auto Trait Implementations

impl<'a, C, A> !Send for CourseStudentDeleteCall<'a, C, A>

impl<'a, C, A> !Sync for CourseStudentDeleteCall<'a, C, A>