Struct twitch_api2::helix::moderation::GetBannedUsersRequest
source · [−]#[non_exhaustive]pub struct GetBannedUsersRequest {
pub broadcaster_id: UserId,
pub user_id: Vec<UserId>,
pub after: Option<Cursor>,
pub before: Option<Cursor>,
pub first: Option<String>,
}
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: 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 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<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.
before: Option<Cursor>
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<String>
Number of values to be returned per page. Limit: 100. Default: 20.
Implementations
sourceimpl GetBannedUsersRequest
impl GetBannedUsersRequest
sourcepub fn builder() -> GetBannedUsersRequestBuilder<((), (), (), (), ())>
pub fn builder() -> GetBannedUsersRequestBuilder<((), (), (), (), ())>
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
.
Trait Implementations
sourceimpl Clone for GetBannedUsersRequest
impl Clone for GetBannedUsersRequest
sourcefn clone(&self) -> GetBannedUsersRequest
fn clone(&self) -> GetBannedUsersRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GetBannedUsersRequest
impl Debug for GetBannedUsersRequest
sourceimpl<'de> Deserialize<'de> for GetBannedUsersRequest
impl<'de> Deserialize<'de> for GetBannedUsersRequest
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>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Paginated for GetBannedUsersRequest
impl Paginated for GetBannedUsersRequest
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
Should returns the current pagination cursor. Read more
sourceimpl PartialEq<GetBannedUsersRequest> for GetBannedUsersRequest
impl PartialEq<GetBannedUsersRequest> for GetBannedUsersRequest
sourcefn eq(&self, other: &GetBannedUsersRequest) -> bool
fn eq(&self, other: &GetBannedUsersRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetBannedUsersRequest) -> bool
fn ne(&self, other: &GetBannedUsersRequest) -> bool
This method tests for !=
.
sourceimpl Request for GetBannedUsersRequest
impl Request for GetBannedUsersRequest
type Response = Vec<BannedUser, Global>
type Response = Vec<BannedUser, Global>
Response type. twitch’s response will deserialize to this.
sourceconst PATH: &'static str = "moderation/banned"
const PATH: &'static str = "moderation/banned"
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
sourceconst SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ModerationRead]
const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ModerationRead]
twitch_oauth2
only.Scopes needed by this endpoint
sourceconst OPT_SCOPE: &'static [Scope] = &[]
const OPT_SCOPE: &'static [Scope] = &[]
twitch_oauth2
only.Optional scopes needed by this endpoint
sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
Defines layout of the url parameters.
sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
Returns full URI for the request, including query parameters.
sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
Returns bare URI for the request, NOT including query parameters.
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>
Create a http::Request
from this Request
in your client
sourcefn 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,
Parse response. Read more
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,
Parse a response string into the response.
sourceimpl Serialize for GetBannedUsersRequest
impl Serialize for GetBannedUsersRequest
impl StructuralPartialEq for GetBannedUsersRequest
Auto Trait Implementations
impl RefUnwindSafe for GetBannedUsersRequest
impl Send for GetBannedUsersRequest
impl Sync for GetBannedUsersRequest
impl Unpin for GetBannedUsersRequest
impl UnwindSafe for GetBannedUsersRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more