InputInvoiceStarGift

class pyrogram.raw.types.InputInvoiceStarGift

Used to buy a Telegram Star Gift, see here » for more info.

Constructor of InputInvoice.

Details:

  • Layer: 227

  • ID: E8625E92

Parameters:

  • peer (InputPeer) – Receiver of the gift.

  • gift_id (int 64-bit) – Identifier of the gift, from starGift.id

  • hide_name (bool, optional) – If set, your name will be hidden if the destination user decides to display the gift on their profile (they will still see that you sent the gift)

  • include_upgrade (bool, optional) – Also pay for an eventual upgrade of the gift to a collectible gift ».

  • message (TextWithEntities, optional) – Optional message, attached with the gift. The maximum length for this field is specified in the stargifts_message_length_max client configuration value ».

TL Schema

inputInvoiceStarGift#e8625e92
flags:#
hide_name:flags.0?true
include_upgrade:flags.2?true
peer:InputPeer
gift_id:long
message:flags.1?TextWithEntities

= InputInvoice

Parameter Tree

InputInvoiceStarGift
├── hide_name → true (optional)
├── include_upgrade → true (optional)
├── peer → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ │ └── chat_id → long
│ ├── InputPeerUser
│ │ ├── user_id → long
│ │ └── access_hash → long
│ ├── InputPeerChannel
│ │ ├── channel_id → long
│ │ └── access_hash → long
│ ├── InputPeerUserFromMessage
│ │ ├── peer → InputPeer
│ │ │ ├── InputPeerEmpty
│ │ │ ├── InputPeerSelf
│ │ │ ├── InputPeerChat
│ │ │ ├── InputPeerUser
│ │ │ ├── InputPeerChannel
│ │ │ ├── InputPeerUserFromMessage
│ │ │ └── InputPeerChannelFromMessage
│ │ ├── msg_id → int
│ │ └── user_id → long
│ └── InputPeerChannelFromMessage
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── msg_id → int
│ └── channel_id → long
├── gift_id → long
└── message → TextWithEntities (optional)
└── TextWithEntities
├── text → string
└── entities → Vector < MessageEntity >
├── MessageEntityUnknown
│ ├── offset → int
│ └── length → int
├── MessageEntityMention
│ ├── offset → int
│ └── length → int
├── MessageEntityHashtag
│ ├── offset → int
│ └── length → int
├── MessageEntityBotCommand
│ ├── offset → int
│ └── length → int
├── MessageEntityUrl
│ ├── offset → int
│ └── length → int
├── MessageEntityEmail
│ ├── offset → int
│ └── length → int
├── MessageEntityBold
│ ├── offset → int
│ └── length → int
├── MessageEntityItalic
│ ├── offset → int
│ └── length → int
├── MessageEntityCode
│ ├── offset → int
│ └── length → int
├── MessageEntityPre
│ ├── offset → int
│ ├── length → int
│ └── language → string
├── MessageEntityTextUrl
│ ├── offset → int
│ ├── length → int
│ └── url → string
├── MessageEntityMentionName
│ ├── offset → int
│ ├── length → int
│ └── user_id → long
├── InputMessageEntityMentionName
│ ├── offset → int
│ ├── length → int
│ └── user_id → InputUser
│ ├── InputUserEmpty
│ ├── InputUserSelf
│ ├── InputUser
│ └── InputUserFromMessage
├── MessageEntityPhone
│ ├── offset → int
│ └── length → int
├── MessageEntityCashtag
│ ├── offset → int
│ └── length → int
├── MessageEntityUnderline
│ ├── offset → int
│ └── length → int
├── MessageEntityStrike
│ ├── offset → int
│ └── length → int
├── MessageEntityBankCard
│ ├── offset → int
│ └── length → int
├── MessageEntitySpoiler
│ ├── offset → int
│ └── length → int
├── MessageEntityCustomEmoji
│ ├── offset → int
│ ├── length → int
│ └── document_id → long
├── MessageEntityBlockquote
│ ├── collapsed → true (optional)
│ ├── offset → int
│ └── length → int
├── MessageEntityFormattedDate
│ ├── relative → true (optional)
│ ├── short_time → true (optional)
│ ├── long_time → true (optional)
│ ├── short_date → true (optional)
│ ├── long_date → true (optional)
│ ├── day_of_week → true (optional)
│ ├── offset → int
│ ├── length → int
│ └── date → int
├── MessageEntityDiffInsert
│ ├── offset → int
│ └── length → int
├── MessageEntityDiffReplace
│ ├── offset → int
│ ├── length → int
│ └── old_text → string
└── MessageEntityDiffDelete
├── offset → int
└── length → int

Example

InputInvoiceStarGift(
    peer=await app.resolve_peer(chat_id),
    gift_id=0,
)