Struct google_youtube3::SponsorListCall

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

Lists sponsors for a channel.

A builder for the list method supported by a sponsor resource. It is not used directly, but through a SponsorMethods instance.

Settable Parts

• id
• snippet

Scopes

You will need authorization for at least one of the following scopes to make a valid call, possibly depending on parts:

• https://www.googleapis.com/auth/youtube
• https://www.googleapis.com/auth/youtube.force-ssl
• https://www.googleapis.com/auth/youtube.readonly

The default scope will be Scope::Readonly.

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.sponsors().list("part")
             .page_token("et")
             .max_results(56)
             .filter("accusam")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet.

Sets the part query property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

Settable Parts

• id
• snippet

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

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

Sets the page token query property to the given value.

fn max_results(self, new_value: u32) -> SponsorListCall<'a, C, A>

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Sets the max results query property to the given value.

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

The filter parameter specifies which channel sponsors to return.

Sets the filter query property to the given value.

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

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