TDLib
Loading...
Searching...
No Matches
auctionStateActive Class Referencefinal

Inherits AuctionState.

Description

Contains information about an ongoing or scheduled auction.

Public Member Functions

 auctionStateActive ()
 auctionStateActive (int32 start_date_, int32 end_date_, int53 min_bid_, array< object_ptr< auctionBid > > &&bid_levels_, array< int53 > &&top_bidder_user_ids_, array< object_ptr< auctionRound > > &&rounds_, int32 current_round_end_date_, int32 current_round_number_, int32 total_round_count_, int32 distributed_item_count_, int32 left_item_count_, int32 acquired_item_count_, object_ptr< userAuctionBid > &&user_bid_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

int32 acquired_item_count_
 The number of items that were purchased by the current user on the auction.
array< object_ptr< auctionBid > > bid_levels_
 A sparse list of bids that were made in the auction.
int32 current_round_end_date_
 Point in time (Unix timestamp) when the current round will end.
int32 current_round_number_
 1-based number of the current round.
int32 distributed_item_count_
 The number of items that were purchased on the auction by all users.
int32 end_date_
 Point in time (Unix timestamp) when the auction will be ended.
int32 left_item_count_
 The number of items that have to be distributed on the auction.
int53 min_bid_
 The minimum possible bid in the auction in Telegram Stars.
array< object_ptr< auctionRound > > rounds_
 Rounds of the auction in which their duration or extension rules are changed.
int32 start_date_
 Point in time (Unix timestamp) when the auction started or will start.
array< int53 > top_bidder_user_ids_
 User identifiers of at most 3 users with the biggest bids.
int32 total_round_count_
 The total number of rounds.
object_ptr< userAuctionBid > user_bid_
 Bid of the current user in the auction; may be null if none.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ auctionStateActive() [1/2]

auctionStateActive ( )

Contains information about an ongoing or scheduled auction.

◆ auctionStateActive() [2/2]

auctionStateActive ( int32 start_date_,
int32 end_date_,
int53 min_bid_,
array< object_ptr< auctionBid > > && bid_levels_,
array< int53 > && top_bidder_user_ids_,
array< object_ptr< auctionRound > > && rounds_,
int32 current_round_end_date_,
int32 current_round_number_,
int32 total_round_count_,
int32 distributed_item_count_,
int32 left_item_count_,
int32 acquired_item_count_,
object_ptr< userAuctionBid > && user_bid_ )

Contains information about an ongoing or scheduled auction.

Parameters
[in]start_date_Point in time (Unix timestamp) when the auction started or will start.
[in]end_date_Point in time (Unix timestamp) when the auction will be ended.
[in]min_bid_The minimum possible bid in the auction in Telegram Stars.
[in]bid_levels_A sparse list of bids that were made in the auction.
[in]top_bidder_user_ids_User identifiers of at most 3 users with the biggest bids.
[in]rounds_Rounds of the auction in which their duration or extension rules are changed.
[in]current_round_end_date_Point in time (Unix timestamp) when the current round will end.
[in]current_round_number_1-based number of the current round.
[in]total_round_count_The total number of rounds.
[in]distributed_item_count_The number of items that were purchased on the auction by all users.
[in]left_item_count_The number of items that have to be distributed on the auction.
[in]acquired_item_count_The number of items that were purchased by the current user on the auction.
[in]user_bid_Bid of the current user in the auction; may be null if none.

Member Function Documentation

◆ store()

void 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 TlObject.


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