ronami_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, CallbackQueryId, EffectId, InputFile, Message, MessageEntity, ParseMode,
7 Recipient, ReplyMarkup, ReplyParameters, Seconds, SuggestedPostParameters, ThreadId, TopicId,
8 UserId,
9};
10
11impl_payload! {
12 @[multipart = video, thumbnail, cover]
13 /// 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.
14 ///
15 /// [`Document`]: crate::types::Document
16 /// [`Message`]: crate::types::Message
17 #[derive(Debug, Clone, Serialize)]
18 pub SendVideo (SendVideoSetters) => Message {
19 required {
20 /// Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
21 pub chat_id: Recipient [into],
22 /// 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 »]
23 ///
24 /// [More info on Sending Files »]: crate::types::InputFile
25 pub video: InputFile,
26 }
27 optional {
28 /// Unique identifier of the business connection on behalf of which the message will be sent
29 pub business_connection_id: BusinessConnectionId,
30 /// Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
31 pub message_thread_id: ThreadId,
32 /// Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
33 pub direct_messages_topic_id: TopicId,
34 /// Duration of the video in seconds
35 pub duration: u32,
36 /// Video width
37 pub width: u32,
38 /// Video height
39 pub height: u32,
40 /// 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 »]
41 ///
42 /// [More info on Sending Files »]: crate::types::InputFile
43 pub thumbnail: InputFile,
44 /// 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 »]
45 ///
46 /// [More information on Sending Files »]: https://core.telegram.org/bots/api#sending-files
47 pub cover: InputFile,
48 /// Start timestamp for the video in the message
49 pub start_timestamp: Seconds,
50 /// Video caption (may also be used when resending videos by _file\_id_), 0-1024 characters after entities parsing
51 pub caption: String [into],
52 /// Mode for parsing entities in the video caption. See [formatting options] for more details.
53 ///
54 /// [formatting options]: https://core.telegram.org/bots/api#formatting-options
55 pub parse_mode: ParseMode,
56 /// List of special entities that appear in the caption, which can be specified instead of _parse\_mode_
57 pub caption_entities: Vec<MessageEntity> [collect],
58 /// Pass True, if the caption must be shown above the message media
59 pub show_caption_above_media: bool,
60 /// Pass True if the video needs to be covered with a spoiler animation
61 pub has_spoiler: bool,
62 /// Pass _True_, if the uploaded video is suitable for streaming
63 pub supports_streaming: bool,
64 /// Sends the message [silently]. Users will receive a notification with no sound.
65 ///
66 /// [silently]: https://telegram.org/blog/channels-2-0#silent-messages
67 pub disable_notification: bool,
68 /// Protects the contents of sent messages from forwarding and saving
69 pub protect_content: bool,
70 /// 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
71 pub allow_paid_broadcast: bool,
72 /// Unique identifier of the message effect to be added to the message; for private chats only
73 pub message_effect_id: EffectId,
74 /// 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.
75 pub suggested_post_parameters: SuggestedPostParameters,
76 /// Identifier of the user who received the message
77 pub receiver_user_id: UserId,
78 /// Unique identifier of the query to be answered
79 pub callback_query_id: CallbackQueryId,
80 /// Description of the message to reply to
81 pub reply_parameters: ReplyParameters,
82 /// 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.
83 ///
84 /// [inline keyboard]: https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating
85 /// [custom reply keyboard]: https://core.telegram.org/bots#keyboards
86 pub reply_markup: ReplyMarkup [into],
87 }
88 }
89}