Struct twitch_api::helix::eventsub::GetEventSubSubscriptionsRequest
source · [−]#[non_exhaustive]pub struct GetEventSubSubscriptionsRequest<'a> {
pub status: Option<Status>,
pub type_: Option<EventType>,
pub user_id: Option<Cow<'a, UserIdRef>>,
pub after: Option<Cow<'a, CursorRef>>,
pub first: Option<usize>,
}
helix
and eventsub
only.Expand description
Query Parameters for Get EventSub Subscriptions
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.status: Option<Status>
Include this parameter to filter subscriptions by their status.
type_: Option<EventType>
Filter subscriptions by subscription type (e.g., channel.update).
user_id: Option<Cow<'a, UserIdRef>>
Filter subscriptions by user ID.
The response contains subscriptions where the user ID matches a user ID that you specified in the Condition object when you created the subscription.
after: Option<Cow<'a, CursorRef>>
Cursor for forward pagination
first: Option<usize>
Maximum number of objects to return. Maximum: 100. Default: 20.
Implementations
sourceimpl<'a> GetEventSubSubscriptionsRequest<'a>
impl<'a> GetEventSubSubscriptionsRequest<'a>
sourcepub fn builder(
) -> GetEventSubSubscriptionsRequestBuilder<'a, ((), (), (), (), ())>
pub fn builder(
) -> GetEventSubSubscriptionsRequestBuilder<'a, ((), (), (), (), ())>
Create a builder for building GetEventSubSubscriptionsRequest
.
On the builder, call .status(...)
(optional), .type_(...)
(optional), .user_id(...)
(optional), .after(...)
(optional), .first(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of GetEventSubSubscriptionsRequest
.
Trait Implementations
sourceimpl<'a> Clone for GetEventSubSubscriptionsRequest<'a>
impl<'a> Clone for GetEventSubSubscriptionsRequest<'a>
sourcefn clone(&self) -> GetEventSubSubscriptionsRequest<'a>
fn clone(&self) -> GetEventSubSubscriptionsRequest<'a>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'a> Debug for GetEventSubSubscriptionsRequest<'a>
impl<'a> Debug for GetEventSubSubscriptionsRequest<'a>
sourceimpl<'a> Default for GetEventSubSubscriptionsRequest<'a>
impl<'a> Default for GetEventSubSubscriptionsRequest<'a>
sourcefn default() -> GetEventSubSubscriptionsRequest<'a>
fn default() -> GetEventSubSubscriptionsRequest<'a>
sourceimpl Paginated for GetEventSubSubscriptionsRequest<'_>
impl Paginated for GetEventSubSubscriptionsRequest<'_>
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
helix
only.sourceimpl<'a> PartialEq<GetEventSubSubscriptionsRequest<'a>> for GetEventSubSubscriptionsRequest<'a>
impl<'a> PartialEq<GetEventSubSubscriptionsRequest<'a>> for GetEventSubSubscriptionsRequest<'a>
sourcefn eq(&self, other: &GetEventSubSubscriptionsRequest<'a>) -> bool
fn eq(&self, other: &GetEventSubSubscriptionsRequest<'a>) -> bool
sourceimpl Request for GetEventSubSubscriptionsRequest<'_>
impl Request for GetEventSubSubscriptionsRequest<'_>
type Response = EventSubSubscriptions
type Response = EventSubSubscriptions
helix
only.sourceconst PATH: &'static str = "eventsub/subscriptions"
const PATH: &'static str = "eventsub/subscriptions"
helix
only.channels
for Get Channel Informationsourceconst SCOPE: &'static [Scope] = _
const SCOPE: &'static [Scope] = _
helix
and twitch_oauth2
only.sourceconst OPT_SCOPE: &'static [Scope] = _
const OPT_SCOPE: &'static [Scope] = _
helix
and twitch_oauth2
only.sourcefn query(&self) -> Result<String, SerializeError>
fn query(&self) -> Result<String, SerializeError>
helix
only.sourcefn get_uri(&self) -> Result<Uri, InvalidUri>
fn get_uri(&self) -> Result<Uri, InvalidUri>
helix
only.sourcefn get_bare_uri() -> Result<Uri, InvalidUri>
fn get_bare_uri() -> Result<Uri, InvalidUri>
helix
only.sourceimpl RequestGet for GetEventSubSubscriptionsRequest<'_>
impl RequestGet for GetEventSubSubscriptionsRequest<'_>
sourcefn parse_inner_response(
request: Option<Self>,
uri: &Uri,
response: &str,
status: StatusCode
) -> 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,
helix
only.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>
helix
only.http::Request
from this Request
in your clientsourceimpl<'a> Serialize for GetEventSubSubscriptionsRequest<'a>
impl<'a> Serialize for GetEventSubSubscriptionsRequest<'a>
impl<'a> Eq for GetEventSubSubscriptionsRequest<'a>
impl<'a> StructuralEq for GetEventSubSubscriptionsRequest<'a>
impl<'a> StructuralPartialEq for GetEventSubSubscriptionsRequest<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for GetEventSubSubscriptionsRequest<'a>
impl<'a> Send for GetEventSubSubscriptionsRequest<'a>
impl<'a> Sync for GetEventSubSubscriptionsRequest<'a>
impl<'a> Unpin for GetEventSubSubscriptionsRequest<'a>
impl<'a> UnwindSafe for GetEventSubSubscriptionsRequest<'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.