Link Search Menu Expand Document

Constructor: messageActionStarGift

Back to constructors index

You received a gift, see here » for more info.

Attributes:

NameTypeRequiredDescription
name_hiddenBoolOptionalIf set, the name of the sender of the gift will be hidden if the destination user decides to display the gift on their profile
savedBoolOptionalWhether this gift was added to the destination user’s profile (may be toggled using payments.saveStarGift and fetched using payments.getUserStarGifts)
convertedBoolOptionalWhether this gift was converted to Telegram Stars and cannot be displayed on the profile anymore.
upgradedBoolOptional
refundedBoolOptional
can_upgradeBoolOptional
giftStarGiftYesInfo about the gift
messageTextWithEntitiesOptionalAdditional message from the sender of the gift
convert_starslongOptionalThe 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_idintOptional
upgrade_starslongOptional
from_idPeerOptional
peerlongOptional
saved_idlongOptional

Type: MessageAction

Example:

$messageActionStarGift = ['_' => 'messageActionStarGift', 'name_hidden' => Bool, 'saved' => Bool, 'converted' => Bool, 'upgraded' => Bool, 'refunded' => Bool, 'can_upgrade' => Bool, 'gift' => StarGift, 'message' => TextWithEntities, 'convert_stars' => long, 'upgrade_msg_id' => int, 'upgrade_stars' => long, 'from_id' => Peer, 'peer' => long, 'saved_id' => long];