#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>
|
| | 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 |
| |
| 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 |
| |
|
| string | business_connection_id_ |
| | Unique identifier of business connection on behalf of which to send the request; for bots only.
|
| |
| object_ptr< MessageSender > | owner_id_ |
| | Identifier of the gift receiver.
|
| |
| int32 | collection_id_ |
| | Pass collection identifier to get gifts only from the specified collection; pass 0 to get gifts regardless of collections.
|
| |
| 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_upgradable_ |
| | Pass true to exclude gifts that can be purchased limited number of times and can be upgraded.
|
| |
| bool | exclude_non_upgradable_ |
| | Pass true to exclude gifts that can be purchased limited number of times and can't 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.
|
| |
| bool | exclude_hosted_ |
| | Pass true to exclude gifts that are just hosted and are not owned by the owner.
|
| |
| 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.
|
| |
|
| static const std::int32_t | ID = 1411782110 |
| | Identifier uniquely determining a type of the object.
|
| |
Returns gifts received by the given user or chat.
Returns object_ptr<ReceivedGifts>.
Definition at line 111850 of file td_api.h.
◆ ReturnType
Typedef for the type returned by the function.
Definition at line 111922 of file td_api.h.
◆ getReceivedGifts() [1/2]
| td::td_api::getReceivedGifts::getReceivedGifts |
( |
| ) |
|
Default constructor for a function, which returns gifts received by the given user or chat.
Returns object_ptr<ReceivedGifts>.
◆ getReceivedGifts() [2/2]
| td::td_api::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_ |
|
) |
| |
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. |
◆ store()
| void td::td_api::getReceivedGifts::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.
◆ business_connection_id_
| string td::td_api::getReceivedGifts::business_connection_id_ |
Unique identifier of business connection on behalf of which to send the request; for bots only.
Definition at line 111861 of file td_api.h.
◆ collection_id_
| int32 td::td_api::getReceivedGifts::collection_id_ |
Pass collection identifier to get gifts only from the specified collection; pass 0 to get gifts regardless of collections.
Definition at line 111865 of file td_api.h.
◆ exclude_hosted_
| bool td::td_api::getReceivedGifts::exclude_hosted_ |
Pass true to exclude gifts that are just hosted and are not owned by the owner.
Definition at line 111881 of file td_api.h.
◆ exclude_non_upgradable_
| bool td::td_api::getReceivedGifts::exclude_non_upgradable_ |
Pass true to exclude gifts that can be purchased limited number of times and can't be upgraded.
Definition at line 111875 of file td_api.h.
◆ exclude_saved_
| bool td::td_api::getReceivedGifts::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.
Definition at line 111869 of file td_api.h.
◆ exclude_unlimited_
| bool td::td_api::getReceivedGifts::exclude_unlimited_ |
Pass true to exclude gifts that can be purchased unlimited number of times.
Definition at line 111871 of file td_api.h.
◆ exclude_unsaved_
| bool td::td_api::getReceivedGifts::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.
Definition at line 111867 of file td_api.h.
◆ exclude_upgradable_
| bool td::td_api::getReceivedGifts::exclude_upgradable_ |
Pass true to exclude gifts that can be purchased limited number of times and can be upgraded.
Definition at line 111873 of file td_api.h.
◆ exclude_upgraded_
| bool td::td_api::getReceivedGifts::exclude_upgraded_ |
Pass true to exclude upgraded gifts.
Definition at line 111877 of file td_api.h.
◆ exclude_without_colors_
| bool td::td_api::getReceivedGifts::exclude_without_colors_ |
◆ ID
| const std::int32_t td::td_api::getReceivedGifts::ID = 1411782110 |
|
static |
Identifier uniquely determining a type of the object.
Definition at line 111919 of file td_api.h.
◆ limit_
| int32 td::td_api::getReceivedGifts::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.
Definition at line 111887 of file td_api.h.
◆ offset_
| string td::td_api::getReceivedGifts::offset_ |
Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
Definition at line 111885 of file td_api.h.
◆ owner_id_
Identifier of the gift receiver.
Definition at line 111863 of file td_api.h.
◆ sort_by_price_
| bool td::td_api::getReceivedGifts::sort_by_price_ |
Pass true to sort results by gift price instead of send date.
Definition at line 111883 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