Description

Returns gifts received by the given user or chat.

Returns object_ptr<ReceivedGifts>.

Public Fields
object_ptr< MessageSender >	owner_id_
	Identifier of the gift receiver.

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_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_limited_
	Pass true to exclude gifts that can be purchased limited number of times.

bool	exclude_upgraded_
	Pass true to exclude upgraded gifts.

bool	sort_by_price_
	Pass true to sort results by gift price instead of send date.

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.

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.

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

Public Instance Methods
	getReceivedGifts ()

	getReceivedGifts (object_ptr< MessageSender > &&owner_id_, bool exclude_unsaved_, bool exclude_saved_, bool exclude_unlimited_, bool exclude_limited_, bool exclude_upgraded_, bool sort_by_price_, string const &offset_, int32 limit_)

void	store (TlStorerToString &s, const char *field_name) const final

Public Instance Methods inherited from 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

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

Constructor & Destructor Documentation

getReceivedGifts ( )

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

Returns object_ptr<ReceivedGifts>.

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

Returns object_ptr<ReceivedGifts>.

Parameters

[in]	owner_id_	Identifier of the gift receiver.
[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_limited_	Pass true to exclude gifts that can be purchased limited number of times.
[in]	exclude_upgraded_	Pass true to exclude upgraded gifts.
[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.

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: