Struct twitch_api::helix::points::get_custom_reward_redemption::GetCustomRewardRedemptionRequest
source · [−]#[non_exhaustive]pub struct GetCustomRewardRedemptionRequest<'a> {
pub broadcaster_id: Cow<'a, UserIdRef>,
pub reward_id: Option<Cow<'a, RewardIdRef>>,
pub status: Option<CustomRewardRedemptionStatus>,
pub after: Option<Cow<'a, CursorRef>>,
pub first: Option<usize>,
}
helix
only.Expand description
Query Parameters for Get Custom Reward Redemption
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>
Provided broadcaster_id must match the user_id in the auth token
reward_id: Option<Cow<'a, RewardIdRef>>
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<Cow<'a, CursorRef>>
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
sourceimpl<'a> GetCustomRewardRedemptionRequest<'a>
impl<'a> GetCustomRewardRedemptionRequest<'a>
sourcepub fn builder(
) -> GetCustomRewardRedemptionRequestBuilder<'a, ((), (), (), (), ())>
pub fn builder(
) -> GetCustomRewardRedemptionRequestBuilder<'a, ((), (), (), (), ())>
Create a builder for building GetCustomRewardRedemptionRequest
.
On the builder, call .broadcaster_id(...)
, .reward_id(...)
, .status(...)
(optional), .after(...)
(optional), .first(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetCustomRewardRedemptionRequest
.
sourceimpl<'a> GetCustomRewardRedemptionRequest<'a>
impl<'a> GetCustomRewardRedemptionRequest<'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
Reward to fetch
sourcepub fn reward_id(self, reward_id: impl IntoCow<'a, RewardIdRef> + 'a) -> Self
pub fn reward_id(self, reward_id: impl IntoCow<'a, RewardIdRef> + 'a) -> Self
Specific reward to query
sourcepub fn status(self, status: impl Into<CustomRewardRedemptionStatus>) -> Self
pub fn status(self, status: impl Into<CustomRewardRedemptionStatus>) -> Self
Status of rewards to return
Trait Implementations
sourceimpl<'a> Clone for GetCustomRewardRedemptionRequest<'a>
impl<'a> Clone for GetCustomRewardRedemptionRequest<'a>
sourcefn clone(&self) -> GetCustomRewardRedemptionRequest<'a>
fn clone(&self) -> GetCustomRewardRedemptionRequest<'a>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'a> Debug for GetCustomRewardRedemptionRequest<'a>
impl<'a> Debug for GetCustomRewardRedemptionRequest<'a>
sourceimpl<'de: 'a, 'a> Deserialize<'de> for GetCustomRewardRedemptionRequest<'a>
impl<'de: 'a, 'a> Deserialize<'de> for GetCustomRewardRedemptionRequest<'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 GetCustomRewardRedemptionRequest<'_>
impl Paginated for GetCustomRewardRedemptionRequest<'_>
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
sourceimpl<'a> PartialEq<GetCustomRewardRedemptionRequest<'a>> for GetCustomRewardRedemptionRequest<'a>
impl<'a> PartialEq<GetCustomRewardRedemptionRequest<'a>> for GetCustomRewardRedemptionRequest<'a>
sourcefn eq(&self, other: &GetCustomRewardRedemptionRequest<'a>) -> bool
fn eq(&self, other: &GetCustomRewardRedemptionRequest<'a>) -> bool
sourceimpl Request for GetCustomRewardRedemptionRequest<'_>
impl Request for GetCustomRewardRedemptionRequest<'_>
type Response = Vec<CustomRewardRedemption, Global>
type Response = Vec<CustomRewardRedemption, Global>
sourceconst PATH: &'static str = "channel_points/custom_rewards/redemptions"
const PATH: &'static str = "channel_points/custom_rewards/redemptions"
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 GetCustomRewardRedemptionRequest<'_>
impl RequestGet for GetCustomRewardRedemptionRequest<'_>
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 GetCustomRewardRedemptionRequest<'a>
impl<'a> Serialize for GetCustomRewardRedemptionRequest<'a>
impl<'a> Eq for GetCustomRewardRedemptionRequest<'a>
impl<'a> StructuralEq for GetCustomRewardRedemptionRequest<'a>
impl<'a> StructuralPartialEq for GetCustomRewardRedemptionRequest<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for GetCustomRewardRedemptionRequest<'a>
impl<'a> Send for GetCustomRewardRedemptionRequest<'a>
impl<'a> Sync for GetCustomRewardRedemptionRequest<'a>
impl<'a> Unpin for GetCustomRewardRedemptionRequest<'a>
impl<'a> UnwindSafe for GetCustomRewardRedemptionRequest<'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.