tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::invoice Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::invoice:
td::td_api::Object td::TlObject

Public Member Functions

 invoice ()
 
 invoice (string const &currency_, array< object_ptr< labeledPricePart > > &&price_parts_, int32 subscription_period_, int53 max_tip_amount_, array< int53 > &&suggested_tip_amounts_, string const &recurring_payment_terms_of_service_url_, string const &terms_of_service_url_, bool is_test_, bool need_name_, bool need_phone_number_, bool need_email_address_, bool need_shipping_address_, bool send_phone_number_to_provider_, bool send_email_address_to_provider_, bool is_flexible_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

string currency_
 ISO 4217 currency code.
 
array< object_ptr< labeledPricePart > > price_parts_
 A list of objects used to calculate the total price of the product.
 
int32 subscription_period_
 The number of seconds between consecutive Telegram Star debiting for subscription invoices; 0 if the invoice doesn&#x27;t create subscription.
 
int53 max_tip_amount_
 The maximum allowed amount of tip in the smallest units of the currency.
 
array< int53suggested_tip_amounts_
 Suggested amounts of tip in the smallest units of the currency.
 
string recurring_payment_terms_of_service_url_
 An HTTP URL with terms of service for recurring payments. If non-empty, the invoice payment will result in recurring payments and the user must accept the terms of service before allowed to pay.
 
string terms_of_service_url_
 An HTTP URL with terms of service for non-recurring payments. If non-empty, then the user must accept the terms of service before allowed to pay.
 
bool is_test_
 True, if the payment is a test payment.
 
bool need_name_
 True, if the user&#x27;s name is needed for payment.
 
bool need_phone_number_
 True, if the user&#x27;s phone number is needed for payment.
 
bool need_email_address_
 True, if the user&#x27;s email address is needed for payment.
 
bool need_shipping_address_
 True, if the user&#x27;s shipping address is needed for payment.
 
bool send_phone_number_to_provider_
 True, if the user&#x27;s phone number will be sent to the provider.
 
bool send_email_address_to_provider_
 True, if the user&#x27;s email address will be sent to the provider.
 
bool is_flexible_
 True, if the total price depends on the shipping method.
 

Static Public Attributes

static const std::int32_t ID = 113204876
 Identifier uniquely determining a type of the object.
 

Detailed Description

Product invoice.

Definition at line 34698 of file td_api.h.

Constructor & Destructor Documentation

◆ invoice() [1/2]

td::td_api::invoice::invoice ( )

Product invoice.

◆ invoice() [2/2]

td::td_api::invoice::invoice ( string const &  currency_,
array< object_ptr< labeledPricePart > > &&  price_parts_,
int32  subscription_period_,
int53  max_tip_amount_,
array< int53 > &&  suggested_tip_amounts_,
string const &  recurring_payment_terms_of_service_url_,
string const &  terms_of_service_url_,
bool  is_test_,
bool  need_name_,
bool  need_phone_number_,
bool  need_email_address_,
bool  need_shipping_address_,
bool  send_phone_number_to_provider_,
bool  send_email_address_to_provider_,
bool  is_flexible_ 
)

Product invoice.

Parameters
[in]currency_ISO 4217 currency code.
[in]price_parts_A list of objects used to calculate the total price of the product.
[in]subscription_period_The number of seconds between consecutive Telegram Star debiting for subscription invoices; 0 if the invoice doesn&#x27;t create subscription.
[in]max_tip_amount_The maximum allowed amount of tip in the smallest units of the currency.
[in]suggested_tip_amounts_Suggested amounts of tip in the smallest units of the currency.
[in]recurring_payment_terms_of_service_url_An HTTP URL with terms of service for recurring payments. If non-empty, the invoice payment will result in recurring payments and the user must accept the terms of service before allowed to pay.
[in]terms_of_service_url_An HTTP URL with terms of service for non-recurring payments. If non-empty, then the user must accept the terms of service before allowed to pay.
[in]is_test_True, if the payment is a test payment.
[in]need_name_True, if the user&#x27;s name is needed for payment.
[in]need_phone_number_True, if the user&#x27;s phone number is needed for payment.
[in]need_email_address_True, if the user&#x27;s email address is needed for payment.
[in]need_shipping_address_True, if the user&#x27;s shipping address is needed for payment.
[in]send_phone_number_to_provider_True, if the user&#x27;s phone number will be sent to the provider.
[in]send_email_address_to_provider_True, if the user&#x27;s email address will be sent to the provider.
[in]is_flexible_True, if the total price depends on the shipping method.

Member Function Documentation

◆ store()

void td::td_api::invoice::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.

Member Data Documentation

◆ currency_

string td::td_api::invoice::currency_

ISO 4217 currency code.

Definition at line 34709 of file td_api.h.

◆ ID

const std::int32_t td::td_api::invoice::ID = 113204876
static

Identifier uniquely determining a type of the object.

Definition at line 34766 of file td_api.h.

◆ is_flexible_

bool td::td_api::invoice::is_flexible_

True, if the total price depends on the shipping method.

Definition at line 34737 of file td_api.h.

◆ is_test_

bool td::td_api::invoice::is_test_

True, if the payment is a test payment.

Definition at line 34723 of file td_api.h.

◆ max_tip_amount_

int53 td::td_api::invoice::max_tip_amount_

The maximum allowed amount of tip in the smallest units of the currency.

Definition at line 34715 of file td_api.h.

◆ need_email_address_

bool td::td_api::invoice::need_email_address_

True, if the user&#x27;s email address is needed for payment.

Definition at line 34729 of file td_api.h.

◆ need_name_

bool td::td_api::invoice::need_name_

True, if the user&#x27;s name is needed for payment.

Definition at line 34725 of file td_api.h.

◆ need_phone_number_

bool td::td_api::invoice::need_phone_number_

True, if the user&#x27;s phone number is needed for payment.

Definition at line 34727 of file td_api.h.

◆ need_shipping_address_

bool td::td_api::invoice::need_shipping_address_

True, if the user&#x27;s shipping address is needed for payment.

Definition at line 34731 of file td_api.h.

◆ price_parts_

array<object_ptr<labeledPricePart> > td::td_api::invoice::price_parts_

A list of objects used to calculate the total price of the product.

Definition at line 34711 of file td_api.h.

◆ recurring_payment_terms_of_service_url_

string td::td_api::invoice::recurring_payment_terms_of_service_url_

An HTTP URL with terms of service for recurring payments. If non-empty, the invoice payment will result in recurring payments and the user must accept the terms of service before allowed to pay.

Definition at line 34719 of file td_api.h.

◆ send_email_address_to_provider_

bool td::td_api::invoice::send_email_address_to_provider_

True, if the user&#x27;s email address will be sent to the provider.

Definition at line 34735 of file td_api.h.

◆ send_phone_number_to_provider_

bool td::td_api::invoice::send_phone_number_to_provider_

True, if the user&#x27;s phone number will be sent to the provider.

Definition at line 34733 of file td_api.h.

◆ subscription_period_

int32 td::td_api::invoice::subscription_period_

The number of seconds between consecutive Telegram Star debiting for subscription invoices; 0 if the invoice doesn&#x27;t create subscription.

Definition at line 34713 of file td_api.h.

◆ suggested_tip_amounts_

array<int53> td::td_api::invoice::suggested_tip_amounts_

Suggested amounts of tip in the smallest units of the currency.

Definition at line 34717 of file td_api.h.

◆ terms_of_service_url_

string td::td_api::invoice::terms_of_service_url_

An HTTP URL with terms of service for non-recurring payments. If non-empty, then the user must accept the terms of service before allowed to pay.

Definition at line 34721 of file td_api.h.


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