Skip to main content

teloxide_core_ng/payloads/
answer_callback_query.rs

1//! Generated by `codegen_payloads`, do not edit by hand.
2
3use serde::Serialize;
4use url::Url;
5
6use crate::types::{CallbackQueryId, True};
7
8impl_payload! {
9    /// Use this method to send answers to callback queries sent from [inline keyboards]. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
10    ///
11    /// >Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via [@Botfather] and accept the terms. Otherwise, you may use links like `t.me/your_bot?start=XXXX` that open your bot with a parameter.
12    ///
13    /// [inline keyboards]: https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating
14    /// [@Botfather]: https://t.me/botfather
15    #[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize)]
16    pub AnswerCallbackQuery (AnswerCallbackQuerySetters) => True {
17        required {
18            /// Unique identifier for the query to be answered
19            pub callback_query_id: CallbackQueryId,
20        }
21        optional {
22            /// Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
23            pub text: String [into],
24            /// If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
25            pub show_alert: bool,
26            /// URL that will be opened by the user's client. If you have created a [`Game`] and accepted the conditions via [@Botfather], specify the URL that opens your game — note that this will only work if the query comes from a _[callback\_game]_ button.
27            ///
28            /// Otherwise, you may use links like `t.me/your\_bot?start=XXXX` that open your bot with a parameter.
29            ///
30            /// [callback_game]: https://core.telegram.org/bots/api#inlinekeyboardbutton
31            /// [@Botfather]: https://t.me/botfather
32            /// [`Game`]: crate::types::Game
33            pub url: Url,
34            /// The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.
35            pub cache_time: u32,
36        }
37    }
38}