Struct twitch_api::helix::moderation::GetBannedUsersRequest
source · [−]#[non_exhaustive]pub struct GetBannedUsersRequest<'a> {
pub broadcaster_id: Cow<'a, UserIdRef>,
pub user_id: Cow<'a, [&'a UserIdRef]>,
pub after: Option<Cow<'a, CursorRef>>,
pub before: Option<Cow<'a, CursorRef>>,
pub first: Option<usize>,
}
helix
only.Expand description
Query Parameters for Get Banned Users
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: Cow<'a, UserIdRef>
Must match the User ID in the Bearer token.
user_id: Cow<'a, [&'a UserIdRef]>
Filters the results and only returns a status object for users who are banned in this channel and have a matching user_id. Format: Repeated Query Parameter, eg. /moderation/banned?broadcaster_id=1&user_id=2&user_id=3 Maximum: 100
after: Option<Cow<'a, CursorRef>>
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.
before: Option<Cow<'a, CursorRef>>
Cursor for backward 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<'a> GetBannedUsersRequest<'a>
impl<'a> GetBannedUsersRequest<'a>
sourcepub fn builder() -> GetBannedUsersRequestBuilder<'a, ((), (), (), (), ())>
pub fn builder() -> GetBannedUsersRequestBuilder<'a, ((), (), (), (), ())>
Create a builder for building GetBannedUsersRequest
.
On the builder, call .broadcaster_id(...)
, .user_id(...)
(optional), .after(...)
(optional), .before(...)
(optional), .first(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetBannedUsersRequest
.
sourceimpl<'a> GetBannedUsersRequest<'a>
impl<'a> GetBannedUsersRequest<'a>
sourcepub fn broadcaster_id(broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self
pub fn broadcaster_id(broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self
Get banned users in a broadcasters channel.
Examples found in repository?
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
pub fn get_banned_users_in_channel_from_id<'b: 'a, T>(
&'a self,
broadcaster_id: impl types::IntoCow<'b, types::UserIdRef> + 'b,
token: &'a T,
) -> std::pin::Pin<
Box<
dyn futures::Stream<Item = Result<helix::moderation::BannedUser, ClientError<'a, C>>>
+ 'a,
>,
>
where
T: TwitchToken + Send + Sync + ?Sized,
{
let req = helix::moderation::GetBannedUsersRequest::broadcaster_id(broadcaster_id);
make_stream(req, token, self, std::collections::VecDeque::from)
}
Trait Implementations
sourceimpl<'a> Clone for GetBannedUsersRequest<'a>
impl<'a> Clone for GetBannedUsersRequest<'a>
sourcefn clone(&self) -> GetBannedUsersRequest<'a>
fn clone(&self) -> GetBannedUsersRequest<'a>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'a> Debug for GetBannedUsersRequest<'a>
impl<'a> Debug for GetBannedUsersRequest<'a>
sourceimpl<'de: 'a, 'a> Deserialize<'de> for GetBannedUsersRequest<'a>
impl<'de: 'a, 'a> Deserialize<'de> for GetBannedUsersRequest<'a>
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 GetBannedUsersRequest<'_>
impl Paginated for GetBannedUsersRequest<'_>
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
sourceimpl<'a> PartialEq<GetBannedUsersRequest<'a>> for GetBannedUsersRequest<'a>
impl<'a> PartialEq<GetBannedUsersRequest<'a>> for GetBannedUsersRequest<'a>
sourcefn eq(&self, other: &GetBannedUsersRequest<'a>) -> bool
fn eq(&self, other: &GetBannedUsersRequest<'a>) -> bool
sourceimpl Request for GetBannedUsersRequest<'_>
impl Request for GetBannedUsersRequest<'_>
type Response = Vec<BannedUser, Global>
type Response = Vec<BannedUser, Global>
sourceconst PATH: &'static str = "moderation/banned"
const PATH: &'static str = "moderation/banned"
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 GetBannedUsersRequest<'_>
impl RequestGet for GetBannedUsersRequest<'_>
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<'a> Serialize for GetBannedUsersRequest<'a>
impl<'a> Serialize for GetBannedUsersRequest<'a>
impl<'a> Eq for GetBannedUsersRequest<'a>
impl<'a> StructuralEq for GetBannedUsersRequest<'a>
impl<'a> StructuralPartialEq for GetBannedUsersRequest<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for GetBannedUsersRequest<'a>
impl<'a> Send for GetBannedUsersRequest<'a>
impl<'a> Sync for GetBannedUsersRequest<'a>
impl<'a> Unpin for GetBannedUsersRequest<'a>
impl<'a> UnwindSafe for GetBannedUsersRequest<'a>
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.