tgbot-cpp
Loading...
Searching...
No Matches
TgBot::PreCheckoutQuery Struct Reference

This object contains information about an incoming pre-checkout query. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<PreCheckoutQuery>

Public Attributes

std::string id { }
 Unique query identifier.
std::shared_ptr< Userfrom { }
 User who sent the query.
std::string currency { }
 Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars.
std::int32_t totalAmount { }
 Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
std::string invoicePayload { }
 Bot-specified invoice payload.
std::optional< std::string > shippingOptionId { }
 Optional. Identifier of the shipping option chosen by the user.
std::shared_ptr< OrderInfoorderInfo { }
 Optional. Order information provided by the user.

Detailed Description

This object contains information about an incoming pre-checkout query.

Definition at line 11127 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 11128 of file Types.h.

Member Data Documentation

◆ currency

std::string TgBot::PreCheckoutQuery::currency { }

Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars.

Definition at line 11143 of file Types.h.

◆ from

std::shared_ptr<User> TgBot::PreCheckoutQuery::from { }

User who sent the query.

Definition at line 11138 of file Types.h.

◆ id

std::string TgBot::PreCheckoutQuery::id { }

Unique query identifier.

Definition at line 11133 of file Types.h.

◆ invoicePayload

std::string TgBot::PreCheckoutQuery::invoicePayload { }

Bot-specified invoice payload.

Definition at line 11156 of file Types.h.

◆ orderInfo

std::shared_ptr<OrderInfo> TgBot::PreCheckoutQuery::orderInfo { }

Optional. Order information provided by the user.

Definition at line 11166 of file Types.h.

◆ shippingOptionId

std::optional<std::string> TgBot::PreCheckoutQuery::shippingOptionId { }

Optional. Identifier of the shipping option chosen by the user.

Definition at line 11161 of file Types.h.

◆ totalAmount

std::int32_t TgBot::PreCheckoutQuery::totalAmount { }

Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).

Definition at line 11151 of file Types.h.


The documentation for this struct was generated from the following file: