Represents the content of an invoice message to be sent as the result of an inline query. More...
#include <InputInvoiceMessageContent.h>
Public Types | |
| typedef std::shared_ptr< InputInvoiceMessageContent > | Ptr |
 Public Types inherited from TgBot::InputMessageContent | |
Public Member Functions | |
| InputInvoiceMessageContent () | |
| Public Member Functions inherited from TgBot::InputMessageContent | |
Public Attributes | |
| std::string | title |
| Product name, 1-32 characters. | |
| std::string | description |
| Product description, 1-255 characters. | |
| std::string | payload |
| Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. | |
| std::string | providerToken |
| Payment provider token, obtained via Botfather. | |
| std::string | currency |
| Three-letter ISO 4217 currency code, see https://core.telegram.org/bots/payments#supported-currencies. | |
| std::vector< LabeledPrice::Ptr > | prices |
| Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) | |
| std::int32_t | maxTipAmount |
| Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in https://core.telegram.org/bots/payments/currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. | |
| std::vector< std::int32_t > | suggestedTipAmounts |
| Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed maxTipAmount. | |
| std::string | providerData |
| Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider. | |
| std::string | photoUrl |
| Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. | |
| std::int32_t | photoSize |
| Optional. Photo size. | |
| std::int32_t | photoWidth |
| Optional. Photo width. | |
| std::int32_t | photoHeight |
| Optional. Photo height. | |
| bool | needName |
| Optional. Pass True, if you require the user's full name to complete the order. | |
| bool | needPhoneNumber |
| Optional. Pass True, if you require the user's phone number to complete the order. | |
| bool | needEmail |
| Optional. Pass True, if you require the user's email address to complete the order. | |
| bool | needShippingAddress |
| Optional. Pass True, if you require the user's shipping address to complete the order. | |
| bool | sendPhoneNumberToProvider |
| Optional. Pass True, if user's phone number should be sent to provider. | |
| bool | sendEmailToProvider |
| Optional. Pass True, if user's email address should be sent to provider. | |
| bool | isFlexible |
| Optional. Pass True, if the final price depends on the shipping method. | |
| Public Attributes inherited from TgBot::InputMessageContent | |
Static Public Attributes | |
| static const std::string | TYPE |
Detailed Description
Represents the content of an invoice message to be sent as the result of an inline query.
Definition at line 19 of file InputInvoiceMessageContent.h.
Member Typedef Documentation
◆ Ptr
| typedef std::shared_ptr<InputInvoiceMessageContent> TgBot::InputInvoiceMessageContent::Ptr |
Definition at line 23 of file InputInvoiceMessageContent.h.
Constructor & Destructor Documentation
◆ InputInvoiceMessageContent()
|
inline |
Definition at line 25 of file InputInvoiceMessageContent.h.
Member Data Documentation
◆ currency
| std::string TgBot::InputInvoiceMessageContent::currency |
Three-letter ISO 4217 currency code, see https://core.telegram.org/bots/payments#supported-currencies.
Definition at line 53 of file InputInvoiceMessageContent.h.
◆ description
| std::string TgBot::InputInvoiceMessageContent::description |
Product description, 1-255 characters.
Definition at line 37 of file InputInvoiceMessageContent.h.
◆ isFlexible
| bool TgBot::InputInvoiceMessageContent::isFlexible |
Optional. Pass True, if the final price depends on the shipping method.
Definition at line 136 of file InputInvoiceMessageContent.h.
◆ maxTipAmount
| std::int32_t TgBot::InputInvoiceMessageContent::maxTipAmount |
Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in https://core.telegram.org/bots/payments/currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0.
Definition at line 66 of file InputInvoiceMessageContent.h.
◆ needEmail
| bool TgBot::InputInvoiceMessageContent::needEmail |
Optional. Pass True, if you require the user's email address to complete the order.
Definition at line 116 of file InputInvoiceMessageContent.h.
◆ needName
| bool TgBot::InputInvoiceMessageContent::needName |
Optional. Pass True, if you require the user's full name to complete the order.
Definition at line 106 of file InputInvoiceMessageContent.h.
◆ needPhoneNumber
| bool TgBot::InputInvoiceMessageContent::needPhoneNumber |
Optional. Pass True, if you require the user's phone number to complete the order.
Definition at line 111 of file InputInvoiceMessageContent.h.
◆ needShippingAddress
| bool TgBot::InputInvoiceMessageContent::needShippingAddress |
Optional. Pass True, if you require the user's shipping address to complete the order.
Definition at line 121 of file InputInvoiceMessageContent.h.
◆ payload
| std::string TgBot::InputInvoiceMessageContent::payload |
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
Definition at line 43 of file InputInvoiceMessageContent.h.
◆ photoHeight
| std::int32_t TgBot::InputInvoiceMessageContent::photoHeight |
Optional. Photo height.
Definition at line 101 of file InputInvoiceMessageContent.h.
◆ photoSize
| std::int32_t TgBot::InputInvoiceMessageContent::photoSize |
Optional. Photo size.
Definition at line 91 of file InputInvoiceMessageContent.h.
◆ photoUrl
| std::string TgBot::InputInvoiceMessageContent::photoUrl |
Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
Definition at line 86 of file InputInvoiceMessageContent.h.
◆ photoWidth
| std::int32_t TgBot::InputInvoiceMessageContent::photoWidth |
Optional. Photo width.
Definition at line 96 of file InputInvoiceMessageContent.h.
◆ prices
| std::vector<LabeledPrice::Ptr> TgBot::InputInvoiceMessageContent::prices |
Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
Definition at line 58 of file InputInvoiceMessageContent.h.
◆ providerData
| std::string TgBot::InputInvoiceMessageContent::providerData |
Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.
Definition at line 79 of file InputInvoiceMessageContent.h.
◆ providerToken
| std::string TgBot::InputInvoiceMessageContent::providerToken |
Payment provider token, obtained via Botfather.
Definition at line 48 of file InputInvoiceMessageContent.h.
◆ sendEmailToProvider
| bool TgBot::InputInvoiceMessageContent::sendEmailToProvider |
Optional. Pass True, if user's email address should be sent to provider.
Definition at line 131 of file InputInvoiceMessageContent.h.
◆ sendPhoneNumberToProvider
| bool TgBot::InputInvoiceMessageContent::sendPhoneNumberToProvider |
Optional. Pass True, if user's phone number should be sent to provider.
Definition at line 126 of file InputInvoiceMessageContent.h.
◆ suggestedTipAmounts
| std::vector<std::int32_t> TgBot::InputInvoiceMessageContent::suggestedTipAmounts |
Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed maxTipAmount.
Definition at line 73 of file InputInvoiceMessageContent.h.
◆ title
| std::string TgBot::InputInvoiceMessageContent::title |
Product name, 1-32 characters.
Definition at line 32 of file InputInvoiceMessageContent.h.
◆ TYPE
|
static |
Definition at line 21 of file InputInvoiceMessageContent.h.
The documentation for this class was generated from the following file:
- include/tgbot/types/InputInvoiceMessageContent.h
