#[non_exhaustive]pub struct GetBroadcasterSubscriptionsRequest<'a> {
pub broadcaster_id: Cow<'a, UserIdRef>,
pub user_id: Cow<'a, [&'a UserIdRef]>,
pub after: Option<Cow<'a, CursorRef>>,
pub first: Option<usize>,
}
helix
only.Expand description
Query Parameters for Get Broadcaster 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.broadcaster_id: Cow<'a, UserIdRef>
User ID of the broadcaster. Must match the User ID in the Bearer token.
user_id: Cow<'a, [&'a UserIdRef]>
Unique identifier of account to get subscription status of. Accepts up to 100 values.
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. The cursor value specified here is from the pagination response field of a prior query.
first: Option<usize>
Number of values to be returned per page. Limit: 100. Default: 20.
Implementations
sourceimpl<'a> GetBroadcasterSubscriptionsRequest<'a>
impl<'a> GetBroadcasterSubscriptionsRequest<'a>
sourcepub fn builder(
) -> GetBroadcasterSubscriptionsRequestBuilder<'a, ((), (), (), ())>
pub fn builder(
) -> GetBroadcasterSubscriptionsRequestBuilder<'a, ((), (), (), ())>
Create a builder for building GetBroadcasterSubscriptionsRequest
.
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 GetBroadcasterSubscriptionsRequest
.
sourceimpl<'a> GetBroadcasterSubscriptionsRequest<'a>
impl<'a> GetBroadcasterSubscriptionsRequest<'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
Get a broadcasters subscribers
Examples found in repository?
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
pub fn get_broadcaster_subscriptions<T>(
&'a self,
token: &'a T,
) -> std::pin::Pin<
Box<
dyn futures::Stream<
Item = Result<
helix::subscriptions::BroadcasterSubscription,
ClientError<'a, C>,
>,
> + 'a,
>,
>
where
T: TwitchToken + Send + Sync + ?Sized,
{
use futures::StreamExt;
let user_id = match token
.user_id()
.ok_or_else(|| ClientRequestError::Custom("no user_id found on token".into()))
{
Ok(t) => t,
Err(e) => return futures::stream::once(async { Err(e) }).boxed(),
};
let req = helix::subscriptions::GetBroadcasterSubscriptionsRequest::broadcaster_id(user_id);
make_stream(req, token, self, std::collections::VecDeque::from)
}
sourcepub fn subscriber(self, user_ids: impl Into<Cow<'a, [&'a UserIdRef]>>) -> Self
pub fn subscriber(self, user_ids: impl Into<Cow<'a, [&'a UserIdRef]>>) -> Self
check for specific users in broadcasters subscriptions
Trait Implementations
sourceimpl<'a> Clone for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> Clone for GetBroadcasterSubscriptionsRequest<'a>
sourcefn clone(&self) -> GetBroadcasterSubscriptionsRequest<'a>
fn clone(&self) -> GetBroadcasterSubscriptionsRequest<'a>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<'a> Debug for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> Debug for GetBroadcasterSubscriptionsRequest<'a>
sourceimpl<'de: 'a, 'a> Deserialize<'de> for GetBroadcasterSubscriptionsRequest<'a>
impl<'de: 'a, 'a> Deserialize<'de> for GetBroadcasterSubscriptionsRequest<'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 GetBroadcasterSubscriptionsRequest<'_>
impl Paginated for GetBroadcasterSubscriptionsRequest<'_>
sourcefn set_pagination(&mut self, cursor: Option<Cursor>)
fn set_pagination(&mut self, cursor: Option<Cursor>)
sourceimpl<'a> PartialEq<GetBroadcasterSubscriptionsRequest<'a>> for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> PartialEq<GetBroadcasterSubscriptionsRequest<'a>> for GetBroadcasterSubscriptionsRequest<'a>
sourcefn eq(&self, other: &GetBroadcasterSubscriptionsRequest<'a>) -> bool
fn eq(&self, other: &GetBroadcasterSubscriptionsRequest<'a>) -> bool
sourceimpl Request for GetBroadcasterSubscriptionsRequest<'_>
impl Request for GetBroadcasterSubscriptionsRequest<'_>
type Response = Vec<BroadcasterSubscription, Global>
type Response = Vec<BroadcasterSubscription, Global>
sourceconst PATH: &'static str = "subscriptions"
const PATH: &'static str = "subscriptions"
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 GetBroadcasterSubscriptionsRequest<'_>
impl RequestGet for GetBroadcasterSubscriptionsRequest<'_>
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 GetBroadcasterSubscriptionsRequest<'a>
impl<'a> Serialize for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> Eq for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> StructuralEq for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> StructuralPartialEq for GetBroadcasterSubscriptionsRequest<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> Send for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> Sync for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> Unpin for GetBroadcasterSubscriptionsRequest<'a>
impl<'a> UnwindSafe for GetBroadcasterSubscriptionsRequest<'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.