Struct google_games1::TurnBasedMatcheListCall

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

Returns turn-based matches the player is or was involved in.

A builder for the list method supported by a turnBasedMatche resource. It is not used directly, but through a TurnBasedMatcheMethods 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.turn_based_matches().list()
             .page_token("dolore")
             .max_results(-41)
             .max_completed_matches(-29)
             .language("aliquyam")
             .include_match_data(false)
             .consistency_token("eirmod")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The token returned by the previous request.

Sets the page token query property to the given value.

fn max_results(self, new_value: i32) -> TurnBasedMatcheListCall<'a, C, A>

The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.

Sets the max results query property to the given value.

fn max_completed_matches(self,
                         new_value: i32)
                         -> TurnBasedMatcheListCall<'a, C, A>

The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.

Sets the max completed matches query property to the given value.

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

The preferred language to use for strings returned by this method.

Sets the language query property to the given value.

fn include_match_data(self,
                      new_value: bool)
                      -> TurnBasedMatcheListCall<'a, C, A>

True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.

Sets the include match data query property to the given value.

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

The last-seen mutation timestamp.

Sets the consistency token query property to the given value.

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

• 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. Overrides userIp if both are provided.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

fn add_scope<T>(self, scope: T) -> TurnBasedMatcheListCall<'a, C, A> where T: 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::Full.

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 TurnBasedMatcheListCall<'a, C, A>