Struct google_youtube3::api::LiveChatMessageListCall

source · 
pub struct LiveChatMessageListCall<'a, S>
where
    S: 'a,
{ /* private fields */ }
Expand description

Retrieves a list of resources, possibly filtered.

A builder for the list method supported by a liveChatMessage resource. It is not used directly, but through a LiveChatMessageMethods 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
  • https://www.googleapis.com/auth/youtube.force-ssl
  • https://www.googleapis.com/auth/youtube.readonly

The default scope will be Scope::Readonly.

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.live_chat_messages().list("liveChatId", &vec!["dolores".into()])
             .profile_image_size(20)
             .page_token("accusam")
             .max_results(91)
             .hl("takimata")
             .doit().await;

Implementations§

source§

impl<'a, S> LiveChatMessageListCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

source

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

Perform the operation you have build so far.

source

pub fn live_chat_id(self, new_value: &str) -> LiveChatMessageListCall<'a, S>

The id of the live chat for which comments should be returned.

Sets the live chat 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.

source

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

The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet.

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.

Settable Parts

  • id
  • snippet
source

pub fn profile_image_size( self, new_value: u32 ) -> LiveChatMessageListCall<'a, S>

Specifies the size of the profile image that should be returned for each user.

Sets the profile image size query property to the given value.

source

pub fn page_token(self, new_value: &str) -> LiveChatMessageListCall<'a, S>

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.

Sets the page token query property to the given value.

source

pub fn max_results(self, new_value: u32) -> LiveChatMessageListCall<'a, S>

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.

source

pub fn hl(self, new_value: &str) -> LiveChatMessageListCall<'a, S>

Specifies the localization language in which the system messages should be returned.

Sets the hl query property to the given value.

source

pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> LiveChatMessageListCall<'a, S>

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.

source

pub fn param<T>(self, name: T, value: T) -> LiveChatMessageListCall<'a, S>
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”).
source

pub fn add_scope<St>(self, scope: St) -> LiveChatMessageListCall<'a, S>
where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of 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.

source

pub fn add_scopes<I, St>(self, scopes: I) -> LiveChatMessageListCall<'a, S>
where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

source

pub fn clear_scopes(self) -> LiveChatMessageListCall<'a, S>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).

Trait Implementations§

Auto Trait Implementations§

§

impl<'a, S> !RefUnwindSafe for LiveChatMessageListCall<'a, S>

§

impl<'a, S> Send for LiveChatMessageListCall<'a, S>
where S: Sync,

§

impl<'a, S> !Sync for LiveChatMessageListCall<'a, S>

§

impl<'a, S> Unpin for LiveChatMessageListCall<'a, S>

§

impl<'a, S> !UnwindSafe for LiveChatMessageListCall<'a, S>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more