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

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

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

Public Types

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

Public Member Functions

 searchGiftsForResale ()
 
 searchGiftsForResale (int64 gift_id_, object_ptr< GiftForResaleOrder > &&order_, bool for_crafting_, bool for_stars_, array< object_ptr< UpgradedGiftAttributeId > > &&attributes_, string const &offset_, int32 limit_)
 
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

int64 gift_id_
 Identifier of the regular gift that was upgraded to a unique gift.
 
object_ptr< GiftForResaleOrderorder_
 Order in which the results will be sorted.
 
bool for_crafting_
 Pass true to get only gifts suitable for crafting.
 
bool for_stars_
 Pass true to get only gifts that can be bought using Telegram Stars.
 
array< object_ptr< UpgradedGiftAttributeId > > attributes_
 Attributes used to filter received gifts. If multiple attributes of the same type are specified, then all of them are allowed. If none attributes of specific type are specified, then all values for this attribute type are allowed.
 
string offset_
 Offset of the first entry to return as received from the previous request with the same order and attributes; use empty string to get the first chunk of results.
 
int32 limit_
 The maximum number of gifts to return.
 

Static Public Attributes

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

Detailed Description

Returns upgraded gifts that can be bought from other owners using sendResoldGift.

Returns object_ptr<GiftsForResale>.

Definition at line 123998 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 124049 of file td_api.h.

Constructor & Destructor Documentation

◆ searchGiftsForResale() [1/2]

td::td_api::searchGiftsForResale::searchGiftsForResale ( )

Default constructor for a function, which returns upgraded gifts that can be bought from other owners using sendResoldGift.

Returns object_ptr<GiftsForResale>.

◆ searchGiftsForResale() [2/2]

td::td_api::searchGiftsForResale::searchGiftsForResale ( int64  gift_id_,
object_ptr< GiftForResaleOrder > &&  order_,
bool  for_crafting_,
bool  for_stars_,
array< object_ptr< UpgradedGiftAttributeId > > &&  attributes_,
string const &  offset_,
int32  limit_ 
)

Creates a function, which returns upgraded gifts that can be bought from other owners using sendResoldGift.

Returns object_ptr<GiftsForResale>.

Parameters
[in]gift_id_Identifier of the regular gift that was upgraded to a unique gift.
[in]order_Order in which the results will be sorted.
[in]for_crafting_Pass true to get only gifts suitable for crafting.
[in]for_stars_Pass true to get only gifts that can be bought using Telegram Stars.
[in]attributes_Attributes used to filter received gifts. If multiple attributes of the same type are specified, then all of them are allowed. If none attributes of specific type are specified, then all values for this attribute type are allowed.
[in]offset_Offset of the first entry to return as received from the previous request with the same order and attributes; use empty string to get the first chunk of results.
[in]limit_The maximum number of gifts to return.

Member Function Documentation

◆ store()

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

◆ attributes_

array<object_ptr<UpgradedGiftAttributeId> > td::td_api::searchGiftsForResale::attributes_

Attributes used to filter received gifts. If multiple attributes of the same type are specified, then all of them are allowed. If none attributes of specific type are specified, then all values for this attribute type are allowed.

Definition at line 124017 of file td_api.h.

◆ for_crafting_

bool td::td_api::searchGiftsForResale::for_crafting_

Pass true to get only gifts suitable for crafting.

Definition at line 124013 of file td_api.h.

◆ for_stars_

bool td::td_api::searchGiftsForResale::for_stars_

Pass true to get only gifts that can be bought using Telegram Stars.

Definition at line 124015 of file td_api.h.

◆ gift_id_

int64 td::td_api::searchGiftsForResale::gift_id_

Identifier of the regular gift that was upgraded to a unique gift.

Definition at line 124009 of file td_api.h.

◆ ID

const std::int32_t td::td_api::searchGiftsForResale::ID = 1947702322
static

Identifier uniquely determining a type of the object.

Definition at line 124046 of file td_api.h.

◆ limit_

int32 td::td_api::searchGiftsForResale::limit_

The maximum number of gifts to return.

Definition at line 124021 of file td_api.h.

◆ offset_

string td::td_api::searchGiftsForResale::offset_

Offset of the first entry to return as received from the previous request with the same order and attributes; use empty string to get the first chunk of results.

Definition at line 124019 of file td_api.h.

◆ order_

object_ptr<GiftForResaleOrder> td::td_api::searchGiftsForResale::order_

Order in which the results will be sorted.

Definition at line 124011 of file td_api.h.


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