[][src]Struct google_youtube3::ChannelUpdateCall

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

Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties.

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


Instantiate a resource method builder

use youtube3::Channel;
// 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 = Channel::default();
// 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.channels().update(req)


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

pub fn doit(self) -> Result<(Response, Channel)>[src]

Perform the operation you have build so far.

pub fn request(self, new_value: Channel) -> ChannelUpdateCall<'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) -> ChannelUpdateCall<'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.

The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.)

Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.

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 on_behalf_of_content_owner(
    new_value: &str
) -> ChannelUpdateCall<'a, C, A>

The onBehalfOfContentOwner parameter indicates that the authenticated user 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 needs to be linked to the specified YouTube content owner.

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

pub fn delegate(
    new_value: &'a mut dyn Delegate
) -> ChannelUpdateCall<'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.

pub fn param<T>(self, name: T, value: T) -> ChannelUpdateCall<'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 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) -> ChannelUpdateCall<'a, C, A> where
    T: Into<Option<S>>,
    S: 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. 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 ChannelUpdateCall<'a, C, A>[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

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

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

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

impl<T> Typeable for T where
    T: Any

fn get_type(&self) -> TypeId

Get the TypeId of this object.