Struct twitch_api::helix::moderation::get_moderators::GetModeratorsRequest
source · [−]#[non_exhaustive]pub struct GetModeratorsRequest {
pub broadcaster_id: UserId,
pub user_id: Vec<UserId>,
pub after: Option<Cursor>,
pub first: Option<usize>,
}
helix
only.Expand description
Query Parameters for Get Moderators
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.broadcaster_id: UserId
Must match the User ID in the Bearer token.
user_id: Vec<UserId>
Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.
after: Option<Cursor>
Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. The cursor value specified here is from the pagination response field of a prior query.
first: Option<usize>
Number of values to be returned per page. Limit: 100. Default: 20.
Implementations
sourceimpl GetModeratorsRequest
impl GetModeratorsRequest
sourcepub fn builder() -> GetModeratorsRequestBuilder<((), (), (), ())>
pub fn builder() -> GetModeratorsRequestBuilder<((), (), (), ())>
Create a builder for building GetModeratorsRequest
.
On the builder, call .broadcaster_id(...)
, .user_id(...)
(optional), .after(...)
(optional), .first(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetModeratorsRequest
.
sourceimpl GetModeratorsRequest
impl GetModeratorsRequest
sourcepub fn broadcaster_id(broadcaster_id: impl Into<UserId>) -> Self
pub fn broadcaster_id(broadcaster_id: impl Into<UserId>) -> Self
Get moderators in a broadcasters channel.
Examples found in repository?
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
pub fn get_moderators_in_channel_from_id<T>(
&'a self,
broadcaster_id: impl Into<types::UserId>,
token: &'a T,
) -> std::pin::Pin<
Box<
dyn futures::Stream<Item = Result<helix::moderation::Moderator, ClientError<'a, C>>>
+ 'a,
>,
>
where
T: TwitchToken + Send + Sync + ?Sized,
{
let req = helix::moderation::GetModeratorsRequest::broadcaster_id(broadcaster_id);
make_stream(req, token, self, std::collections::VecDeque::from)
}
sourcepub fn user_id(self, user_id: impl Into<UserId>) -> Self
pub fn user_id(self, user_id: impl Into<UserId>) -> Self
Check if supplied user is a moderator.
sourcepub fn user_ids(
self,
user_ids: impl IntoIterator<Item = impl Into<UserId>>
) -> Self
pub fn user_ids(
self,
user_ids: impl IntoIterator<Item = impl Into<UserId>>
) -> Self
Filter the results for specific users.
Trait Implementations
sourceimpl Clone for GetModeratorsRequest
impl Clone for GetModeratorsRequest
sourcefn clone(&self) -> GetModeratorsRequest
fn clone(&self) -> GetModeratorsRequest
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for GetModeratorsRequest
impl Debug for GetModeratorsRequest
sourceimpl<'de> Deserialize<'de> for GetModeratorsRequest
impl<'de> Deserialize<'de> for GetModeratorsRequest
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl Paginated for GetModeratorsRequest
impl Paginated for GetModeratorsRequest
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
sourceimpl PartialEq<GetModeratorsRequest> for GetModeratorsRequest
impl PartialEq<GetModeratorsRequest> for GetModeratorsRequest
sourcefn eq(&self, other: &GetModeratorsRequest) -> bool
fn eq(&self, other: &GetModeratorsRequest) -> bool
sourceimpl Request for GetModeratorsRequest
impl Request for GetModeratorsRequest
sourceconst PATH: &'static str = "moderation/moderators"
const PATH: &'static str = "moderation/moderators"
channels
for Get Channel Informationsourceconst SCOPE: &'static [Scope] = _
const SCOPE: &'static [Scope] = _
twitch_oauth2
only.sourceconst OPT_SCOPE: &'static [Scope] = _
const OPT_SCOPE: &'static [Scope] = _
twitch_oauth2
only.sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
sourceimpl RequestGet for GetModeratorsRequest
impl RequestGet for GetModeratorsRequest
sourcefn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
fn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Bytes>, CreateRequestError>
http::Request
from this Request
in your clientsourcefn parse_response<B: Into<Bytes>>(
request: Option<Self>,
uri: &Uri,
response: Response<B>
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
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,
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>where
Self: Sized,
sourceimpl Serialize for GetModeratorsRequest
impl Serialize for GetModeratorsRequest
impl Eq for GetModeratorsRequest
impl StructuralEq for GetModeratorsRequest
impl StructuralPartialEq for GetModeratorsRequest
Auto Trait Implementations
impl RefUnwindSafe for GetModeratorsRequest
impl Send for GetModeratorsRequest
impl Sync for GetModeratorsRequest
impl Unpin for GetModeratorsRequest
impl UnwindSafe for GetModeratorsRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.