giftPremiumWithStars Class Reference

Inherits Function.

Description

Allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars; for bots only.

Returns object_ptr<Ok>.

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

Public Member Functions
	giftPremiumWithStars ()
	giftPremiumWithStars (int53 user_id_, int53 star_count_, int32 month_count_, object_ptr< formattedText > &&text_)
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	month_count_
	Number of months the Telegram Premium subscription will be active for the user.
int53	star_count_
	The number of Telegram Stars to pay for subscription.
object_ptr< formattedText >	text_
	Text to show to the user receiving Telegram Premium; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed.
int53	user_id_
	Identifier of the user which will receive Telegram Premium.

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

Constructor & Destructor Documentation

giftPremiumWithStars() [1/2]

giftPremiumWithStars

(

)

Default constructor for a function, which allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars; for bots only.

Returns object_ptr<Ok>.

giftPremiumWithStars() [2/2]

giftPremiumWithStars	(	int53	user_id_,
		int53	star_count_,
		int32	month_count_,
		object_ptr< formattedText > &&	text_ )

Creates a function, which allows to buy a Telegram Premium subscription for another user with payment in Telegram Stars; for bots only.

Returns object_ptr<Ok>.

Parameters

[in]	user_id_	Identifier of the user which will receive Telegram Premium.
[in]	star_count_	The number of Telegram Stars to pay for subscription.
[in]	month_count_	Number of months the Telegram Premium subscription will be active for the user.
[in]	text_	Text to show to the user receiving Telegram Premium; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed.

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

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h