Struct twitch_api2::helix::moderation::GetBannedEventsRequest

#[non_exhaustive]pub struct GetBannedEventsRequest {
    pub broadcaster_id: UserId,
    pub user_id: Vec<UserId>,
    pub after: Option<Cursor>,
    pub first: Option<usize>,
}

This is supported on crate feature helix only.

Query Parameters for Get Banned Events

get-banned-events

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: 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.

first: Option<usize>

Maximum number of objects to return. Maximum: 100. Default: 20.

Implementations

impl GetBannedEventsRequest

pub fn builder() -> GetBannedEventsRequestBuilder<((), (), (), ())>

Create a builder for building GetBannedEventsRequest. 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 GetBannedEventsRequest.

Trait Implementations

impl Clone for GetBannedEventsRequest

fn clone(&self) -> GetBannedEventsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetBannedEventsRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetBannedEventsRequest

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

Deserialize this value from the given Serde deserializer.

impl Paginated for GetBannedEventsRequest

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

Should returns the current pagination cursor.

impl PartialEq<GetBannedEventsRequest> for GetBannedEventsRequest

fn eq(&self, other: &GetBannedEventsRequest) -> bool

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

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

This method tests for !=.

impl Request for GetBannedEventsRequest

type Response = Vec<BannedEvent>

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

const PATH: &'static str

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

const SCOPE: &'static [Scope]

Scopes needed by this endpoint

const OPT_SCOPE: &'static [Scope]

Optional scopes needed by this endpoint

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

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 GetBannedEventsRequest

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

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

fn parse_response(
    request: Option<Self>,
    uri: &Uri,
    response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
    Self: Sized, 

Parse response. Override for different behavior

impl Serialize for GetBannedEventsRequest

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetBannedEventsRequest