td::td_api::sendGift Class Reference

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

Inheritance diagram for td::td_api::sendGift:

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 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 send.
object_ptr< MessageSender >	owner_id_
	Identifier of the user or the channel chat that will receive the gift; limited gifts can&#x27;t be sent to channel chats.
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.
bool	pay_for_upgrade_
	Pass true to additionally pay for the gift upgrade and allow the receiver to upgrade it for free.

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

Detailed 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>.

Definition at line 126036 of file td_api.h.

Member Typedef Documentation

ReturnType

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

Typedef for the type returned by the function.

Definition at line 126081 of file td_api.h.

Constructor & Destructor Documentation

sendGift() [1/2]

td::td_api::sendGift::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]

td::td_api::sendGift::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 td::td_api::sendGift::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::sendGift::gift_id_

Identifier of the gift to send.

Definition at line 126047 of file td_api.h.

ID

const std::int32_t td::td_api::sendGift::ID = -1199356118

static

Identifier uniquely determining a type of the object.

Definition at line 126078 of file td_api.h.

is_private_

bool td::td_api::sendGift::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 126053 of file td_api.h.

owner_id_

object_ptr<MessageSender> td::td_api::sendGift::owner_id_

Identifier of the user or the channel chat that will receive the gift; limited gifts can&#x27;t be sent to channel chats.

Definition at line 126049 of file td_api.h.

pay_for_upgrade_

bool td::td_api::sendGift::pay_for_upgrade_

Pass true to additionally pay for the gift upgrade and allow the receiver to upgrade it for free.

Definition at line 126055 of file td_api.h.

text_

object_ptr<formattedText> td::td_api::sendGift::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 126051 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