MessageActionStarGift#

class pyrogram.raw.types.MessageActionStarGift#

You received a gift, see here for more info.

Constructor of MessageAction.

Details:

  • Layer: 227

  • ID: EA2C31D3

Parameters:

  • gift (StarGift) – Info about the gift

  • name_hidden (bool, optional) – If set, the name of the sender of the gift will be hidden if the destination user decides to display the gift on their profile

  • saved (bool, optional) – Whether this gift was added to the destination user’s profile (may be toggled using payments.saveStarGift and fetched using payments.getSavedStarGifts)

  • converted (bool, optional) – Whether this gift was converted to Telegram Stars and cannot be displayed on the profile anymore.

  • upgraded (bool, optional) – This gift was upgraded to a collectible gift ».

  • refunded (bool, optional) – This gift is not available anymore because a request to refund the payment related to this gift was made, and the money was returned.

  • can_upgrade (bool, optional) – If set, this gift can be upgraded to a collectible gift; can only be set for the receiver of a gift.

  • prepaid_upgrade (bool, optional) – The sender has already pre-paid for the upgrade of this gift to a collectible gift.

  • upgrade_separate (bool, optional) – This service message is the notification of a separate pre-payment for the upgrade of a gift we own.

  • auction_acquired (bool, optional) – If set, this gift was acquired in a collectible gifts auction ».

  • message (TextWithEntities, optional) – Additional message from the sender of the gift

  • convert_stars (int 64-bit, optional) – The receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page.convert_stars will be equal to stars only if the gift was bought using recently bought Telegram Stars, otherwise it will be less than stars.

  • upgrade_msg_id (int 32-bit, optional) – If set, this gift was upgraded to a collectible gift, and the corresponding messageActionStarGiftUnique is available at the specified message ID.

  • upgrade_stars (int 64-bit, optional) – The number of Telegram Stars the user can pay to convert the gift into a collectible gift ».

  • from_id (Peer, optional) – Sender of the gift (unset for anonymous gifts).

  • peer (Peer, optional) – Receiver of the gift.

  • saved_id (int 64-bit, optional) – For channel gifts, ID to use in inputSavedStarGiftChat constructors.

  • prepaid_upgrade_hash (str, optional) – Hash to prepay for a gift upgrade separately ».

  • gift_msg_id (int 32-bit, optional) – For separate upgrades, the identifier of the message with the gift whose upgrade was prepaid (only valid for the receiver of the service message).

  • to_id (Peer, optional) – For gifts acquired in an auction » (i.e. when auction_acquired is set), the peer the gift was assigned to; only present if the target peer is different from the bidder, in which case it will only be present to the messageActionStarGift sent to the bidder, not to the messageActionStarGift sent to the target peer.

  • gift_num (int 32-bit, optional) – For gifts acquired in an auction », the collectible number of the won collectible gift »; this field is disjoint from auction_acquired because only auction collectibles won before this field was introduced in the API will not have this flag set.