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
use super::base::{prepare_file, Request, TelegramMethod};
use crate::{
client::Bot,
types::{ChatIdKind, InputFile, Message, MessageEntity, ReplyMarkup, ReplyParameters},
};
use serde::Serialize;
use serde_with::skip_serializing_none;
/// Use this method to send general files. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
/// # Documentation
/// <https://core.telegram.org/bots/api#senddocument>
/// # Returns
/// On success, the sent [`Message`] is returned
#[skip_serializing_none]
#[derive(Debug, Clone, Hash, PartialEq, Serialize)]
pub struct SendDocument<'a> {
/// Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
pub chat_id: ChatIdKind,
/// Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
pub message_thread_id: Option<i64>,
/// File to send. Pass a `file_id` as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using `multipart/form-data`. See [`more information on Sending Files`](https://core.telegram.org/bots/api#sending-files).
pub document: InputFile<'a>,
/// Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using `multipart/form-data`. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass `attach://<file_attach_name>` if the thumbnail was uploaded using `multipart/form-data` under <file_attach_name>. [`More information on Sending Files`](https://core.telegram.org/bots/api#sending-files).
pub thumbnail: Option<InputFile<'a>>,
/// Document caption (may also be used when resending documents by `file_id`), 0-1024 characters after entities parsing
pub caption: Option<String>,
/// Mode for parsing entities in the document caption. See [`formatting options`](https://core.telegram.org/bots/api#formatting-options) for more details.
pub parse_mode: Option<String>,
/// A JSON-serialized list of special entities that appear in the caption, which can be specified instead of `parse_mode`
pub caption_entities: Option<Vec<MessageEntity>>,
/// Disables automatic server-side content type detection for files uploaded using `multipart/form-data`
pub disable_content_type_detection: Option<bool>,
/// Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound
pub disable_notification: Option<bool>,
/// Protects the contents of the sent message from forwarding and saving
pub protect_content: Option<bool>,
/// Description of the message to reply to
pub reply_parameters: Option<ReplyParameters>,
/// Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards), [custom reply keyboard](https://core.telegram.org/bots/features#keyboards), instructions to remove reply keyboard or to force a reply from the user.
pub reply_markup: Option<ReplyMarkup>,
}
impl<'a> SendDocument<'a> {
#[must_use]
pub fn new(chat_id: impl Into<ChatIdKind>, document: impl Into<InputFile<'a>>) -> Self {
Self {
chat_id: chat_id.into(),
message_thread_id: None,
document: document.into(),
thumbnail: None,
caption: None,
parse_mode: None,
caption_entities: None,
disable_content_type_detection: None,
disable_notification: None,
protect_content: None,
reply_parameters: None,
reply_markup: None,
}
}
#[must_use]
pub fn chat_id(self, val: impl Into<ChatIdKind>) -> Self {
Self {
chat_id: val.into(),
..self
}
}
#[must_use]
pub fn message_thread_id(self, val: i64) -> Self {
Self {
message_thread_id: Some(val),
..self
}
}
#[must_use]
pub fn document(self, val: impl Into<InputFile<'a>>) -> Self {
Self {
document: val.into(),
..self
}
}
#[must_use]
pub fn thumbnail(self, val: impl Into<InputFile<'a>>) -> Self {
Self {
thumbnail: Some(val.into()),
..self
}
}
#[must_use]
pub fn caption(self, val: impl Into<String>) -> Self {
Self {
caption: Some(val.into()),
..self
}
}
#[must_use]
pub fn parse_mode(self, val: impl Into<String>) -> Self {
Self {
parse_mode: Some(val.into()),
..self
}
}
#[must_use]
pub fn caption_entity(self, val: MessageEntity) -> Self {
Self {
caption_entities: Some(
self.caption_entities
.unwrap_or_default()
.into_iter()
.chain(Some(val))
.collect(),
),
..self
}
}
#[must_use]
pub fn caption_entities(self, val: impl IntoIterator<Item = MessageEntity>) -> Self {
Self {
caption_entities: Some(
self.caption_entities
.unwrap_or_default()
.into_iter()
.chain(val)
.collect(),
),
..self
}
}
#[must_use]
pub fn disable_content_type_detection(self, val: bool) -> Self {
Self {
disable_content_type_detection: Some(val),
..self
}
}
#[must_use]
pub fn disable_notification(self, val: bool) -> Self {
Self {
disable_notification: Some(val),
..self
}
}
#[must_use]
pub fn protect_content(self, val: bool) -> Self {
Self {
protect_content: Some(val),
..self
}
}
#[must_use]
pub fn reply_parameters(self, val: ReplyParameters) -> Self {
Self {
reply_parameters: Some(val),
..self
}
}
#[must_use]
pub fn reply_markup(self, val: impl Into<ReplyMarkup>) -> Self {
Self {
reply_markup: Some(val.into()),
..self
}
}
}
impl<'a> SendDocument<'a> {
#[must_use]
pub fn message_thread_id_option(self, val: Option<i64>) -> Self {
Self {
message_thread_id: val,
..self
}
}
#[must_use]
pub fn caption_option(self, val: Option<impl Into<String>>) -> Self {
Self {
caption: val.map(Into::into),
..self
}
}
#[must_use]
pub fn parse_mode_option(self, val: Option<impl Into<String>>) -> Self {
Self {
parse_mode: val.map(Into::into),
..self
}
}
#[must_use]
pub fn caption_entities_option(
self,
val: Option<impl IntoIterator<Item = MessageEntity>>,
) -> Self {
Self {
caption_entities: val.map(|val| {
self.caption_entities
.unwrap_or_default()
.into_iter()
.chain(val)
.collect()
}),
..self
}
}
#[must_use]
pub fn disable_content_type_detection_option(self, val: Option<bool>) -> Self {
Self {
disable_content_type_detection: val,
..self
}
}
#[must_use]
pub fn disable_notification_option(self, val: Option<bool>) -> Self {
Self {
disable_notification: val,
..self
}
}
#[must_use]
pub fn protect_content_option(self, val: Option<bool>) -> Self {
Self {
protect_content: val,
..self
}
}
#[must_use]
pub fn reply_parameters_option(self, val: Option<ReplyParameters>) -> Self {
Self {
reply_parameters: val,
..self
}
}
#[must_use]
pub fn reply_markup_option(self, val: Option<impl Into<ReplyMarkup>>) -> Self {
Self {
reply_markup: val.map(Into::into),
..self
}
}
}
impl<'a> TelegramMethod for SendDocument<'a> {
type Method = Self;
type Return = Message;
fn build_request<Client>(&self, _bot: &Bot<Client>) -> Request<Self::Method> {
let mut files = vec![];
prepare_file(&mut files, &self.document);
if let Some(file) = &self.thumbnail {
prepare_file(&mut files, file);
}
Request::new("sendDocument", self, Some(files.into()))
}
}
impl<'a> AsRef<SendDocument<'a>> for SendDocument<'a> {
fn as_ref(&self) -> &Self {
self
}
}