Constructor: messageActionStarGift
You received a gift, see here » for more info.
Attributes:
| Name | Type | Required | Description |
|---|---|---|---|
| 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. |
| gift | StarGift | Yes | Info about the gift |
| message | TextWithEntities | Optional | Additional message from the sender of the gift |
| convert_stars | long | 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 | Optional | If set, this gift was upgraded to a collectible gift, and the corresponding messageActionStarGiftUnique is available at the specified message ID. |
| upgrade_stars | long | 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 | long | Optional | Receiver of the gift. |
| saved_id | long | Optional | For channel gifts, ID to use in inputSavedStarGiftChat constructors. |
| prepaid_upgrade_hash | string | Optional | Hash to prepay for a gift upgrade separately ». |
| gift_msg_id | int | 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). |
Type: MessageAction
Example:
$messageActionStarGift = ['_' => 'messageActionStarGift', 'name_hidden' => Bool, 'saved' => Bool, 'converted' => Bool, 'upgraded' => Bool, 'refunded' => Bool, 'can_upgrade' => Bool, 'prepaid_upgrade' => Bool, 'upgrade_separate' => Bool, 'gift' => StarGift, 'message' => TextWithEntities, 'convert_stars' => long, 'upgrade_msg_id' => int, 'upgrade_stars' => long, 'from_id' => Peer, 'peer' => long, 'saved_id' => long, 'prepaid_upgrade_hash' => 'string', 'gift_msg_id' => int];