payments.GetSavedStarGifts#

class pyrogram.raw.functions.payments.GetSavedStarGifts#

Fetch the full list of gifts owned, received or hosted by a peer. Note that unlike what the name suggests, the method can be used to fetch both “saved” and “unsaved” gifts (aka gifts both pinned and not pinned) to the profile, depending on the passed flags.

Note

This method may be invoked over a business connection »

Details:

Layer: 227
ID: A319E569

Parameters:

peer (InputPeer) – Fetch only gifts owned, received or hosted » by the specified peer, such as: a user, with peer=`inputPeerUser <https://core.telegram.org/constructor/inputPeerUser>`__; a channel, with peer=`inputPeerChannel <https://core.telegram.org/constructor/inputPeerChannel>`__; a connected business user » (when executing the method as a bot, over the business connection), with peer=`inputPeerUser <https://core.telegram.org/constructor/inputPeerUser>`__.
offset (str) – Offset for pagination.
limit (int 32-bit) – Maximum number of results to return, see pagination
exclude_unsaved (bool, optional) – Exclude gifts not pinned on the profile.
exclude_saved (bool, optional) – Exclude gifts pinned on the profile.
exclude_unlimited (bool, optional) – Exclude gifts that do not have the starGift.limited flag set.
exclude_unique (bool, optional) – Exclude collectible gifts ».
sort_by_value (bool, optional) – If set, sorts the gifts by price instead of reception date.
exclude_upgradable (bool, optional) – Exclude gifts that can be upgraded to collectible gifts ».
exclude_unupgradable (bool, optional) – Exclude gifts that cannot be upgraded to collectible gifts ».
peer_color_available (bool, optional) – If set, only returns collectible gifts whose palette can be used as a collectible message palette ».
exclude_hosted (bool, optional) – If set, excludes hosted collectible gifts », returning only gifts owned or received by peer.
collection_id (int 32-bit, optional) – Only returns gifts within the specified collection ».

Returns:

payments.SavedStarGifts