Describes a transaction with a user. More...

#include <TransactionPartner.hpp>

Inheritance diagram for tgbotxx::TransactionPartnerUser:

Public Member Functions
	TransactionPartnerUser ()

	TransactionPartnerUser (const nl::json &json)

nl::json	toJson () const override
	Serializes this object to JSON.

void	fromJson (const nl::json &json) override
	Deserializes this object from JSON.

Public Member Functions inherited from tgbotxx::TransactionPartner
	TransactionPartner ()=default

	TransactionPartner (const nl::json &json)

virtual	~TransactionPartner ()=default

Public Attributes
std::string	transactionType
	Type of the transaction, e.g., "invoice_payment", "paid_media_payment", etc.

Ptr< User >	user
	Information about the user.

Ptr< AffiliateInfo >	affiliate
	Optional. Affiliate that received a commission via this transaction.

std::string	invoicePayload
	Optional. Bot-specified invoice payload.

std::int32_t	subscriptionPeriod {}
	Optional. Duration of paid subscription.

std::vector< Ptr< PaidMedia > >	paidMedia
	Optional. Information about the paid media bought by the user.

std::string	paidMediaPayload
	Optional. Bot-specified paid media payload.

Ptr< Gift >	gift
	Optional. Gift sent to the user by the bot.

std::int32_t	premiumSubscriptionDuration {}
	Optional. Number of months for gifted Telegram Premium subscription.

Public Attributes inherited from tgbotxx::TransactionPartner
std::string	type
	Type of the transaction partner.

Detailed Description

Describes a transaction with a user.

Definition at line 46 of file TransactionPartner.hpp.

Constructor & Destructor Documentation

◆ TransactionPartnerUser() [1/2]

tgbotxx::TransactionPartnerUser::TransactionPartnerUser ( )

inline

Definition at line 47 of file TransactionPartner.hpp.

◆ TransactionPartnerUser() [2/2]

tgbotxx::TransactionPartnerUser::TransactionPartnerUser ( const nl::json & json )

inlineexplicit

Definition at line 50 of file TransactionPartner.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::TransactionPartnerUser::fromJson ( const nl::json & json )

inlineoverridevirtual

Deserializes this object from JSON.

Reimplemented from tgbotxx::TransactionPartner.

Definition at line 98 of file TransactionPartner.hpp.

◆ toJson()

nl::json tgbotxx::TransactionPartnerUser::toJson ( ) const

inlineoverridevirtual

Serializes this object to JSON.

Returns: JSON representation of this object

Reimplemented from tgbotxx::TransactionPartner.

Definition at line 83 of file TransactionPartner.hpp.

Member Data Documentation

◆ affiliate

Ptr<AffiliateInfo> tgbotxx::TransactionPartnerUser::affiliate

Optional. Affiliate that received a commission via this transaction.

Definition at line 61 of file TransactionPartner.hpp.

◆ gift

Ptr<Gift> tgbotxx::TransactionPartnerUser::gift

Optional. Gift sent to the user by the bot.

Definition at line 76 of file TransactionPartner.hpp.

◆ invoicePayload

std::string tgbotxx::TransactionPartnerUser::invoicePayload

Optional. Bot-specified invoice payload.

Definition at line 64 of file TransactionPartner.hpp.

◆ paidMedia

std::vector<Ptr<PaidMedia> > tgbotxx::TransactionPartnerUser::paidMedia

Optional. Information about the paid media bought by the user.

Definition at line 70 of file TransactionPartner.hpp.

◆ paidMediaPayload

std::string tgbotxx::TransactionPartnerUser::paidMediaPayload

Optional. Bot-specified paid media payload.

Definition at line 73 of file TransactionPartner.hpp.

◆ premiumSubscriptionDuration

std::int32_t tgbotxx::TransactionPartnerUser::premiumSubscriptionDuration {}

Optional. Number of months for gifted Telegram Premium subscription.

Definition at line 79 of file TransactionPartner.hpp.

◆ subscriptionPeriod

std::int32_t tgbotxx::TransactionPartnerUser::subscriptionPeriod {}

Optional. Duration of paid subscription.

Definition at line 67 of file TransactionPartner.hpp.

◆ transactionType

std::string tgbotxx::TransactionPartnerUser::transactionType

Type of the transaction, e.g., "invoice_payment", "paid_media_payment", etc.

Definition at line 55 of file TransactionPartner.hpp.

◆ user

Ptr<User> tgbotxx::TransactionPartnerUser::user

Information about the user.

Definition at line 58 of file TransactionPartner.hpp.

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

include/tgbotxx/objects/TransactionPartner.hpp

Public Member Functions

Public Attributes