teloxide_core/payloads/
send_video.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, Seconds, ThreadId,
8};
9
10impl_payload! {
11    @[multipart = video, thumbnail, cover]
12    /// Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as [`Document`]). On success, the sent [`Message`] is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
13    ///
14    /// [`Document`]: crate::types::Document
15    /// [`Message`]: crate::types::Message
16    #[derive(Debug, Clone, Serialize)]
17    pub SendVideo (SendVideoSetters) => Message {
18        required {
19            /// Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
20            pub chat_id: Recipient [into],
21            /// Video to send. Pass a file_id as FileId to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. [More info on Sending Files »]
22            ///
23            /// [More info on Sending Files »]: crate::types::InputFile
24            pub video: InputFile,
25        }
26        optional {
27            /// Unique identifier of the business connection on behalf of which the message will be sent
28            pub business_connection_id: BusinessConnectionId,
29            /// Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
30            pub message_thread_id: ThreadId,
31            /// Duration of the video in seconds
32            pub duration: u32,
33            /// Video width
34            pub width: u32,
35            /// Video height
36            pub height: u32,
37            /// 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 »]
38            ///
39            /// [More info on Sending Files »]: crate::types::InputFile
40            pub thumbnail: InputFile,
41            /// Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. [More information on Sending Files »]
42            ///
43            /// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
44            pub cover: InputFile,
45            /// Start timestamp for the video in the message
46            pub start_timestamp: Seconds,
47            /// Video caption (may also be used when resending videos by _file\_id_), 0-1024 characters after entities parsing
48            pub caption: String [into],
49            /// Mode for parsing entities in the video caption. See [formatting options] for more details.
50            ///
51            /// [formatting options]: https://core.telegram.org/bots/api#formatting-options
52            pub parse_mode: ParseMode,
53            /// List of special entities that appear in the caption, which can be specified instead of _parse\_mode_
54            pub caption_entities: Vec<MessageEntity> [collect],
55            /// Pass True, if the caption must be shown above the message media
56            pub show_caption_above_media: bool,
57            /// Pass True if the video needs to be covered with a spoiler animation
58            pub has_spoiler: bool,
59            /// Pass _True_, if the uploaded video is suitable for streaming
60            pub supports_streaming: bool,
61            /// Sends the message [silently]. Users will receive a notification with no sound.
62            ///
63            /// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
64            pub disable_notification: bool,
65            /// Protects the contents of sent messages from forwarding and saving
66            pub protect_content: bool,
67            /// 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
68            pub allow_paid_broadcast: bool,
69            /// Unique identifier of the message effect to be added to the message; for private chats only
70            pub message_effect_id: EffectId,
71            /// Description of the message to reply to
72            pub reply_parameters: ReplyParameters,
73            /// 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.
74            ///
75            /// [inline keyboard]: https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating
76            /// [custom reply keyboard]: https://core.telegram.org/bots#keyboards
77            pub reply_markup: ReplyMarkup [into],
78        }
79    }
80}