Struct google_classroom1::CourseStudentListCall [] [src]

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

Returns a list of students of this course that the requester is permitted to view.

This method returns the following error codes:

  • NOT_FOUND if the course does not exist.
  • PERMISSION_DENIED for access errors.

A builder for the students.list 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_list("courseId")
             .page_token("vero")
             .page_size(-95)
             .doit();

Methods

impl<'a, C, A> CourseStudentListCall<'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.

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned.

The list request must be otherwise identical to the one that resulted in this token.

Sets the page token query property to the given value.

Maximum number of items to return. Zero means no maximum.

The server may return fewer than the specified number of results.

Sets the page size query property to the given value.

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

  • 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.

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

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope.

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