conogram 0.2.19

An async wrapper for Telegram Bot API
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
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

use std::{
    future::{Future, IntoFuture},
    pin::Pin,
};

use serde::Serialize;

use crate::{
    api::API, entities::misc::chat_id::ChatId, errors::ConogramError, impl_into_future,
    request::RequestT,
};

#[derive(Debug, Clone, Serialize)]
pub struct SendChatActionParams {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub business_connection_id: Option<String>,
    pub chat_id: ChatId,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub message_thread_id: Option<i64>,
    pub action: SendChatActionAction,
}

impl_into_future!(SendChatActionRequest<'a>);

///Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns *True* on success.
///
///Example: The [ImageBot](https://t.me/imagebot) needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use [sendChatAction](https://core.telegram.org/bots/api/#sendchataction) with *action* = *upload\_photo*. The user will see a “sending photo” status for the bot.
///
///We only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive.
#[derive(Clone)]
pub struct SendChatActionRequest<'a> {
    api: &'a API,
    params: SendChatActionParams,
}

impl<'a> RequestT for SendChatActionRequest<'a> {
    type ParamsType = SendChatActionParams;
    type ReturnType = bool;
    fn get_name() -> &'static str {
        "sendChatAction"
    }
    fn get_api_ref(&self) -> &API {
        self.api
    }
    fn get_params_ref(&self) -> &Self::ParamsType {
        &self.params
    }
    fn is_multipart() -> bool {
        false
    }
}
impl<'a> SendChatActionRequest<'a> {
    pub fn new(
        api: &'a API,
        chat_id: impl Into<ChatId>,
        action: impl Into<SendChatActionAction>,
    ) -> Self {
        Self {
            api,
            params: SendChatActionParams {
                chat_id: chat_id.into(),
                action: action.into(),
                business_connection_id: Option::default(),
                message_thread_id: Option::default(),
            },
        }
    }

    ///Unique identifier of the business connection on behalf of which the action will be sent
    #[must_use]
    pub fn business_connection_id(mut self, business_connection_id: impl Into<String>) -> Self {
        self.params.business_connection_id = Some(business_connection_id.into());
        self
    }

    ///Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
    #[must_use]
    pub fn chat_id(mut self, chat_id: impl Into<ChatId>) -> Self {
        self.params.chat_id = chat_id.into();
        self
    }

    ///Unique identifier for the target message thread; for supergroups only
    #[must_use]
    pub fn message_thread_id(mut self, message_thread_id: impl Into<i64>) -> Self {
        self.params.message_thread_id = Some(message_thread_id.into());
        self
    }

    ///Type of action to broadcast. Choose one, depending on what the user is about to receive: *typing* for [text messages](https://core.telegram.org/bots/api/#sendmessage), *upload\_photo* for [photos](https://core.telegram.org/bots/api/#sendphoto), *record\_video* or *upload\_video* for [videos](https://core.telegram.org/bots/api/#sendvideo), *record\_voice* or *upload\_voice* for [voice notes](https://core.telegram.org/bots/api/#sendvoice), *upload\_document* for [general files](https://core.telegram.org/bots/api/#senddocument), *choose\_sticker* for [stickers](https://core.telegram.org/bots/api/#sendsticker), *find\_location* for [location data](https://core.telegram.org/bots/api/#sendlocation), *record\_video\_note* or *upload\_video\_note* for [video notes](https://core.telegram.org/bots/api/#sendvideonote).
    #[must_use]
    pub fn action(mut self, action: impl Into<SendChatActionAction>) -> Self {
        self.params.action = action.into();
        self
    }
}

impl API {
    ///Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns *True* on success.
    ///
    ///Example: The [ImageBot](https://t.me/imagebot) needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use [sendChatAction](https://core.telegram.org/bots/api/#sendchataction) with *action* = *upload\_photo*. The user will see a “sending photo” status for the bot.
    ///
    ///We only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive.
    pub fn send_chat_action(
        &self,
        chat_id: impl Into<ChatId>,
        action: impl Into<SendChatActionAction>,
    ) -> SendChatActionRequest {
        SendChatActionRequest::new(self, chat_id, action)
    }
}

///Type of action to broadcast. Choose one, depending on what the user is about to receive: *typing* for [text messages](https://core.telegram.org/bots/api/#sendmessage), *upload\_photo* for [photos](https://core.telegram.org/bots/api/#sendphoto), *record\_video* or *upload\_video* for [videos](https://core.telegram.org/bots/api/#sendvideo), *record\_voice* or *upload\_voice* for [voice notes](https://core.telegram.org/bots/api/#sendvoice), *upload\_document* for [general files](https://core.telegram.org/bots/api/#senddocument), *choose\_sticker* for [stickers](https://core.telegram.org/bots/api/#sendsticker), *find\_location* for [location data](https://core.telegram.org/bots/api/#sendlocation), *record\_video\_note* or *upload\_video\_note* for [video notes](https://core.telegram.org/bots/api/#sendvideonote).
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
#[serde(rename = "action")]
pub enum SendChatActionAction {
    #[default]
    /// "typing"
    #[serde(rename = "typing")]
    Typing,

    /// "upload_photo"
    #[serde(rename = "upload_photo")]
    UploadPhoto,

    /// "record_video"
    #[serde(rename = "record_video")]
    RecordVideo,

    /// "upload_video"
    #[serde(rename = "upload_video")]
    UploadVideo,

    /// "record_voice"
    #[serde(rename = "record_voice")]
    RecordVoice,

    /// "upload_voice"
    #[serde(rename = "upload_voice")]
    UploadVoice,

    /// "upload_document"
    #[serde(rename = "upload_document")]
    UploadDocument,

    /// "choose_sticker"
    #[serde(rename = "choose_sticker")]
    ChooseSticker,

    /// "find_location"
    #[serde(rename = "find_location")]
    FindLocation,

    /// "record_video_note"
    #[serde(rename = "record_video_note")]
    RecordVideoNote,

    /// "upload_video_note"
    #[serde(rename = "upload_video_note")]
    UploadVideoNote,
}

// Divider: all content below this line will be preserved after code regen