1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
use crate::client::Bot;
use serde::Serialize;
/// Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise `true` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
/// # Documentation
/// <https://core.telegram.org/bots/api#editmessagecaption>
/// # Returns
/// - `crate::types::Message`
/// - `bool`
#[derive(Clone, Debug, Serialize)]
pub struct EditMessageCaption {
/// Unique identifier of the business connection on behalf of which the message to be edited was sent
#[serde(skip_serializing_if = "Option::is_none")]
pub business_connection_id: Option<Box<str>>,
/// Required if `inline_message_id` is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
#[serde(skip_serializing_if = "Option::is_none")]
pub chat_id: Option<crate::types::ChatIdKind>,
/// Required if `inline_message_id` is not specified. Identifier of the message to edit
#[serde(skip_serializing_if = "Option::is_none")]
pub message_id: Option<i64>,
/// Required if `chat_id` and `message_id` are not specified. Identifier of the inline message
#[serde(skip_serializing_if = "Option::is_none")]
pub inline_message_id: Option<Box<str>>,
/// New caption of the message, 0-1024 characters after entities parsing
#[serde(skip_serializing_if = "Option::is_none")]
pub caption: Option<Box<str>>,
/// Mode for parsing entities in the message caption. See formatting options for more details.
#[serde(skip_serializing_if = "Option::is_none")]
pub parse_mode: Option<Box<str>>,
/// A JSON-serialized list of special entities that appear in the caption, which can be specified instead of `parse_mode`
#[serde(skip_serializing_if = "Option::is_none")]
pub caption_entities: Option<Box<[crate::types::MessageEntity]>>,
/// Pass `true`, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
#[serde(skip_serializing_if = "Option::is_none")]
pub show_caption_above_media: Option<bool>,
/// A JSON-serialized object for an inline keyboard.
#[serde(skip_serializing_if = "Option::is_none")]
pub reply_markup: Option<crate::types::InlineKeyboardMarkup>,
}
impl EditMessageCaption {
/// Creates a new `EditMessageCaption`.
///
/// # Notes
/// Use builder methods to set optional fields.
#[must_use]
pub fn new() -> Self {
Self {
business_connection_id: None,
chat_id: None,
message_id: None,
inline_message_id: None,
caption: None,
parse_mode: None,
caption_entities: None,
show_caption_above_media: None,
reply_markup: None,
}
}
/// Unique identifier of the business connection on behalf of which the message to be edited was sent
#[must_use]
pub fn business_connection_id<T: Into<Box<str>>>(self, val: T) -> Self {
let mut this = self;
this.business_connection_id = Some(val.into());
this
}
/// Unique identifier of the business connection on behalf of which the message to be edited was sent
#[must_use]
pub fn business_connection_id_option<T: Into<Box<str>>>(self, val: Option<T>) -> Self {
let mut this = self;
this.business_connection_id = val.map(Into::into);
this
}
/// Required if `inline_message_id` is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
#[must_use]
pub fn chat_id<T: Into<crate::types::ChatIdKind>>(self, val: T) -> Self {
let mut this = self;
this.chat_id = Some(val.into());
this
}
/// Required if `inline_message_id` is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
#[must_use]
pub fn chat_id_option<T: Into<crate::types::ChatIdKind>>(self, val: Option<T>) -> Self {
let mut this = self;
this.chat_id = val.map(Into::into);
this
}
/// Required if `inline_message_id` is not specified. Identifier of the message to edit
#[must_use]
pub fn message_id<T: Into<i64>>(self, val: T) -> Self {
let mut this = self;
this.message_id = Some(val.into());
this
}
/// Required if `inline_message_id` is not specified. Identifier of the message to edit
#[must_use]
pub fn message_id_option<T: Into<i64>>(self, val: Option<T>) -> Self {
let mut this = self;
this.message_id = val.map(Into::into);
this
}
/// Required if `chat_id` and `message_id` are not specified. Identifier of the inline message
#[must_use]
pub fn inline_message_id<T: Into<Box<str>>>(self, val: T) -> Self {
let mut this = self;
this.inline_message_id = Some(val.into());
this
}
/// Required if `chat_id` and `message_id` are not specified. Identifier of the inline message
#[must_use]
pub fn inline_message_id_option<T: Into<Box<str>>>(self, val: Option<T>) -> Self {
let mut this = self;
this.inline_message_id = val.map(Into::into);
this
}
/// New caption of the message, 0-1024 characters after entities parsing
#[must_use]
pub fn caption<T: Into<Box<str>>>(self, val: T) -> Self {
let mut this = self;
this.caption = Some(val.into());
this
}
/// New caption of the message, 0-1024 characters after entities parsing
#[must_use]
pub fn caption_option<T: Into<Box<str>>>(self, val: Option<T>) -> Self {
let mut this = self;
this.caption = val.map(Into::into);
this
}
/// Mode for parsing entities in the message caption. See formatting options for more details.
#[must_use]
pub fn parse_mode<T: Into<Box<str>>>(self, val: T) -> Self {
let mut this = self;
this.parse_mode = Some(val.into());
this
}
/// Mode for parsing entities in the message caption. See formatting options for more details.
#[must_use]
pub fn parse_mode_option<T: Into<Box<str>>>(self, val: Option<T>) -> Self {
let mut this = self;
this.parse_mode = val.map(Into::into);
this
}
/// A JSON-serialized list of special entities that appear in the caption, which can be specified instead of `parse_mode`
///
/// # Notes
/// Adds multiple elements.
#[must_use]
pub fn caption_entities<
TItem: Into<crate::types::MessageEntity>,
T: IntoIterator<Item = TItem>,
>(
self,
val: T,
) -> Self {
let mut this = self;
this.caption_entities = Some(
this.caption_entities
.unwrap_or_default()
.into_vec()
.into_iter()
.chain(val.into_iter().map(Into::into))
.collect(),
);
this
}
/// A JSON-serialized list of special entities that appear in the caption, which can be specified instead of `parse_mode`
///
/// # Notes
/// Adds a single element.
#[must_use]
pub fn caption_entity<T: Into<crate::types::MessageEntity>>(self, val: T) -> Self {
let mut this = self;
this.caption_entities = Some(
this.caption_entities
.unwrap_or_default()
.into_vec()
.into_iter()
.chain(Some(val.into()))
.collect(),
);
this
}
/// A JSON-serialized list of special entities that appear in the caption, which can be specified instead of `parse_mode`
///
/// # Notes
/// Adds multiple elements.
#[must_use]
pub fn caption_entities_option<
TItem: Into<crate::types::MessageEntity>,
T: IntoIterator<Item = TItem>,
>(
self,
val: Option<T>,
) -> Self {
let mut this = self;
this.caption_entities = val.map(|v| v.into_iter().map(Into::into).collect());
this
}
/// Pass `true`, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
#[must_use]
pub fn show_caption_above_media<T: Into<bool>>(self, val: T) -> Self {
let mut this = self;
this.show_caption_above_media = Some(val.into());
this
}
/// Pass `true`, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
#[must_use]
pub fn show_caption_above_media_option<T: Into<bool>>(self, val: Option<T>) -> Self {
let mut this = self;
this.show_caption_above_media = val.map(Into::into);
this
}
/// A JSON-serialized object for an inline keyboard.
#[must_use]
pub fn reply_markup<T: Into<crate::types::InlineKeyboardMarkup>>(self, val: T) -> Self {
let mut this = self;
this.reply_markup = Some(val.into());
this
}
/// A JSON-serialized object for an inline keyboard.
#[must_use]
pub fn reply_markup_option<T: Into<crate::types::InlineKeyboardMarkup>>(
self,
val: Option<T>,
) -> Self {
let mut this = self;
this.reply_markup = val.map(Into::into);
this
}
}
impl Default for EditMessageCaption {
fn default() -> Self {
Self::new()
}
}
impl super::TelegramMethod for EditMessageCaption {
type Method = Self;
type Return = crate::Either<crate::types::Message, bool>;
fn build_request<Client>(self, _bot: &Bot<Client>) -> super::Request<Self::Method> {
super::Request::new("editMessageCaption", self, None)
}
}