Struct google_youtube3::SubscriptionListCall

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

Returns subscription resources that match the API request criteria.

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

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.subscriptions().list("part")
             .page_token("et")
             .order("sed")
             .on_behalf_of_content_owner_channel("no")
             .on_behalf_of_content_owner("invidunt")
             .my_subscribers(true)
             .my_recent_subscribers(false)
             .mine(false)
             .max_results(7)
             .id("consetetur")
             .for_channel_id("sea")
             .channel_id("elitr")
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include.

If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties.

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.

fn page_token(self, new_value: &str) -> SubscriptionListCall<'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 order(self, new_value: &str) -> SubscriptionListCall<'a, C, A>

The order parameter specifies the method that will be used to sort resources in the API response.

Sets the order query property to the given value.

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

This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

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

fn on_behalf_of_content_owner(self,
                              new_value: &str)
                              -> SubscriptionListCall<'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 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 my_subscribers(self, new_value: bool) -> SubscriptionListCall<'a, C, A>

Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in no particular order.

Sets the my subscribers query property to the given value.

fn my_recent_subscribers(self,
                         new_value: bool)
                         -> SubscriptionListCall<'a, C, A>

Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user in reverse chronological order (newest first).

Sets the my recent subscribers query property to the given value.

fn mine(self, new_value: bool) -> SubscriptionListCall<'a, C, A>

Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions.

Sets the mine query property to the given value.

fn max_results(self, new_value: u32) -> SubscriptionListCall<'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 id(self, new_value: &str) -> SubscriptionListCall<'a, C, A>

The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID.

Sets the id query property to the given value.

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

The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels.

Sets the for channel id query property to the given value.

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

The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions.

Sets the channel id query property to the given value.

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