1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
//! Gets information about active streams belonging to channels that the authenticated user follows.
//! [`get-followed-streams`](https://dev.twitch.tv/docs/api/reference#get-followed-streams)
//!
//! # Accessing the endpoint
//!
//! ## Request: [GetFollowedStreamsRequest]
//!
//! To use this endpoint, construct a [`GetFollowedStreamsRequest`] with the [`GetFollowedStreamsRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::streams::get_followed_streams;
//! let request = get_followed_streams::GetFollowedStreamsRequest::builder()
//! .user_id("1234")
//! .build();
//! ```
//!
//! ## Response: [Stream]
//!
//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, streams::get_followed_streams};
//! # use twitch_api2::client;
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
//! # let client: helix::HelixClient<'static, client::DummyHttpClient> = helix::HelixClient::default();
//! # let token = twitch_oauth2::AccessToken::new("validtoken".to_string());
//! # let token = twitch_oauth2::UserToken::from_existing(&client, token, None, None).await?;
//! let request = get_followed_streams::GetFollowedStreamsRequest::builder()
//! .user_id("1234")
//! .build();
//! let response: Vec<get_followed_streams::GetFollowedStreamsResponse> = client.req_get(request, &token).await?.data;
//! # Ok(())
//! # }
//! ```
//!
//! You can also get the [`http::Request`] with [`request.create_request(&token, &client_id)`](helix::RequestGet::create_request)
//! and parse the [`http::Response`] with [`GetFollowedStreamsRequest::parse_response(None, &request.get_uri(), response)`](GetFollowedStreamsRequest::parse_response)
use super::*;
use helix::RequestGet;
/// Query Parameters for [Get Followed Streams](super::get_followed_streams)
///
/// [`get-followed-streams`](https://dev.twitch.tv/docs/api/reference#get-followed-streams)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct GetFollowedStreamsRequest {
/// Returns streams broadcast by one or more specified user IDs. You can specify up to 100 IDs.
#[builder(setter(into))]
pub user_id: types::UserId,
/// 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.
#[builder(default)]
pub after: Option<helix::Cursor>,
/// Cursor for backward 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.
#[builder(default)]
pub before: Option<helix::Cursor>,
/// Maximum number of objects to return. Maximum: 100. Default: 20.
#[builder(default, setter(into))]
pub first: Option<usize>,
}
/// Return Values for [Get Followed Streams](super::get_followed_streams)
///
/// [`get-followed-streams`](https://dev.twitch.tv/docs/api/reference#get-followed-streams)
pub type GetFollowedStreamsResponse = Stream;
impl Request for GetFollowedStreamsRequest {
type Response = Vec<GetFollowedStreamsResponse>;
const PATH: &'static str = "streams/followed";
#[cfg(feature = "twitch_oauth2")]
const SCOPE: &'static [twitch_oauth2::Scope] = &[twitch_oauth2::Scope::UserReadFollows];
}
impl RequestGet for GetFollowedStreamsRequest {}
impl helix::Paginated for GetFollowedStreamsRequest {
fn set_pagination(&mut self, cursor: Option<helix::Cursor>) { self.after = cursor }
}
#[cfg(test)]
#[test]
fn test_request() {
use helix::*;
let req = GetFollowedStreamsRequest::builder()
.user_id("141981764")
.build();
// From twitch docs.
let data = br#"
{
"data": [
{
"id": "26007494656",
"user_id": "23161357",
"user_name": "LIRIK",
"user_login": "lirik",
"game_id": "417752",
"game_name": "Talk Shows & Podcasts",
"type": "live",
"title": "Hey Guys, It's Monday - Twitter: @Lirik",
"viewer_count": 32575,
"started_at": "2017-08-14T16:08:32Z",
"language": "en",
"thumbnail_url": "https://static-cdn.jtvnw.net/previews-ttv/live_user_lirik-{width}x{height}.jpg",
"tag_ids": [
"6ea6bca4-4712-4ab9-a906-e3336a9d8039"
],
"is_mature": false
},
{
"id": "26007494656",
"user_id": "23161357",
"user_name": "LIRIK",
"user_login": "lirik",
"game_id": "417752",
"game_name": "Talk Shows & Podcasts",
"type": "live",
"title": "Hey Guys, It's Monday - Twitter: @Lirik",
"viewer_count": 32575,
"started_at": "2017-08-14T16:08:32Z",
"language": "en",
"thumbnail_url": "https://static-cdn.jtvnw.net/previews-ttv/live_user_lirik-{width}x{height}.jpg",
"tag_ids": [
"6ea6bca4-4712-4ab9-a906-e3336a9d8039"
],
"is_mature": false
}
],
"pagination": {
"cursor": "eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6MjB9fQ=="
}
}
"#
.to_vec();
let http_response = http::Response::builder().body(data).unwrap();
let uri = req.get_uri().unwrap();
assert_eq!(
uri.to_string(),
"https://api.twitch.tv/helix/streams/followed?user_id=141981764"
);
dbg!(GetFollowedStreamsRequest::parse_response(Some(req), &uri, http_response).unwrap());
}