Struct tgbot::types::CallbackQuery

pub struct CallbackQuery {
    pub from: User,
    pub id: String,
    pub chat_instance: Option<String>,
    pub data: Option<String>,
    pub game_short_name: Option<String>,
    pub inline_message_id: Option<String>,
    pub message: Option<MaybeInaccessibleMessage>,
}

Represents an incoming callback query from a callback button in an inline keyboard.

If the button that originated the query was attached to a message sent by the bot, the field message will be present.

If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present.

Exactly one of the fields data or game_short_name will be present.

Fields

from: User

Sender of the query.

id: String

Unique identifier of the query.

chat_instance: Option<String>

Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent.

Useful for high scores in games.

data: Option<String>

Data associated with the callback button.

Be aware that a bad client can send arbitrary data in this field.

game_short_name: Option<String>

Short name of a Game to be returned, serves as the unique identifier for the game.

inline_message_id: Option<String>

Identifier of the message sent via the bot in inline mode, that originated the query.

message: Option<MaybeInaccessibleMessage>

Message with the callback button that originated the query.

Note that message content and message date will not be available if the message is too old.

Implementations

impl CallbackQuery

pub fn new<T>(id: T, from: User) -> Self

where T: Into<String>,

Creates a new CallbackQuery.

Arguments

• id - Unique identifier of the query.
• from - Sender of the query.

pub fn parse_data<T: DeserializeOwned>( &self ) -> Result<Option<T>, CallbackQueryError>

Parses callback data using serde_json.

pub fn with_chat_instance<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new chat instance.

Arguments

• value - Global identifier, uniquely corresponding to the chat.

pub fn with_data<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new data for callback button.

Arguments

• value - Data associated with the callback button.

pub fn with_game_short_name<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new short name for a game.

Arguments

• value - Short name of the game.

pub fn with_inline_message_id<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new inline message ID.

Arguments

• value - Identifier of the message sent via the bot in inline mode.

pub fn with_message(self, value: MaybeInaccessibleMessage) -> Self

Sets a new message.

Arguments

• value - Message with the callback button that originated the query.

Trait Implementations

impl Clone for CallbackQuery

fn clone(&self) -> CallbackQuery

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CallbackQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallbackQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CallbackQuery

fn eq(&self, other: &CallbackQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CallbackQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Update> for CallbackQuery

type Error = UnexpectedUpdate

The type returned in the event of a conversion error.

fn try_from(value: Update) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for CallbackQuery