Struct twitch_api::helix::chat::GetChattersRequest

#[non_exhaustive]
pub struct GetChattersRequest<'a> {
    pub broadcaster_id: Cow<'a, UserIdRef>,
    pub moderator_id: Cow<'a, UserIdRef>,
    pub first: Option<usize>,
    pub after: Option<Cow<'a, CursorRef>>,
}

Available on crate feature helix only.

Query Parameters for Get Chatters

get-chatters

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

broadcaster_id: Cow<'a, UserIdRef>

The ID of the broadcaster whose list of chatters you want to get.

moderator_id: Cow<'a, UserIdRef>

The ID of the moderator or the specified broadcaster that’s requesting the list of chatters. This ID must match the user ID associated with the user access token.

The moderator must have permission to moderate the broadcaster’s chat room.

first: Option<usize>

The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 1,000. The default is 100.

after: Option<Cow<'a, CursorRef>>

The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value.

Implementations

impl<'a> GetChattersRequest<'a>

pub fn builder() -> GetChattersRequestBuilder<'a, ((), (), (), ())>

Create a builder for building GetChattersRequest. On the builder, call .broadcaster_id(...), .moderator_id(...), .first(...)(optional), .after(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetChattersRequest.

impl<'a> GetChattersRequest<'a>

pub fn new(
    broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a,
    moderator_id: impl IntoCow<'a, UserIdRef> + 'a
) -> Self

Get chatters in broadcasters channel

Notes

The moderator has to be the token owner and can moderate the chat

Examples found in repository

src/helix/client/client_ext.rs (line 111)

↕

    pub fn get_chatters<T>(
        &'a self,
        broadcaster_id: impl Into<&'a types::UserIdRef>,
        moderator_id: impl Into<&'a types::UserIdRef>,
        batch_size: impl Into<Option<usize>>,
        token: &'a T,
    ) -> std::pin::Pin<
        Box<dyn futures::Stream<Item = Result<helix::chat::Chatter, ClientError<'a, C>>> + 'a>,
    >
    where
        T: TwitchToken + Send + Sync + ?Sized,
    {
        let req = helix::chat::GetChattersRequest {
            first: batch_size.into(),
            ..helix::chat::GetChattersRequest::new(broadcaster_id.into(), moderator_id.into())
        };

        make_stream(req, token, self, std::collections::VecDeque::from)
    }

pub fn first(self, first: usize) -> Self

Set amount of results returned per page.

Trait Implementations

impl<'a> Clone for GetChattersRequest<'a>

fn clone(&self) -> GetChattersRequest<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for GetChattersRequest<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for GetChattersRequest<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Paginated for GetChattersRequest<'_>

fn set_pagination(&mut self, cursor: Option<Cursor>)

Should returns the current pagination cursor.

impl<'a> PartialEq<GetChattersRequest<'a>> for GetChattersRequest<'a>

fn eq(&self, other: &GetChattersRequest<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Request for GetChattersRequest<'_>

type Response = Vec<Chatter, Global>

Response type. twitch’s response will deserialize to this.

const PATH: &'static str = "chat/chatters"

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Scopes needed by this endpoint

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

fn query(&self) -> Result<String, SerializeError>

Defines layout of the url parameters.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

impl RequestGet for GetChattersRequest<'_>

fn create_request(
    &self,
    token: &str,
    client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>

Create a http::Request from this Request in your client

fn parse_response<B: Into<Bytes>>(
    request: Option<Self>,
    uri: &Uri,
    response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
    Self: Sized,

Parse response.

fn parse_inner_response(
    request: Option<Self>,
    uri: &Uri,
    response: &str,
    status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
    Self: Sized,

Parse a response string into the response.

impl<'a> Serialize for GetChattersRequest<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for GetChattersRequest<'a>

impl<'a> StructuralEq for GetChattersRequest<'a>

impl<'a> StructuralPartialEq for GetChattersRequest<'a>