TgBot::TransactionPartnerUser Struct Reference

Describes a transaction with a user. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<TransactionPartnerUser>

Public Attributes
std::string	type { TYPE }
	Type of the transaction partner, always “user”
std::string	transactionType { }
	Type of the transaction, currently one of “invoice_payment” for payments via invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot, “business_account_transfer” for direct transfers from managed business accounts.
std::shared_ptr< User >	user { }
	Information about the user.
std::shared_ptr< AffiliateInfo >	affiliate { }
	Optional. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions.
std::optional< std::string >	invoicePayload { }
	Optional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions.
std::optional< std::int32_t >	subscriptionPeriod { }
	Optional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions.
std::optional< std::vector< std::shared_ptr< PaidMedia > > >	paidMedia { }
	Optional. Information about the paid media bought by the user; for “paid_media_payment” transactions only.
std::optional< std::string >	paidMediaPayload { }
	Optional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions.
std::shared_ptr< Gift >	gift { }
	Optional. The gift sent to the user by the bot; for “gift_purchase” transactions only.
std::optional< std::int32_t >	premiumSubscriptionDuration { }
	Optional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only.

Static Public Attributes
static TGBOT_API const std::string	TYPE

Detailed Description

Describes a transaction with a user.

Definition at line 14249 of file Types.h.

Member Typedef Documentation

Ptr

using TgBot::TransactionPartnerUser::Ptr = std::shared_ptr<TransactionPartnerUser>

Definition at line 14250 of file Types.h.

Member Data Documentation

affiliate

std::shared_ptr<AffiliateInfo> TgBot::TransactionPartnerUser::affiliate { }

Optional. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions.

Definition at line 14277 of file Types.h.

gift

std::shared_ptr<Gift> TgBot::TransactionPartnerUser::gift { }

Optional. The gift sent to the user by the bot; for “gift_purchase” transactions only.

Definition at line 14306 of file Types.h.

invoicePayload

std::optional<std::string> TgBot::TransactionPartnerUser::invoicePayload { }

Optional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions.

Definition at line 14283 of file Types.h.

paidMedia

std::optional<std::vector<std::shared_ptr<PaidMedia> > > TgBot::TransactionPartnerUser::paidMedia { }

Optional. Information about the paid media bought by the user; for “paid_media_payment” transactions only.

Definition at line 14295 of file Types.h.

paidMediaPayload

std::optional<std::string> TgBot::TransactionPartnerUser::paidMediaPayload { }

Optional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions.

Definition at line 14301 of file Types.h.

premiumSubscriptionDuration

std::optional<std::int32_t> TgBot::TransactionPartnerUser::premiumSubscriptionDuration { }

Optional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only.

Definition at line 14312 of file Types.h.

subscriptionPeriod

std::optional<std::int32_t> TgBot::TransactionPartnerUser::subscriptionPeriod { }

Optional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions.

Definition at line 14289 of file Types.h.

transactionType

std::string TgBot::TransactionPartnerUser::transactionType { }

Type of the transaction, currently one of “invoice_payment” for payments via invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot, “business_account_transfer” for direct transfers from managed business accounts.

Definition at line 14265 of file Types.h.

TYPE

TGBOT_API const std::string TgBot::TransactionPartnerUser::TYPE

static

Definition at line 14252 of file Types.h.

type

std::string TgBot::TransactionPartnerUser::type { TYPE }

Type of the transaction partner, always “user”

Definition at line 14257 of file Types.h.

user

std::shared_ptr<User> TgBot::TransactionPartnerUser::user { }

Information about the user.

Definition at line 14270 of file Types.h.

---

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

• include/tgbot/Types.h