Struct google_youtube3::CaptionListCall

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

Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.

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("part", "videoId")
             .on_behalf_of_content_owner("clita")
             .on_behalf_of("diam")
             .id("justo")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

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.

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 video_id(self, new_value: &str) -> CaptionListCall<'a, C, A>

The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks.

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.

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

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.

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

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.

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

The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved. Each ID must identify a caption track associated with the specified video.

Sets the id query property to the given value.

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

Trait Implementations

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