sendGift Class Reference

Inherits Function.

Description

Sends a gift to another user or channel chat. May return an error with a message "STARGIFT_USAGE_LIMITED" if the gift was sold out.

Returns object_ptr<Ok>.

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

Public Member Functions
	sendGift ()
	sendGift (int64 gift_id_, object_ptr< MessageSender > &&owner_id_, object_ptr< formattedText > &&text_, bool is_private_, bool pay_for_upgrade_)
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
int64	gift_id_
	Identifier of the gift to send.
bool	is_private_
	Pass true to show gift text and sender only to the gift receiver; otherwise, everyone will be able to see them.
object_ptr< MessageSender >	owner_id_
	Identifier of the user or the channel chat that will receive the gift; limited gifts can't be sent to channel chats.
bool	pay_for_upgrade_
	Pass true to additionally pay for the gift upgrade and allow the receiver to upgrade it for free.
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.

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

Constructor & Destructor Documentation

sendGift() [1/2]

sendGift

(

)

Default constructor for a function, which sends a gift to another user or channel chat. May return an error with a message "STARGIFT_USAGE_LIMITED" if the gift was sold out.

Returns object_ptr<Ok>.

sendGift() [2/2]

sendGift	(	int64	gift_id_,
		object_ptr< MessageSender > &&	owner_id_,
		object_ptr< formattedText > &&	text_,
		bool	is_private_,
		bool	pay_for_upgrade_ )

Creates a function, which sends a gift to another user or channel chat. May return an error with a message "STARGIFT_USAGE_LIMITED" if the gift was sold out.

Returns object_ptr<Ok>.

Parameters

[in]	gift_id_	Identifier of the gift to send.
[in]	owner_id_	Identifier of the user or the channel chat that will receive the gift; limited gifts can't be sent to channel chats.
[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.
[in]	pay_for_upgrade_	Pass true to additionally pay for the gift upgrade and allow the receiver to upgrade it for free.

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