Struct google_classroom1::UserProfileGuardianInvitationListCall

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

Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided.

This method returns the following error codes:

• PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian invitations for that student, if "-" is specified as the student_id and the user is not a domain administrator, 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, nor the literal string me). May also be returned if an invalid page_token or state is provided.
• NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of that student.

A builder for the guardianInvitations.list 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().guardian_invitations_list("studentId")
             .add_states("sed")
             .page_token("ea")
             .page_size(-62)
             .invited_email_address("aliquyam")
             .doit();

Methods

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

fn doit(self) -> Result<(Response, ListGuardianInvitationsResponse)>

Perform the operation you have build so far.

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

The ID of the student whose guardian invitations are to be returned. 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
• the string literal "-", indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.

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.

fn add_states(
    self,
    new_value: &str
) -> UserProfileGuardianInvitationListCall<'a, C, A>

If specified, only results with the specified state values will be returned. Otherwise, results with a state of PENDING will be returned.

Append the given value to the states query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

fn page_token(
    self,
    new_value: &str
) -> UserProfileGuardianInvitationListCall<'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.

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

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum.

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

Sets the page size query property to the given value.

fn invited_email_address(
    self,
    new_value: &str
) -> UserProfileGuardianInvitationListCall<'a, C, A>

If specified, only results with the specified invited_email_address will be returned.

Sets the invited email address query property to the given value.

fn delegate(
    self,
    new_value: &'a mut Delegate
) -> UserProfileGuardianInvitationListCall<'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.

fn param<T>(
    self,
    name: T,
    value: T
) -> UserProfileGuardianInvitationListCall<'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 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.

Trait Implementations

impl<'a, C, A> CallBuilder for UserProfileGuardianInvitationListCall<'a, C, A>