From 3e5a28fa0a1ba2d461271f22399476c241bcffe3 Mon Sep 17 00:00:00 2001 From: JellyBrick Date: Fri, 22 Jun 2018 22:15:42 +0900 Subject: Regenerate docs --- docs/class_tg_bot_1_1_successful_payment.html | 302 ++++++++++++++++++++++++++ 1 file changed, 302 insertions(+) create mode 100644 docs/class_tg_bot_1_1_successful_payment.html (limited to 'docs/class_tg_bot_1_1_successful_payment.html') diff --git a/docs/class_tg_bot_1_1_successful_payment.html b/docs/class_tg_bot_1_1_successful_payment.html new file mode 100644 index 0000000..1adc01f --- /dev/null +++ b/docs/class_tg_bot_1_1_successful_payment.html @@ -0,0 +1,302 @@ + + + + + + +tgbot-cpp: TgBot::SuccessfulPayment Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
TgBot::SuccessfulPayment Class Reference
+
+
+ +

This object contains basic information about a successful payment. + More...

+ +

#include <SuccessfulPayment.h>

+ + + + +

+Public Types

typedef std::shared_ptr< SuccessfulPaymentPtr
 
+ + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

std::string currency
 Three-letter ISO 4217 currency code. More...
 
int32_t totalAmount
 Total price in the smallest units of the currency (integer, not float/double). More...
 
std::string invoicePayload
 Bot specified invoice payload. More...
 
std::string shippingOptionId
 Optional. Identifier of the shipping option chosen by the user. More...
 
OrderInfo::Ptr orderInfo
 Optional. Order info provided by the user. More...
 
std::string telegramPaymentChargeId
 Telegram payment identifier. More...
 
std::string providerPaymentChargeId
 Provider payment identifier. More...
 
+

Detailed Description

+

This object contains basic information about a successful payment.

+

https://core.telegram.org/bots/api#successfulpayment

+ +

Definition at line 41 of file SuccessfulPayment.h.

+

Member Typedef Documentation

+ +
+
+ + + + +
typedef std::shared_ptr<SuccessfulPayment> TgBot::SuccessfulPayment::Ptr
+
+ +

Definition at line 43 of file SuccessfulPayment.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
std::string TgBot::SuccessfulPayment::currency
+
+ +

Three-letter ISO 4217 currency code.

+ +

Definition at line 48 of file SuccessfulPayment.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::SuccessfulPayment::invoicePayload
+
+ +

Bot specified invoice payload.

+ +

Definition at line 66 of file SuccessfulPayment.h.

+ +
+
+ +
+
+ + + + +
OrderInfo::Ptr TgBot::SuccessfulPayment::orderInfo
+
+ +

Optional. Order info provided by the user.

+ +

Definition at line 76 of file SuccessfulPayment.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::SuccessfulPayment::providerPaymentChargeId
+
+ +

Provider payment identifier.

+ +

Definition at line 86 of file SuccessfulPayment.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::SuccessfulPayment::shippingOptionId
+
+ +

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

+ +

Definition at line 71 of file SuccessfulPayment.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::SuccessfulPayment::telegramPaymentChargeId
+
+ +

Telegram payment identifier.

+ +

Definition at line 81 of file SuccessfulPayment.h.

+ +
+
+ +
+
+ + + + +
int32_t TgBot::SuccessfulPayment::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).

+

https://core.telegram.org/bots/payments/currencies.json

+ +

Definition at line 61 of file SuccessfulPayment.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.3