getReceivedGifts Class Reference

Inherits Function.

Description

Returns gifts received by the given user or chat.

Returns object_ptr<ReceivedGifts>.

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

Public Member Functions
	getReceivedGifts ()
	getReceivedGifts (string const &business_connection_id_, object_ptr< MessageSender > &&owner_id_, int32 collection_id_, bool exclude_unsaved_, bool exclude_saved_, bool exclude_unlimited_, bool exclude_upgradable_, bool exclude_non_upgradable_, bool exclude_upgraded_, bool exclude_without_colors_, bool exclude_hosted_, bool sort_by_price_, string const &offset_, int32 limit_)
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
string	business_connection_id_
	Unique identifier of business connection on behalf of which to send the request; for bots only.
int32	collection_id_
	Pass collection identifier to get gifts only from the specified collection; pass 0 to get gifts regardless of collections.
bool	exclude_hosted_
	Pass true to exclude gifts that are just hosted and are not owned by the owner.
bool	exclude_non_upgradable_
	Pass true to exclude gifts that can be purchased limited number of times and can't be upgraded.
bool	exclude_saved_
	Pass true to exclude gifts that are saved to the chat's profile page. Always false for gifts received by other users and channel chats without can_post_messages administrator right.
bool	exclude_unlimited_
	Pass true to exclude gifts that can be purchased unlimited number of times.
bool	exclude_unsaved_
	Pass true to exclude gifts that aren't saved to the chat's profile page. Always true for gifts received by other users and channel chats without can_post_messages administrator right.
bool	exclude_upgradable_
	Pass true to exclude gifts that can be purchased limited number of times and can be upgraded.
bool	exclude_upgraded_
	Pass true to exclude upgraded gifts.
bool	exclude_without_colors_
	Pass true to exclude gifts that can't be used in setUpgradedGiftColors.
int32	limit_
	The maximum number of gifts to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit.
string	offset_
	Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
object_ptr< MessageSender >	owner_id_
	Identifier of the gift receiver.
bool	sort_by_price_
	Pass true to sort results by gift price instead of send date.

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

Constructor & Destructor Documentation

getReceivedGifts() [1/2]

getReceivedGifts

(

)

Default constructor for a function, which returns gifts received by the given user or chat.

Returns object_ptr<ReceivedGifts>.

getReceivedGifts() [2/2]

getReceivedGifts	(	string const &	business_connection_id_,
		object_ptr< MessageSender > &&	owner_id_,
		int32	collection_id_,
		bool	exclude_unsaved_,
		bool	exclude_saved_,
		bool	exclude_unlimited_,
		bool	exclude_upgradable_,
		bool	exclude_non_upgradable_,
		bool	exclude_upgraded_,
		bool	exclude_without_colors_,
		bool	exclude_hosted_,
		bool	sort_by_price_,
		string const &	offset_,
		int32	limit_ )

Creates a function, which returns gifts received by the given user or chat.

Returns object_ptr<ReceivedGifts>.

Parameters

[in]	business_connection_id_	Unique identifier of business connection on behalf of which to send the request; for bots only.
[in]	owner_id_	Identifier of the gift receiver.
[in]	collection_id_	Pass collection identifier to get gifts only from the specified collection; pass 0 to get gifts regardless of collections.
[in]	exclude_unsaved_	Pass true to exclude gifts that aren't saved to the chat's profile page. Always true for gifts received by other users and channel chats without can_post_messages administrator right.
[in]	exclude_saved_	Pass true to exclude gifts that are saved to the chat's profile page. Always false for gifts received by other users and channel chats without can_post_messages administrator right.
[in]	exclude_unlimited_	Pass true to exclude gifts that can be purchased unlimited number of times.
[in]	exclude_upgradable_	Pass true to exclude gifts that can be purchased limited number of times and can be upgraded.
[in]	exclude_non_upgradable_	Pass true to exclude gifts that can be purchased limited number of times and can't be upgraded.
[in]	exclude_upgraded_	Pass true to exclude upgraded gifts.
[in]	exclude_without_colors_	Pass true to exclude gifts that can't be used in setUpgradedGiftColors.
[in]	exclude_hosted_	Pass true to exclude gifts that are just hosted and are not owned by the owner.
[in]	sort_by_price_	Pass true to sort results by gift price instead of send date.
[in]	offset_	Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
[in]	limit_	The maximum number of gifts to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit.

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