Struct google_youtube3::api::CommentThreadListCall[−][src]

pub struct CommentThreadListCall<'a> { /* fields omitted */ }

Expand description

Retrieves a list of resources, possibly filtered.

A builder for the list method supported by a commentThread resource. It is not used directly, but through a CommentThreadMethods 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.comment_threads().list(&vec!["no".into()])
             .video_id("est")
             .text_format("At")
             .search_terms("sed")
             .page_token("sit")
             .order("et")
             .moderation_status("tempor")
             .max_results(69)
             .add_id("ipsum")
             .channel_id("et")
             .all_threads_related_to_channel_id("sanctus")
             .doit().await;

Implementations

[src]

impl<'a> CommentThreadListCall<'a>

[src]

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

Perform the operation you have build so far.

[src]

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

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

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.

[src]

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

Returns the comment threads of the specified video.

Sets the video id query property to the given value.

[src]

pub fn text_format(self, new_value: &str) -> CommentThreadListCall<'a>

The requested text format for the returned comments.

Sets the text format query property to the given value.

[src]

pub fn search_terms(self, new_value: &str) -> CommentThreadListCall<'a>

Limits the returned comment threads to those matching the specified key words. Not compatible with the ‘id’ filter.

Sets the search terms query property to the given value.

[src]

pub fn page_token(self, new_value: &str) -> CommentThreadListCall<'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.

[src]

pub fn order(self, new_value: &str) -> CommentThreadListCall<'a>

Sets the order query property to the given value.

[src]

pub fn moderation_status(self, new_value: &str) -> CommentThreadListCall<'a>

Limits the returned comment threads to those with the specified moderation status. Not compatible with the ‘id’ filter. Valid values: published, heldForReview, likelySpam.

Sets the moderation status query property to the given value.

[src]

pub fn max_results(self, new_value: u32) -> CommentThreadListCall<'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.

[src]

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

Returns the comment threads 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.

[src]

pub fn channel_id(self, new_value: &str) -> CommentThreadListCall<'a>

Returns the comment threads for all the channel comments (ie does not include comments left on videos).

Sets the channel id query property to the given value.

[src]

pub fn all_threads_related_to_channel_id(
self,
new_value: &str
) -> CommentThreadListCall<'a>

Returns the comment threads of all videos of the channel and the channel comments as well.

Sets the all threads related to channel id query property to the given value.

[src]

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

[src]

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

$.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”).

[src]

pub fn add_scope<T, S>(self, scope: T) -> CommentThreadListCall<'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::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.