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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 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 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
use serde::{Deserialize, Serialize};
pub use self::{input::*, mask::*, set::*};
use crate::{
api::{Form, Method, Payload},
types::{
ChatId,
File,
InputFile,
Integer,
Message,
PhotoSize,
ReplyMarkup,
ReplyMarkupError,
ReplyParameters,
ReplyParametersError,
},
};
#[cfg(test)]
mod tests;
mod input;
mod mask;
mod set;
/// Represents a sticker.
#[derive(Clone, Debug, Deserialize, PartialEq, PartialOrd, Serialize)]
pub struct Sticker {
/// Identifier of the file.
///
/// Can be used to download or reuse the file.
pub file_id: String,
/// Unique identifier of the file.
///
/// It is supposed to be the same over time and for different bots.
/// Can't be used to download or reuse the file.
pub file_unique_id: String,
/// Sticker height.
pub height: Integer,
/// Indicates whether the sticker is animated.
pub is_animated: bool,
/// Indicates whether the sticker is a video sticker.
pub is_video: bool,
/// Type of the sticker.
///
/// The type of the sticker is independent from its format,
/// which is determined by the fields `is_animated` and `is_video`.
#[serde(rename = "type")]
pub sticker_type: StickerType,
/// Sticker width.
pub width: Integer,
/// For custom emoji stickers, unique identifier of the custom emoji.
#[serde(skip_serializing_if = "Option::is_none")]
pub custom_emoji_id: Option<String>,
/// Emoji associated with the sticker.
#[serde(skip_serializing_if = "Option::is_none")]
pub emoji: Option<String>,
/// File size in bytes.
#[serde(skip_serializing_if = "Option::is_none")]
pub file_size: Option<Integer>,
/// For mask stickers, the position where the mask should be placed.
#[serde(skip_serializing_if = "Option::is_none")]
pub mask_position: Option<MaskPosition>,
/// Indicates whether the sticker must be repainted to a text color in messages,
/// the color of the Telegram Premium badge in emoji status,
/// white color on chat photos, or another appropriate color in other places.
#[serde(skip_serializing_if = "Option::is_none")]
pub needs_repainting: Option<bool>,
/// For premium regular stickers, premium animation for the sticker.
#[serde(skip_serializing_if = "Option::is_none")]
pub premium_animation: Option<File>,
/// Name of the sticker set to which the sticker belongs.
#[serde(skip_serializing_if = "Option::is_none")]
pub set_name: Option<String>,
/// Sticker thumbnail in the WEBP or JPEG format.
#[serde(skip_serializing_if = "Option::is_none")]
pub thumbnail: Option<PhotoSize>,
}
impl Sticker {
/// Creates a new `Sticker`.
///
/// # Arguments
///
/// * `file_id` - Identifier for the file.
/// * `file_unique_id` - Unique identifier for the file.
/// * `sticker_type` - Type of the sticker.
/// * `height` - Sticker height.
/// * `width` - Sticker width.
pub fn new<A, B>(file_id: A, file_unique_id: B, sticker_type: StickerType, height: Integer, width: Integer) -> Self
where
A: Into<String>,
B: Into<String>,
{
Self {
file_id: file_id.into(),
file_unique_id: file_unique_id.into(),
height,
is_animated: false,
is_video: false,
sticker_type,
width,
custom_emoji_id: None,
emoji: None,
file_size: None,
mask_position: None,
needs_repainting: None,
premium_animation: None,
set_name: None,
thumbnail: None,
}
}
/// Sets a new value for an `is_animated` flag.
///
/// # Arguments
///
/// * `value` - Indicates whether the sticker is animated.
pub fn with_is_animated(mut self, value: bool) -> Self {
self.is_animated = value;
self
}
/// Sets a new value for an `is_video` flag.
///
/// # Arguments
///
/// * `value` - Indicates whether the sticker is a video sticker.
pub fn with_is_video(mut self, value: bool) -> Self {
self.is_video = value;
self
}
/// Sets a new custom emoji ID.
///
/// # Arguments
///
/// * `value` - Custom emoji ID.
pub fn with_custom_emoji_id<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.custom_emoji_id = Some(value.into());
self
}
/// Sets a new emoji.
///
/// # Arguments
///
/// * `value` - Emoji.
pub fn with_emoji<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.emoji = Some(value.into());
self
}
/// Sets a new file size.
///
/// # Arguments
///
/// * `value` - File size in bytes.
pub fn with_file_size(mut self, value: Integer) -> Self {
self.file_size = Some(value);
self
}
/// Sets a new mask position.
///
/// # Arguments
///
/// * `value` - Mask position.
pub fn with_mask_position(mut self, value: MaskPosition) -> Self {
self.mask_position = Some(value);
self
}
/// Sets a new value for a `needs_repainting` flag.
///
/// # Arguments
///
/// * `value` - Value of the flag.
pub fn with_needs_repainting(mut self, value: bool) -> Self {
self.needs_repainting = Some(value);
self
}
/// Sets a new premium animation.
///
/// # Arguments
///
/// * `value` - Premium animation.
pub fn with_premium_animation(mut self, value: File) -> Self {
self.premium_animation = Some(value);
self
}
/// Sets a new sticker set name.
///
/// # Arguments
///
/// * `value` - Name of a sticker set.
pub fn with_set_name<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.set_name = Some(value.into());
self
}
/// Sets a new thumbnail.
///
/// # Arguments
///
/// * `value` - Thumbnail.
pub fn with_thumbnail(mut self, value: PhotoSize) -> Self {
self.thumbnail = Some(value);
self
}
}
/// Represents a format of stickers in the set.
#[derive(Clone, Copy, Debug, Deserialize, PartialEq, PartialOrd, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum StickerFormat {
/// PNG or WEBP.
Static,
/// TGS.
Animated,
/// WEBM.
Video,
}
impl AsRef<str> for StickerFormat {
fn as_ref(&self) -> &str {
match self {
Self::Static => "static",
Self::Animated => "animated",
Self::Video => "video",
}
}
}
/// Represents a type of stickers in the set.
#[derive(Clone, Copy, Debug, Deserialize, PartialEq, PartialOrd, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum StickerType {
/// Sticker contains a custom emoji.
CustomEmoji,
/// Sticker contains a mask.
Mask,
/// Regular sticker.
Regular,
}
impl AsRef<str> for StickerType {
fn as_ref(&self) -> &str {
match self {
Self::CustomEmoji => "custom_emoji",
Self::Mask => "mask",
Self::Regular => "regular",
}
}
}
/// Returns information about custom emoji stickers by their identifiers.
#[derive(Clone, Debug, Serialize)]
pub struct GetCustomEmojiStickers {
custom_emoji_ids: Vec<String>,
}
impl GetCustomEmojiStickers {
/// Creates a new `GetCustomEmojiStickers`.
///
/// # Arguments
///
/// * `custom_emoji_ids` - List of custom emoji identifiers;
/// at most 200 custom emoji identifiers can be specified.
pub fn new<A, B>(custom_emoji_ids: A) -> Self
where
A: IntoIterator<Item = B>,
B: Into<String>,
{
Self {
custom_emoji_ids: custom_emoji_ids.into_iter().map(Into::into).collect(),
}
}
}
impl Method for GetCustomEmojiStickers {
type Response = Vec<Sticker>;
fn into_payload(self) -> Payload {
Payload::json("getCustomEmojiStickers", self)
}
}
/// Sends a static WEBP, animated TGS, or video WEBM sticker.
#[derive(Debug)]
pub struct SendSticker {
form: Form,
}
impl SendSticker {
/// Creates a new `SendSticker`.
///
/// # Arguments
///
/// * `chat_id` - Unique identifier of the target chat.
/// * `sticker` - Sticker to send.
pub fn new<A, B>(chat_id: A, sticker: B) -> Self
where
A: Into<ChatId>,
B: Into<InputFile>,
{
Self {
form: Form::from([("chat_id", chat_id.into().into()), ("sticker", sticker.into().into())]),
}
}
/// Sets a new business connection ID.
///
/// # Arguments
///
/// * `value` - Unique identifier of the business connection.
pub fn with_business_connection_id<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.form.insert_field("business_connection_id", value.into());
self
}
/// Sets a new value for a `disable_notification` flag.
///
/// # Arguments
///
/// * `value` - Indicates whether to send the message silently or not;
/// a user will receive a notification without sound.
pub fn with_disable_notification(mut self, value: bool) -> Self {
self.form.insert_field("disable_notification", value);
self
}
/// Sets a new emoji.
///
/// # Arguments
///
/// * `value` - Emoji associated with the sticker; only for just uploaded stickers.
pub fn with_emoji<T>(mut self, value: T) -> Self
where
T: Into<String>,
{
self.form.insert_field("emoji", value.into());
self
}
/// Sets a new message thread ID.
///
/// # Arguments
///
/// * `value` - Unique identifier of the target message thread;
/// supergroups only.
pub fn with_message_thread_id(mut self, value: Integer) -> Self {
self.form.insert_field("message_thread_id", value);
self
}
/// Sets a new value for a `protect_content` flag.
///
/// # Arguments
///
/// * `value` - Indicates whether to protect the contents
/// of the sent message from forwarding and saving.
pub fn with_protect_content(mut self, value: bool) -> Self {
self.form.insert_field("protect_content", value.to_string());
self
}
/// Sets a new reply markup.
///
/// # Arguments
///
/// * `value` - Reply markup.
pub fn with_reply_markup<T>(mut self, value: T) -> Result<Self, ReplyMarkupError>
where
T: Into<ReplyMarkup>,
{
let value = value.into();
self.form.insert_field("reply_markup", value.serialize()?);
Ok(self)
}
/// Sets new reply parameters.
///
/// # Arguments
///
/// * `value` - Description of the message to reply to.
pub fn with_reply_parameters(mut self, value: ReplyParameters) -> Result<Self, ReplyParametersError> {
self.form.insert_field("reply_parameters", value.serialize()?);
Ok(self)
}
}
impl Method for SendSticker {
type Response = Message;
fn into_payload(self) -> Payload {
Payload::form("sendSticker", self.form)
}
}
/// Changes the list of emoji assigned to a regular or custom emoji sticker.
///
/// The sticker must belong to a sticker set created by the bot.
#[derive(Clone, Debug, Serialize)]
pub struct SetStickerEmojiList {
sticker: String,
emoji_list: Vec<String>,
}
impl SetStickerEmojiList {
/// Creates a new `SetStickerEmojiList`.
///
/// * `sticker` - File identifier of the sticker.
/// * `emoji_list` - A list of 1-20 emoji associated with the sticker.
pub fn new<A, B, C>(sticker: A, emoji_list: B) -> Self
where
A: Into<String>,
B: IntoIterator<Item = C>,
C: Into<String>,
{
Self {
sticker: sticker.into(),
emoji_list: emoji_list.into_iter().map(Into::into).collect(),
}
}
}
impl Method for SetStickerEmojiList {
type Response = bool;
fn into_payload(self) -> Payload {
Payload::json("setStickerEmojiList", self)
}
}
/// Changes search keywords assigned to a regular or custom emoji sticker.
///
/// The sticker must belong to a sticker set created by the bot.
#[derive(Clone, Debug, Serialize)]
pub struct SetStickerKeywords {
sticker: String,
keywords: Vec<String>,
}
impl SetStickerKeywords {
/// Creates a new `SetStickerKeywords`.
///
/// * `sticker` - File identifier of the sticker.
/// * `keywords` - A list of 0-20 search keywords for the sticker
/// with total length of up to 64 characters.
pub fn new<A, B, C>(sticker: A, keywords: B) -> Self
where
A: Into<String>,
B: IntoIterator<Item = C>,
C: Into<String>,
{
Self {
sticker: sticker.into(),
keywords: keywords.into_iter().map(Into::into).collect(),
}
}
}
impl Method for SetStickerKeywords {
type Response = bool;
fn into_payload(self) -> Payload {
Payload::json("setStickerKeywords", self)
}
}
/// Changes the mask position of a mask sticker.
///
/// The sticker must belong to a sticker set created by the bot.
#[derive(Clone, Debug, Serialize)]
pub struct SetStickerMaskPosition {
sticker: String,
#[serde(skip_serializing_if = "Option::is_none")]
mask_position: Option<MaskPosition>,
}
impl SetStickerMaskPosition {
/// Creates a new `SetStickerMaskPosition`.
///
/// * `sticker` - File identifier of the sticker.
pub fn new<T>(sticker: T) -> Self
where
T: Into<String>,
{
Self {
sticker: sticker.into(),
mask_position: None,
}
}
/// Sets a new mask position.
///
/// # Arguments
///
/// * `value` - Position where the mask should be placed on faces.
///
/// Omit the parameter to remove the mask position.
pub fn with_mask_position(mut self, value: MaskPosition) -> Self {
self.mask_position = Some(value);
self
}
}
impl Method for SetStickerMaskPosition {
type Response = bool;
fn into_payload(self) -> Payload {
Payload::json("setStickerMaskPosition", self)
}
}
/// Uploads a file with a sticker for later use in
/// the [`CreateNewStickerSet`] and [`AddStickerToSet`] methods.
///
/// The file can be used multiple times.
#[derive(Debug)]
pub struct UploadStickerFile {
form: Form,
}
impl UploadStickerFile {
/// Creates a new `UploadStickerFile`.
///
/// # Arguments
///
/// * `user_id` - User identifier of sticker file owner.
/// * `sticker` - A file with the sticker in WEBP, PNG, TGS, or WEBM format.
/// * `sticker_format` - Format of the sticker.
pub fn new<T>(user_id: Integer, sticker: T, sticker_format: StickerFormat) -> Self
where
T: Into<InputFile>,
{
Self {
form: Form::from([
("user_id", user_id.into()),
("sticker", sticker.into().into()),
("sticker_format", sticker_format.as_ref().into()),
]),
}
}
}
impl Method for UploadStickerFile {
type Response = File;
fn into_payload(self) -> Payload {
Payload::form("uploadStickerFile", self.form)
}
}