Struct twitch_api2::helix::points::get_custom_reward_redemption::GetCustomRewardRedemptionRequest [−][src]
#[non_exhaustive]pub struct GetCustomRewardRedemptionRequest { pub broadcaster_id: UserId, pub reward_id: RewardId, pub status: Option<CustomRewardRedemptionStatus>, pub after: Option<Cursor>, pub first: Option<usize>, }
helix
only.Query Parameters for Get Custom Reward Redemption
Fields (Non-exhaustive)
Struct {{ .. }}
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.broadcaster_id: UserId
Provided broadcaster_id must match the user_id in the auth token
reward_id: RewardId
When ID is not provided, this parameter returns paginated Custom Reward Redemption objects for redemptions of the Custom Reward with ID reward_id
status: Option<CustomRewardRedemptionStatus>
When id is not provided, this param is required and filters the paginated Custom Reward Redemption objects for redemptions with the matching status. Can be one of UNFULFILLED, FULFILLED or CANCELED
after: Option<Cursor>
Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. This applies only to queries without ID. If an ID is specified, it supersedes any cursor/offset combinations. The cursor value specified here is from the pagination response field of a prior query.
first: Option<usize>
Number of results to be returned when getting the paginated Custom Reward Redemption objects for a reward. Limit: 50. Default: 20.
Implementations
impl GetCustomRewardRedemptionRequest
[src]
impl GetCustomRewardRedemptionRequest
[src]pub fn builder(
) -> GetCustomRewardRedemptionRequestBuilder<((), (), (), (), ())>
[src]
) -> GetCustomRewardRedemptionRequestBuilder<((), (), (), (), ())>
Create a builder for building GetCustomRewardRedemptionRequest
.
On the builder, call .broadcaster_id(...)
, .reward_id(...)
(optional), .status(...)
(optional), .after(...)
(optional), .first(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetCustomRewardRedemptionRequest
.
Trait Implementations
impl Clone for GetCustomRewardRedemptionRequest
[src]
impl Clone for GetCustomRewardRedemptionRequest
[src]fn clone(&self) -> GetCustomRewardRedemptionRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for GetCustomRewardRedemptionRequest
[src]
impl<'de> Deserialize<'de> for GetCustomRewardRedemptionRequest
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Paginated for GetCustomRewardRedemptionRequest
[src]
impl Paginated for GetCustomRewardRedemptionRequest
[src]fn set_pagination(&mut self, cursor: Option<Cursor>)
[src]
impl PartialEq<GetCustomRewardRedemptionRequest> for GetCustomRewardRedemptionRequest
[src]
impl PartialEq<GetCustomRewardRedemptionRequest> for GetCustomRewardRedemptionRequest
[src]fn eq(&self, other: &GetCustomRewardRedemptionRequest) -> bool
[src]
fn ne(&self, other: &GetCustomRewardRedemptionRequest) -> bool
[src]
impl Request for GetCustomRewardRedemptionRequest
[src]
impl Request for GetCustomRewardRedemptionRequest
[src]type Response = Vec<CustomRewardRedemption>
Response type. twitch’s response will deserialize to this.
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
const OPT_SCOPE: &'static [Scope]
[src]
fn query(&self) -> Result<String, Error>
[src]
fn get_uri(&self) -> Result<Uri, InvalidUri>
[src]
fn get_bare_uri() -> Result<Uri, InvalidUri>
[src]
impl RequestGet for GetCustomRewardRedemptionRequest
[src]
impl RequestGet for GetCustomRewardRedemptionRequest
[src]fn create_request(
&self,
token: &str,
client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>
[src]
&self,
token: &str,
client_id: &str
) -> Result<Request<Vec<u8>>, CreateRequestError>
fn parse_response(
request: Option<Self>,
uri: &Uri,
response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
[src]
request: Option<Self>,
uri: &Uri,
response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
fn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
_status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
[src]
request: Option<Self>,
uri: &Uri,
response: &str,
_status: StatusCode
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
Self: Sized,
Auto Trait Implementations
impl Send for GetCustomRewardRedemptionRequest
impl Send for GetCustomRewardRedemptionRequest
impl Sync for GetCustomRewardRedemptionRequest
impl Sync for GetCustomRewardRedemptionRequest
impl Unpin for GetCustomRewardRedemptionRequest
impl Unpin for GetCustomRewardRedemptionRequest
Blanket Implementations
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
impl<T> WithSubscriber for T
[src]pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,