Skip to main content

ronami_core/payloads/
send_message.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::LinkPreviewOptions;
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    /// Use this method to send text messages. On success, the sent [`Message`] is returned.
21    ///
22    /// [`Message`]: crate::types::Message
23    #[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize)]
24    pub SendMessage (SendMessageSetters) => Message {
25        required {
26            /// Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
27            pub chat_id: Recipient [into],
28            /// Text of the message to be sent, 1-4096 characters after entities parsing
29            pub text: String [into],
30        }
31        optional {
32            /// Unique identifier of the business connection on behalf of which the message will be sent
33            pub business_connection_id: BusinessConnectionId,
34            /// Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
35            pub message_thread_id: ThreadId,
36            /// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
37            pub direct_messages_topic_id: TopicId,
38            /// Mode for parsing entities in the message text. See [formatting options] for more details.
39            ///
40            /// [formatting options]: https://core.telegram.org/bots/api#formatting-options
41            pub parse_mode: ParseMode,
42            /// List of special entities that appear in the message text, which can be specified instead of _parse\_mode_
43            pub entities: Vec<MessageEntity> [collect],
44            /// Link preview generation options for the message
45            pub link_preview_options: LinkPreviewOptions,
46            /// Sends the message [silently]. Users will receive a notification with no sound.
47            ///
48            /// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
49            pub disable_notification: bool,
50            /// Protects the contents of sent messages from forwarding and saving
51            pub protect_content: bool,
52            /// 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
53            pub allow_paid_broadcast: bool,
54            /// Unique identifier of the message effect to be added to the message; for private chats only
55            pub message_effect_id: EffectId,
56            /// 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.
57            pub suggested_post_parameters: SuggestedPostParameters,
58            /// A JSON-serialized object containing the parameters of the ephemeral message to send
59            pub ephemeral_message_parameters: EphemeralMessageParameters,
60            /// Description of the message to reply to
61            pub reply_parameters: ReplyParameters,
62            /// 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.
63            ///
64            /// [inline keyboard]: https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating
65            /// [custom reply keyboard]: https://core.telegram.org/bots#keyboards
66            pub reply_markup: ReplyMarkup [into],
67        }
68    }
69}