tgbot 0.48.0

A Telegram Bot library
Documentation 
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

use serde::{Deserialize, Serialize};

use crate::types::{LoginUrl, RichText, SwitchInlineQueryChosenChat, WebAppInfo};

/// Represents a style of the rich message button.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum RichMessageButtonStyle {
    /// Danger.
    Danger,
    /// Success.
    Success,
    /// Primary.
    Primary,
    /// Link.
    Link,
}

/// Represents a button in a rich message.
///
/// Exactly one of the fields other than text and style must be used to specify the type of the button.
#[serde_with::skip_serializing_none]
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct RichMessageButton {
    /// Text of the button.
    pub text: RichText,
    /// Type of the button.
    #[serde(flatten)]
    pub button_type: RichMessageButtonType,
    /// Style of the button.
    pub style: Option<RichMessageButtonStyle>,
}

impl<T> From<(T, RichMessageButtonType)> for RichMessageButton
where
    T: Into<RichText>,
{
    fn from((text, button_type): (T, RichMessageButtonType)) -> Self {
        Self {
            text: text.into(),
            button_type,
            style: None,
        }
    }
}

impl RichMessageButton {
    /// Sets a new style for the button.
    ///
    /// # Arguments
    ///
    /// * `value` - The style to set.
    pub fn with_style(mut self, value: RichMessageButtonStyle) -> Self {
        self.style = Some(value);
        self
    }
}

/// Represents a rich message button type.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum RichMessageButtonType {
    /// Data to be sent in a callaback query
    /// to the bot when the button is pressed;
    /// 1-64 bytes.
    CallbackData(String),
    /// A button that copies the specified text to the clipboard.
    CopyText {
        /// The text to be copied to the clipboard; 1-256 characters.
        text: String,
    },
    /// The button is disabled and does nothing.
    Disabled {},
    /// An HTTPs URL used to automatically authorize the user.
    ///
    /// Can be used as a replacement for the Telegram Login Widget.
    ///
    /// Not supported for ephemeral messages.
    LoginUrl(LoginUrl),
    /// Pressing the button will prompt the user to select
    /// one of their chats, open that chat and insert the bot's username
    /// and the specified inline query in the input field.
    ///
    /// May be empty, in which case just the bot's username will be inserted.
    ///
    /// Not supported for messages sent in channel direct messages chats
    /// and on behalf of a business account.
    SwitchInlineQuery(String),
    /// Pressing the button will insert the bot's username
    /// and the specified inline query in the current chat's input field.
    ///
    /// May be empty, in which case only the bot's username will be inserted.
    ///
    /// Not supported in channels and for messages sent in
    /// channel direct messages chats and on behalf of a business account.
    SwitchInlineQueryCurrentChat(String),
    /// Pressing the button will prompt the user
    /// to select one of their chats of the specified type,
    /// open that chat and insert the bot's username
    /// and the specified inline query in the input field.
    ///
    /// Not supported for messages sent in channel direct messages chats
    /// and on behalf of a business account.
    SwitchInlineQueryChosenChat(SwitchInlineQueryChosenChat),
    /// Pressing the button will insert the bot's username
    /// and the specified inline query in the current chat's input field.
    ///
    /// May be empty, in which case only the bot's username will be inserted.
    ///
    /// Not supported in channels and for messages sent in
    /// channel direct messages chats and on behalf of a business account.
    Url(String),
    /// Description of the Web App that will be
    /// launched when the user presses the button.
    ///
    /// The Web App will be able to send an arbitrary message
    /// on behalf of the user using the method AnswerWebAppQuery.
    ///
    /// Available only in private chats between a user and the bot.
    ///
    /// Not supported for the messages sent on behalf of a
    /// business account.
    WebApp(WebAppInfo),
}