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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
//! Helix endpoints regarding chat
use crate::{
helix::{self, Request},
types::{self, EmoteUrlBuilder},
};
use serde::{Deserialize, Serialize};
pub mod get_channel_chat_badges;
pub mod get_channel_emotes;
pub mod get_emote_sets;
pub mod get_global_chat_badges;
pub mod get_global_emotes;
pub mod update_chat_settings;
#[doc(inline)]
pub use get_channel_chat_badges::GetChannelChatBadgesRequest;
#[doc(inline)]
pub use get_global_chat_badges::GetGlobalChatBadgesRequest;
#[doc(inline)]
pub use get_channel_emotes::GetChannelEmotesRequest;
#[doc(inline)]
pub use get_global_emotes::GetGlobalEmotesRequest;
#[doc(inline)]
pub use get_emote_sets::GetEmoteSetsRequest;
#[doc(inline)]
pub use update_chat_settings::{UpdateChatSettingsBody, UpdateChatSettingsRequest};
/// A set of badges
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct BadgeSet {
/// ID for the chat badge set.
pub set_id: types::BadgeSetId,
/// Contains chat badge objects for the set.
pub versions: Vec<ChatBadge>,
}
/// A chat Badge
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ChatBadge {
/// ID of the chat badge version.
pub id: types::ChatBadgeId,
// FIXME: Use types::Image, see https://github.com/serde-rs/serde/issues/1504
/// URL to png of size 28x28
pub image_url_1x: String,
/// URL to png of size 56x56
pub image_url_2x: String,
/// URL to png of size 112x112
pub image_url_4x: String,
}
/// A chat emote
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ChannelEmote {
/// ID of the emote.
pub id: types::EmoteId,
/// Name of the emote a viewer types into Twitch chat for the image to appear.
pub name: String,
/// Object of image URLs for the emote.
pub images: types::Image,
/// If the emote_type is "subscriptions", this indicates the subscriber tier at which the emote is unlocked. Set to an empty string otherwise.
#[serde(
default,
deserialize_with = "helix::deserialize_none_from_empty_string"
)]
pub tier: Option<types::SubscriptionTier>,
// FIXME: Enumify?
/// The type of emote.
///
/// The most common values for custom channel emotes are
///
/// `subscriptions`: Indicates a custom subscriber emote.
///
/// `bitstier`: Indicates a custom Bits tier emote.
///
/// `follower`: Indicates a custom follower emote.
pub emote_type: String,
/// ID of the emote set the emote belongs to.
pub emote_set_id: types::EmoteSetId,
/// The formats that the emote is available in.
pub format: Vec<types::EmoteAnimationSetting>,
/// The sizes that the emote is available in.
pub scale: Vec<types::EmoteScale>,
/// The background themes that the emote is available in.
pub theme_mode: Vec<types::EmoteThemeMode>,
}
impl ChannelEmote {
/// Create an emote builder for this emote.
///
/// # Examples
///
/// ```rust, no_run
/// # use twitch_api2::{client, helix};
/// # #[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 emotes = client.get_channel_emotes_from_login("twitchdev", &token).await?.expect("user not found");
/// assert_eq!(emotes[0].url().size_3x().dark_mode().render(), "https://static-cdn.jtvnw.net/emoticons/v2/emotesv2_dc24652ada1e4c84a5e3ceebae4de709/default/dark/3.0");
/// # Ok(())
/// # }
/// ```
pub fn url(&self) -> types::EmoteUrlBuilder<'_> {
EmoteUrlBuilder {
id: std::borrow::Cow::Borrowed(&self.id),
animation_setting: <_>::default(),
theme_mode: <_>::default(),
scale: <_>::default(),
template: types::EMOTE_V2_URL_TEMPLATE.into(),
}
}
}
/// A chat emote
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct GlobalEmote {
/// ID of the emote.
pub id: types::EmoteId,
/// Name of the emote a viewer types into Twitch chat for the image to appear.
pub name: String,
/// Object of image URLs for the emote.
pub images: types::Image,
/// The formats that the emote is available in.
pub format: Vec<types::EmoteAnimationSetting>,
/// The sizes that the emote is available in.
pub scale: Vec<types::EmoteScale>,
/// The background themes that the emote is available in.
pub theme_mode: Vec<types::EmoteThemeMode>,
}
/// Chat settings
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
#[non_exhaustive]
pub struct ChatSettings {
/// The ID of the broadcaster specified in the request.
pub broadcaster_id: types::UserId,
/// A Boolean value that determines whether chat messages must contain only emotes. Is true, if only messages that are 100% emotes are allowed; otherwise, false.
pub emote_mode: bool,
/// A Boolean value that determines whether the broadcaster restricts the chat room to followers only, based on how long they’ve followed.
///
/// Is true, if the broadcaster restricts the chat room to followers only; otherwise, false.
/// See [`follower_mode_duration`](Self::follower_mode_duration) for how long the followers must have followed the broadcaster to participate in the chat room.
pub follower_mode: bool,
/// The length of time, in minutes, that the followers must have followed the broadcaster to participate in the chat room. See [`follower_mode`](Self::follower_mode).
///
/// Is null if [`follower_mode`](Self::follower_mode) is false.
pub follower_mode_duration: Option<u64>,
/// The ID of the moderator specified in the request for chat settings.
pub moderator_id: Option<types::UserId>,
/// A Boolean value that determines whether the broadcaster adds a short delay before chat messages appear in the chat room. This gives chat moderators and bots a chance to remove them before viewers can see the message.
///
/// Is true, if the broadcaster applies a delay; otherwise, false.
/// See [`non_moderator_chat_delay_duration`](Self::non_moderator_chat_delay_duration) for the length of the delay.
///
/// # Notes
///
/// This field and [`non_moderator_chat_delay_duration`](Self::non_moderator_chat_delay_duration) are not received when the request is made without a specified `moderator_id`.
pub non_moderator_chat_delay: Option<bool>,
/// The amount of time, in seconds, that messages are delayed from appearing in chat. See [`non_moderator_chat_delay`](Self::non_moderator_chat_delay).
///
/// Is null if [`non_moderator_chat_delay`](Self::non_moderator_chat_delay) is false.
pub non_moderator_chat_delay_duration: Option<u64>,
/// A Boolean value that determines whether the broadcaster limits how often users in the chat room are allowed to send messages.
///
/// Is true, if the broadcaster applies a delay; otherwise, false.
/// See [`slow_mode_wait_time`](Self::slow_mode_wait_time) for the delay.
pub slow_mode: bool,
/// The amount of time, in seconds, that users need to wait between sending messages. See slow_mode.
///
/// Is null if slow_mode is false.
pub slow_mode_wait_time: Option<u64>,
/// A Boolean value that determines whether only users that subscribe to the broadcaster’s channel can talk in the chat room.
///
/// Is true, if the broadcaster restricts the chat room to subscribers only; otherwise, false.
pub subscriber_mode: bool,
/// A Boolean value that determines whether the broadcaster requires users to post only unique messages in the chat room.
///
/// Is true, if the broadcaster requires unique messages only; otherwise, false.
pub unique_chat_mode: bool,
}