[][src]Struct google_youtube3::CaptionUpdateCall

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

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

A builder for the update method supported by a caption resource. It is not used directly, but through a CaptionMethods instance.

Example

Instantiate a resource method builder

use youtube3::Caption;
use std::fs;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Caption::default();
 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload_resumable(...)`.
// Values shown here are possibly random and not representative !
let result = hub.captions().update(req)
             .sync(true)
             .on_behalf_of_content_owner("sed")
             .on_behalf_of("sit")
             .upload_resumable(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap());

Methods

impl<'a, C, A> CaptionUpdateCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken
[src]

pub fn upload<RS>(
    self,
    stream: RS,
    mime_type: Mime
) -> Result<(Response, Caption)> where
    RS: ReadSeek
[src]

Upload media all at once. If the upload fails for whichever reason, all progress is lost.

  • max size: 100MB
  • multipart: yes
  • valid mime types: '/', 'application/octet-stream' and 'text/xml'

pub fn upload_resumable<RS>(
    self,
    resumeable_stream: RS,
    mime_type: Mime
) -> Result<(Response, Caption)> where
    RS: ReadSeek
[src]

Upload media in a resumable fashion. Even if the upload fails or is interrupted, it can be resumed for a certain amount of time as the server maintains state temporarily.

The delegate will be asked for an upload_url(), and if not provided, will be asked to store an upload URL that was provided by the server, using store_upload_url(...). The upload will be done in chunks, the delegate may specify the chunk_size() and may cancel the operation before each chunk is uploaded, using cancel_chunk_upload(...).

  • max size: 100MB
  • multipart: yes
  • valid mime types: '/', 'application/octet-stream' and 'text/xml'

pub fn request(self, new_value: Caption) -> CaptionUpdateCall<'a, C, A>[src]

Sets the request property to the given value.

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

pub fn part(self, new_value: &str) -> CaptionUpdateCall<'a, C, A>[src]

The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.

Sets the part query property to the given value.

Even though the parts list is automatically derived from Resource passed in during instantiation and indicates which values you are passing, the response would contain the very same parts. This may not always be desirable, as you can obtain (newly generated) parts you cannot pass in, like statistics that are generated server side. Therefore you should use this method to specify the parts you provide in addition to the ones you want in the response.

pub fn sync(self, new_value: bool) -> CaptionUpdateCall<'a, C, A>[src]

Note: The API server only processes the parameter value if the request contains an updated caption file.

The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.

Sets the sync query property to the given value.

pub fn on_behalf_of_content_owner(
    self,
    new_value: &str
) -> CaptionUpdateCall<'a, C, A>
[src]

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.

pub fn on_behalf_of(self, new_value: &str) -> CaptionUpdateCall<'a, C, A>[src]

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

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

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> CaptionUpdateCall<'a, C, A>
[src]

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.

pub fn param<T>(self, name: T, value: T) -> CaptionUpdateCall<'a, C, A> where
    T: AsRef<str>, 
[src]

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

  • quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
  • 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) - Deprecated. Please use quotaUser instead.
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> CaptionUpdateCall<'a, C, A> where
    T: Into<Option<S>>,
    S: AsRef<str>, 
[src]

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. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

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 CaptionUpdateCall<'a, C, A>[src]

Auto Trait Implementations

impl<'a, C, A> !Send for CaptionUpdateCall<'a, C, A>

impl<'a, C, A> !Sync for CaptionUpdateCall<'a, C, A>

impl<'a, C, A> Unpin for CaptionUpdateCall<'a, C, A>

impl<'a, C, A> !UnwindSafe for CaptionUpdateCall<'a, C, A>

impl<'a, C, A> !RefUnwindSafe for CaptionUpdateCall<'a, C, A>

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = !

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Typeable for T where
    T: Any