td::td_api::placeGiftAuctionBid Class Reference

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

Inheritance diagram for td::td_api::placeGiftAuctionBid:

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

Public Member Functions
	placeGiftAuctionBid ()
	placeGiftAuctionBid (int64 gift_id_, int53 star_count_, int53 user_id_, object_ptr< formattedText > &&text_, bool is_private_)
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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
int64	gift_id_
	Identifier of the gift to place the bid on.
int53	star_count_
	The number of Telegram Stars to place in the bid.
int53	user_id_
	Identifier of the user who will receive the gift.
object_ptr< formattedText >	text_
	Text to show along with the gift; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed. Must be empty if the receiver enabled paid messages.
bool	is_private_
	Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them.

Static Public Attributes
static const std::int32_t	ID = 1437176980
	Identifier uniquely determining a type of the object.

Detailed Description

Places a bid on an auction gift.

Returns object_ptr<Ok>.

Definition at line 118108 of file td_api.h.

Member Typedef Documentation

ReturnType

using td::td_api::placeGiftAuctionBid::ReturnType = object_ptr<ok>

Typedef for the type returned by the function.

Definition at line 118153 of file td_api.h.

Constructor & Destructor Documentation

placeGiftAuctionBid() [1/2]

td::td_api::placeGiftAuctionBid::placeGiftAuctionBid

(

)

Default constructor for a function, which places a bid on an auction gift.

Returns object_ptr<Ok>.

placeGiftAuctionBid() [2/2]

td::td_api::placeGiftAuctionBid::placeGiftAuctionBid	(	int64	gift_id_,
		int53	star_count_,
		int53	user_id_,
		object_ptr< formattedText > &&	text_,
		bool	is_private_
	)

Creates a function, which places a bid on an auction gift.

Returns object_ptr<Ok>.

Parameters

[in]	gift_id_	Identifier of the gift to place the bid on.
[in]	star_count_	The number of Telegram Stars to place in the bid.
[in]	user_id_	Identifier of the user who will receive the gift.
[in]	text_	Text to show along with the gift; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed. Must be empty if the receiver enabled paid messages.
[in]	is_private_	Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them.

Member Function Documentation

store()

void td::td_api::placeGiftAuctionBid::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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

Member Data Documentation

gift_id_

int64 td::td_api::placeGiftAuctionBid::gift_id_

Identifier of the gift to place the bid on.

Definition at line 118119 of file td_api.h.

ID

const std::int32_t td::td_api::placeGiftAuctionBid::ID = 1437176980

static

Identifier uniquely determining a type of the object.

Definition at line 118150 of file td_api.h.

is_private_

bool td::td_api::placeGiftAuctionBid::is_private_

Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them.

Definition at line 118127 of file td_api.h.

star_count_

int53 td::td_api::placeGiftAuctionBid::star_count_

The number of Telegram Stars to place in the bid.

Definition at line 118121 of file td_api.h.

text_

object_ptr<formattedText> td::td_api::placeGiftAuctionBid::text_

Text to show along with the gift; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed. Must be empty if the receiver enabled paid messages.

Definition at line 118125 of file td_api.h.

user_id_

int53 td::td_api::placeGiftAuctionBid::user_id_

Identifier of the user who will receive the gift.

Definition at line 118123 of file td_api.h.

---

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

• /home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h