Struct google_classroom1::InvitationListCall

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

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request.

Note: At least one of user_id or course_id must be supplied. Both fields can be supplied.

This method returns the following error codes:

• PERMISSION_DENIED for access errors.

A builder for the list method supported by a invitation resource. It is not used directly, but through a InvitationMethods 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.invitations().list()
             .user_id("kasd")
             .page_token("invidunt")
             .page_size(-15)
             .course_id("Lorem")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

Restricts returned invitations to those for a specific user. 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 query property to the given value.

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

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.

pub fn page_size(self, new_value: i32) -> InvitationListCall<'a, C, A>

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.

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

Restricts returned invitations to those for a course with the specified identifier.

Sets the course id query property to the given value.

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