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
//! Gets all custom emotes for a specific Twitch channel including subscriber emotes, Bits tier emotes, and follower emotes.
//! [`get-channel-emotes`](https://dev.twitch.tv/docs/api/reference#get-channel-emotes)
//!
//! # Accessing the endpoint
//!
//! ## Request: [GetChannelEmotesRequest]
//!
//! To use this endpoint, construct a [`GetChannelEmotesRequest`] with the [`GetChannelEmotesRequest::builder()`] method.
//!
//! ```rust
//! use twitch_api2::helix::chat::get_channel_emotes;
//! let request = get_channel_emotes::GetChannelEmotesRequest::builder()
//! .broadcaster_id("1234".to_string())
//! .build();
//! ```
//!
//! ## Response: [ChannelEmote]
//!
//! Send the request to receive the response with [`HelixClient::req_get()`](helix::HelixClient::req_get).
//!
//! ```rust, no_run
//! use twitch_api2::helix::{self, chat::get_channel_emotes};
//! # 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_channel_emotes::GetChannelEmotesRequest::builder()
//! .broadcaster_id("1234".to_string())
//! .build();
//! let response: Vec<helix::chat::ChannelEmote> = 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 [`GetChannelEmotesRequest::parse_response(None, &request.get_uri(), response)`](GetChannelEmotesRequest::parse_response)
use super::*;
use helix::RequestGet;
/// Query Parameters for [Get Channel Emotes](super::get_channel_emotes)
///
/// [`get-channel-emotes`](https://dev.twitch.tv/docs/api/reference#get-channel-emotes)
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
#[non_exhaustive]
pub struct GetChannelEmotesRequest {
/// The broadcaster whose emotes are being requested.
#[builder(setter(into))]
pub broadcaster_id: types::UserId,
}
/// Return Values for [Get Channel Emotes](super::get_channel_emotes)
///
/// [`get-channel-emotes`](https://dev.twitch.tv/docs/api/reference#get-channel-emotes)
pub type GetChannelEmotesResponse = ChannelEmote;
impl Request for GetChannelEmotesRequest {
type Response = Vec<GetChannelEmotesResponse>;
const PATH: &'static str = "chat/emotes";
#[cfg(feature = "twitch_oauth2")]
const SCOPE: &'static [twitch_oauth2::Scope] = &[];
}
impl RequestGet for GetChannelEmotesRequest {}
#[cfg(test)]
#[test]
fn test_request() {
use helix::*;
let req = GetChannelEmotesRequest::builder()
.broadcaster_id("304456832")
.build();
// From twitch docs
// FIXME: Example has ... and is malformed, uses [] in images
let data = br#"
{
"data": [
{
"id": "304456832",
"name": "twitchdevPitchfork",
"images": {
"url_1x": "https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/1.0",
"url_2x": "https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/2.0",
"url_4x": "https://static-cdn.jtvnw.net/emoticons/v2/304456832/static/light/3.0"
},
"tier": "1000",
"emote_type": "subscriptions",
"emote_set_id": "301590448",
"format": [
"static"
],
"scale": [
"1.0",
"2.0",
"3.0"
],
"theme_mode": [
"light",
"dark"
]
}
],
"template": "https://static-cdn.jtvnw.net/emoticons/v2/{{id}}/{{format}}/{{theme_mode}}/{{scale}}"
}
"#
.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/chat/emotes?broadcaster_id=304456832"
);
dbg!(GetChannelEmotesRequest::parse_response(Some(req), &uri, http_response).unwrap());
}