Struct google_youtube3::api::CaptionListCall

source ·

pub struct CaptionListCall<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

Retrieves a list of resources, possibly filtered.

A builder for the list method supported by a caption resource. It is not used directly, but through a CaptionMethods 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.force-ssl
https://www.googleapis.com/auth/youtubepartner

The default scope will be Scope::ForceSsl.

§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.captions().list(&vec!["et".into()], "videoId")
             .on_behalf_of_content_owner("Stet")
             .on_behalf_of("dolor")
             .add_id("duo")
             .doit().await;

Implementations§

source §

impl<'a, S> CaptionListCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

pub async fn doit(self) -> Result<(Response<Body>, CaptionListResponse)>

Perform the operation you have build so far.

source

pub fn add_part(self, new_value: &str) -> CaptionListCall<'a, S>

The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.

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

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

Settable Parts

id
snippet

source

pub fn video_id(self, new_value: &str) -> CaptionListCall<'a, S>

Returns the captions for the specified video.

Sets the video id 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.

source

pub fn on_behalf_of_content_owner( self, new_value: &str ) -> CaptionListCall<'a, S>

Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request’s authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

Sets the on behalf of content owner query property to the given value.

source

pub fn on_behalf_of(self, new_value: &str) -> CaptionListCall<'a, S>

ID of the Google+ Page for the channel that the request is on behalf of.

Sets the on behalf of query property to the given value.

source

pub fn add_id(self, new_value: &str) -> CaptionListCall<'a, S>

Returns the captions with the given IDs for Stubby or Apiary.

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

source

pub fn delegate(self, new_value: &'a mut dyn Delegate) -> CaptionListCall<'a, S>

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.

source

pub fn param<T>(self, name: T, value: T) -> CaptionListCall<'a, S>
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

$.xgafv (query-string) - V1 error format.
access_token (query-string) - OAuth access token.
alt (query-string) - Data format for response.
callback (query-string) - JSONP
fields (query-string) - Selector specifying which fields to include in a partial response.
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.
oauth_token (query-string) - OAuth 2.0 token for the current user.
prettyPrint (query-boolean) - Returns response with indentations and line breaks.
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.
uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

source

pub fn add_scope<St>(self, scope: St) -> CaptionListCall<'a, S>
where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of the default Scope variant Scope::ForceSsl.

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.

source

pub fn add_scopes<I, St>(self, scopes: I) -> CaptionListCall<'a, S>
where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

source

pub fn clear_scopes(self) -> CaptionListCall<'a, S>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).