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::sendGiftPurchaseOffer Class Referencefinal

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

Inheritance diagram for td::td_api::sendGiftPurchaseOffer:
td::td_api::Function td::TlObject

Public Types

using ReturnType = object_ptr< ok >
 Typedef for the type returned by the function.
 

Public Member Functions

 sendGiftPurchaseOffer ()
 
 sendGiftPurchaseOffer (object_ptr< MessageSender > &&owner_id_, string const &gift_name_, object_ptr< GiftResalePrice > &&price_, int32 duration_, int53 paid_message_star_count_)
 
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

object_ptr< MessageSenderowner_id_
 Identifier of the user or the channel chat that currently owns the gift and will receive the offer.
 
string gift_name_
 Name of the upgraded gift.
 
object_ptr< GiftResalePriceprice_
 The price that the user agreed to pay for the gift.
 
int32 duration_
 Duration of the offer, in seconds; must be one of 21600, 43200, 86400, 129600, 172800, or 259200. Can also be 120 if Telegram test environment is used.
 
int53 paid_message_star_count_
 The number of Telegram Stars the user agreed to pay additionally for sending of the offer message to the current gift owner; pass userFullInfo.outgoing_paid_message_star_count for users and 0 otherwise.
 

Static Public Attributes

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

Detailed Description

Sends an offer to purchase an upgraded gift.

Returns object_ptr<Ok>.

Definition at line 126102 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 126147 of file td_api.h.

Constructor & Destructor Documentation

◆ sendGiftPurchaseOffer() [1/2]

td::td_api::sendGiftPurchaseOffer::sendGiftPurchaseOffer ( )

Default constructor for a function, which sends an offer to purchase an upgraded gift.

Returns object_ptr<Ok>.

◆ sendGiftPurchaseOffer() [2/2]

td::td_api::sendGiftPurchaseOffer::sendGiftPurchaseOffer ( object_ptr< MessageSender > &&  owner_id_,
string const &  gift_name_,
object_ptr< GiftResalePrice > &&  price_,
int32  duration_,
int53  paid_message_star_count_ 
)

Creates a function, which sends an offer to purchase an upgraded gift.

Returns object_ptr<Ok>.

Parameters
[in]owner_id_Identifier of the user or the channel chat that currently owns the gift and will receive the offer.
[in]gift_name_Name of the upgraded gift.
[in]price_The price that the user agreed to pay for the gift.
[in]duration_Duration of the offer, in seconds; must be one of 21600, 43200, 86400, 129600, 172800, or 259200. Can also be 120 if Telegram test environment is used.
[in]paid_message_star_count_The number of Telegram Stars the user agreed to pay additionally for sending of the offer message to the current gift owner; pass userFullInfo.outgoing_paid_message_star_count for users and 0 otherwise.

Member Function Documentation

◆ store()

void td::td_api::sendGiftPurchaseOffer::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

◆ duration_

int32 td::td_api::sendGiftPurchaseOffer::duration_

Duration of the offer, in seconds; must be one of 21600, 43200, 86400, 129600, 172800, or 259200. Can also be 120 if Telegram test environment is used.

Definition at line 126119 of file td_api.h.

◆ gift_name_

string td::td_api::sendGiftPurchaseOffer::gift_name_

Name of the upgraded gift.

Definition at line 126115 of file td_api.h.

◆ ID

const std::int32_t td::td_api::sendGiftPurchaseOffer::ID = 917878931
static

Identifier uniquely determining a type of the object.

Definition at line 126144 of file td_api.h.

◆ owner_id_

object_ptr<MessageSender> td::td_api::sendGiftPurchaseOffer::owner_id_

Identifier of the user or the channel chat that currently owns the gift and will receive the offer.

Definition at line 126113 of file td_api.h.

◆ paid_message_star_count_

int53 td::td_api::sendGiftPurchaseOffer::paid_message_star_count_

The number of Telegram Stars the user agreed to pay additionally for sending of the offer message to the current gift owner; pass userFullInfo.outgoing_paid_message_star_count for users and 0 otherwise.

Definition at line 126121 of file td_api.h.

◆ price_

object_ptr<GiftResalePrice> td::td_api::sendGiftPurchaseOffer::price_

The price that the user agreed to pay for the gift.

Definition at line 126117 of file td_api.h.


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