teloxide_core/payloads/
send_photo.rs

1//! Generated by `codegen_payloads`, do not edit by hand.
2
3use serde::Serialize;
4
5use crate::types::{
6    BusinessConnectionId, EffectId, InputFile, Message, MessageEntity, ParseMode, Recipient,
7    ReplyMarkup, ReplyParameters, ThreadId,
8};
9
10impl_payload! {
11    @[multipart = photo]
12    /// Use this method to send photos. On success, the sent [`Message`] is returned.
13    ///
14    /// [`Message`]: crate::types::Message
15    #[derive(Debug, Clone, Serialize)]
16    pub SendPhoto (SendPhotoSetters) => Message {
17        required {
18            /// Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
19            pub chat_id: Recipient [into],
20            /// Photo to send. Pass a file_id as FileId to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. [More info on Sending Files »]
21            ///
22            /// [More info on Sending Files »]: crate::types::InputFile
23            pub photo: InputFile,
24        }
25        optional {
26            /// Unique identifier of the business connection on behalf of which the message will be sent
27            pub business_connection_id: BusinessConnectionId,
28            /// Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
29            pub message_thread_id: ThreadId,
30            /// Photo caption (may also be used when resending photos by _file\_id_), 0-1024 characters after entities parsing
31            pub caption: String [into],
32            /// Mode for parsing entities in the photo caption. See [formatting options] for more details.
33            ///
34            /// [formatting options]: https://core.telegram.org/bots/api#formatting-options
35            pub parse_mode: ParseMode,
36            /// List of special entities that appear in the photo caption, which can be specified instead of _parse\_mode_
37            pub caption_entities: Vec<MessageEntity> [collect],
38            /// Pass True, if the caption must be shown above the message media
39            pub show_caption_above_media: bool,
40            /// Pass True if the photo needs to be covered with a spoiler animation
41            pub has_spoiler: bool,
42            /// Sends the message [silently]. Users will receive a notification with no sound.
43            ///
44            /// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
45            pub disable_notification: bool,
46            /// Protects the contents of sent messages from forwarding and saving
47            pub protect_content: bool,
48            /// 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
49            pub allow_paid_broadcast: bool,
50            /// Unique identifier of the message effect to be added to the message; for private chats only
51            pub message_effect_id: EffectId,
52            /// Description of the message to reply to
53            pub reply_parameters: ReplyParameters,
54            /// 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.
55            ///
56            /// [inline keyboard]: https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating
57            /// [custom reply keyboard]: https://core.telegram.org/bots#keyboards
58            pub reply_markup: ReplyMarkup [into],
59        }
60    }
61}