Skip to main content

ronami_core/payloads/
send_document.rs

1//! Generated by `codegen_payloads`, do not edit by hand.
2
3use serde::Serialize;
4
5use crate::types::BusinessConnectionId;
6use crate::types::EffectId;
7use crate::types::EphemeralMessageParameters;
8use crate::types::InputFile;
9use crate::types::Message;
10use crate::types::MessageEntity;
11use crate::types::ParseMode;
12use crate::types::Recipient;
13use crate::types::ReplyMarkup;
14use crate::types::ReplyParameters;
15use crate::types::SuggestedPostParameters;
16use crate::types::ThreadId;
17use crate::types::TopicId;
18
19impl_payload! {
20    @[multipart = document, thumbnail]
21    /// Use this method to send general files. On success, the sent [`Message`] is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
22    ///
23    /// [`Message`]: crate::types::Message
24    #[derive(Debug, Clone, Serialize)]
25    pub SendDocument (SendDocumentSetters) => Message {
26        required {
27            /// Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
28            pub chat_id: Recipient [into],
29            /// File to send. Pass a file_id as FileId 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. [More info on Sending Files »]
30            ///
31            /// [More info on Sending Files »]: crate::types::InputFile
32            pub document: InputFile,
33        }
34        optional {
35            /// Unique identifier of the business connection on behalf of which the message will be sent
36            pub business_connection_id: BusinessConnectionId,
37            /// Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
38            pub message_thread_id: ThreadId,
39            /// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
40            pub direct_messages_topic_id: TopicId,
41            /// 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 info on Sending Files »]
42            ///
43            /// [More info on Sending Files »]: crate::types::InputFile
44            pub thumbnail: InputFile,
45            /// Document caption (may also be used when resending documents by _file\_id_), 0-1024 characters after entities parsing
46            pub caption: String [into],
47            /// Mode for parsing entities in the audio caption. See [formatting options] for more details.
48            ///
49            /// [formatting options]: https://core.telegram.org/bots/api#formatting-options
50            pub parse_mode: ParseMode,
51            /// List of special entities that appear in the photo caption, which can be specified instead of _parse\_mode_
52            pub caption_entities: Vec<MessageEntity> [collect],
53            /// Disables automatic server-side content type detection for files uploaded using multipart/form-data.
54            pub disable_content_type_detection: bool,
55            /// Sends the message [silently]. Users will receive a notification with no sound.
56            ///
57            /// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
58            pub disable_notification: bool,
59            /// Protects the contents of sent messages from forwarding and saving
60            pub protect_content: bool,
61            /// Pass `true` to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance
62            pub allow_paid_broadcast: bool,
63            /// Unique identifier of the message effect to be added to the message; for private chats only
64            pub message_effect_id: EffectId,
65            /// An object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
66            pub suggested_post_parameters: SuggestedPostParameters,
67            /// A JSON-serialized object containing the parameters of the ephemeral message to send
68            pub ephemeral_message_parameters: EphemeralMessageParameters,
69            /// Description of the message to reply to
70            pub reply_parameters: ReplyParameters,
71            /// Additional interface options. A JSON-serialized object for an [inline keyboard], [custom reply keyboard], instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account.
72            ///
73            /// [inline keyboard]: https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating
74            /// [custom reply keyboard]: https://core.telegram.org/bots#keyboards
75            pub reply_markup: ReplyMarkup [into],
76        }
77    }
78}