Constructor: savedStarGift
Represents a gift owned by a peer.
Attributes:
| Name | Type | Required | Description |
|---|---|---|---|
| name_hidden | Bool | Optional | If set, the gift sender in from_id and the message are set only for the receiver of the gift. |
| unsaved | Bool | Optional | If set, the gift is not pinned on the user’s profile. |
| refunded | Bool | Optional | This gift was upgraded to a collectible gift » and then re-downgraded to a regular gift because a request to refund the payment related to the upgrade was made, and the money was returned. |
| can_upgrade | Bool | Optional | Only set for non-collectible gifts, if they can be upgraded to a collectible gift ». |
| pinned_to_top | Bool | Optional | Whether this gift is pinned on top of the user’s profile page. |
| upgrade_separate | Bool | Optional | If set, someone already separately pre-paid for the upgrade of this gift. |
| from_id | Peer | Optional | Sender of the gift (unset for anonymous gifts). |
| date | int | Yes | Reception date of the gift. |
| gift | StarGift | Yes | The collectible gift. |
| message | TextWithEntities | Optional | Message attached to the gift. |
| msg_id | int | Optional | For gifts received by users, ID to use in inputSavedStarGiftUser constructors. |
| saved_id | long | Optional | For gifts received by channels, ID to use in inputSavedStarGiftChat constructors. |
| convert_stars | long | Optional | For non-collectible gifts, the receiver of this gift may convert it to this many Telegram Stars, instead of displaying it on their profile page. |
| upgrade_stars | long | Optional | Only for pre-paid non-collectible gifts, the number of Telegram Stars the sender has already paid to convert the gift into a collectible gift » (this is different from the meaning of the flag in messageActionStarGift, where it signals the upgrade price for not yet upgraded gifts). |
| can_export_at | int | Optional | If set, indicates that the current gift can’t be exported to the TON blockchain » yet: the owner will be able to export it at the specified unixtime. |
| transfer_stars | long | Optional | If set, indicates that the gift can be transferred » to another user by paying the specified amount of stars. |
| can_transfer_at | int | Optional | If set, indicates that the current gift can’t be transferred » yet: the owner will be able to transfer it at the specified unixtime. |
| can_resell_at | int | Optional | If set, indicates that the current gift can’t be resold » yet: the owner will be able to put it up for sale at the specified unixtime. |
| collection_id | Array of int | Optional | IDs of the collections » that this gift is a part of. |
| prepaid_upgrade_hash | string | Optional | Hash to prepay for a gift upgrade separately ». |
| drop_original_details_stars | long | Optional |
Type: SavedStarGift
Example:
$savedStarGift = ['_' => 'savedStarGift', 'name_hidden' => Bool, 'unsaved' => Bool, 'refunded' => Bool, 'can_upgrade' => Bool, 'pinned_to_top' => Bool, 'upgrade_separate' => Bool, 'from_id' => Peer, 'date' => int, 'gift' => StarGift, 'message' => TextWithEntities, 'msg_id' => int, 'saved_id' => long, 'convert_stars' => long, 'upgrade_stars' => long, 'can_export_at' => int, 'transfer_stars' => long, 'can_transfer_at' => int, 'can_resell_at' => int, 'collection_id' => [int, int], 'prepaid_upgrade_hash' => 'string', 'drop_original_details_stars' => long];