StarGift

class pyrogram.raw.base.StarGift

Represents a star gift, see here » for more info.

Constructors:

This base type has 2 constructors available.

StarGift

Represents a star gift, see here » for more info.

StarGiftUnique

Represents a collectible star gift, see here » for more info.

TL Schema

starGift#313a9547
flags:#
limited:flags.0?true
sold_out:flags.1?true
birthday:flags.2?true
require_premium:flags.7?true
limited_per_user:flags.8?true
peer_color_available:flags.10?true
auction:flags.11?true
id:long
sticker:Document
stars:long
availability_remains:flags.0?int
availability_total:flags.0?int
availability_resale:flags.4?long
convert_stars:long
first_sale_date:flags.1?int
last_sale_date:flags.1?int
upgrade_stars:flags.3?long
resell_min_stars:flags.4?long
title:flags.5?string
released_by:flags.6?Peer
per_user_total:flags.8?int
per_user_remains:flags.8?int
locked_until_date:flags.9?int
auction_slug:flags.11?string
gifts_per_round:flags.11?int
auction_start_date:flags.11?int
upgrade_variants:flags.12?int
background:flags.13?StarGiftBackground

= StarGift

Parameter Tree

StarGift
├── limited → true (optional)
├── sold_out → true (optional)
├── birthday → true (optional)
├── require_premium → true (optional)
├── limited_per_user → true (optional)
├── peer_color_available → true (optional)
├── auction → true (optional)
├── id → long
├── sticker → Document
│ ├── DocumentEmpty
│ │ └── id → long
│ └── Document
│ ├── id → long
│ ├── access_hash → long
│ ├── file_reference → bytes
│ ├── date → int
│ ├── mime_type → string
│ ├── size → long
│ ├── thumbs → Vector < PhotoSize > (optional)
│ │ ├── PhotoSizeEmpty
│ │ │ └── type → string
│ │ ├── PhotoSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── size → int
│ │ ├── PhotoCachedSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── bytes → bytes
│ │ ├── PhotoStrippedSize
│ │ │ ├── type → string
│ │ │ └── bytes → bytes
│ │ ├── PhotoSizeProgressive
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ └── sizes → Vector < int >
│ │ └── PhotoPathSize
│ │ ├── type → string
│ │ └── bytes → bytes
│ ├── video_thumbs → Vector < VideoSize > (optional)
│ │ ├── VideoSize
│ │ │ ├── type → string
│ │ │ ├── w → int
│ │ │ ├── h → int
│ │ │ ├── size → int
│ │ │ └── video_start_ts → double (optional)
│ │ ├── VideoSizeEmojiMarkup
│ │ │ ├── emoji_id → long
│ │ │ └── background_colors → Vector < int >
│ │ └── VideoSizeStickerMarkup
│ │ ├── stickerset → InputStickerSet
│ │ │ ├── InputStickerSetEmpty
│ │ │ ├── InputStickerSetID
│ │ │ ├── InputStickerSetShortName
│ │ │ ├── InputStickerSetAnimatedEmoji
│ │ │ ├── InputStickerSetDice
│ │ │ ├── InputStickerSetAnimatedEmojiAnimations
│ │ │ ├── InputStickerSetPremiumGifts
│ │ │ ├── InputStickerSetEmojiGenericAnimations
│ │ │ ├── InputStickerSetEmojiDefaultStatuses
│ │ │ ├── InputStickerSetEmojiDefaultTopicIcons
│ │ │ ├── InputStickerSetEmojiChannelDefaultStatuses
│ │ │ └── InputStickerSetTonGifts
│ │ ├── sticker_id → long
│ │ └── background_colors → Vector < int >
│ ├── dc_id → int
│ └── attributes → Vector < DocumentAttribute >
│ ├── DocumentAttributeImageSize
│ │ ├── w → int
│ │ └── h → int
│ ├── DocumentAttributeAnimated
│ ├── DocumentAttributeSticker
│ │ ├── mask → true (optional)
│ │ ├── alt → string
│ │ ├── stickerset → InputStickerSet
│ │ │ ├── InputStickerSetEmpty
│ │ │ ├── InputStickerSetID
│ │ │ ├── InputStickerSetShortName
│ │ │ ├── InputStickerSetAnimatedEmoji
│ │ │ ├── InputStickerSetDice
│ │ │ ├── InputStickerSetAnimatedEmojiAnimations
│ │ │ ├── InputStickerSetPremiumGifts
│ │ │ ├── InputStickerSetEmojiGenericAnimations
│ │ │ ├── InputStickerSetEmojiDefaultStatuses
│ │ │ ├── InputStickerSetEmojiDefaultTopicIcons
│ │ │ ├── InputStickerSetEmojiChannelDefaultStatuses
│ │ │ └── InputStickerSetTonGifts
│ │ └── mask_coords → MaskCoords (optional)
│ │ └── MaskCoords
│ ├── DocumentAttributeVideo
│ │ ├── round_message → true (optional)
│ │ ├── supports_streaming → true (optional)
│ │ ├── nosound → true (optional)
│ │ ├── duration → double
│ │ ├── w → int
│ │ ├── h → int
│ │ ├── preload_prefix_size → int (optional)
│ │ ├── video_start_ts → double (optional)
│ │ └── video_codec → string (optional)
│ ├── DocumentAttributeAudio
│ │ ├── voice → true (optional)
│ │ ├── duration → int
│ │ ├── title → string (optional)
│ │ ├── performer → string (optional)
│ │ └── waveform → bytes (optional)
│ ├── DocumentAttributeFilename
│ │ └── file_name → string
│ ├── DocumentAttributeHasStickers
│ └── DocumentAttributeCustomEmoji
│ ├── free → true (optional)
│ ├── text_color → true (optional)
│ ├── alt → string
│ └── stickerset → InputStickerSet
│ ├── InputStickerSetEmpty
│ ├── InputStickerSetID
│ ├── InputStickerSetShortName
│ ├── InputStickerSetAnimatedEmoji
│ ├── InputStickerSetDice
│ ├── InputStickerSetAnimatedEmojiAnimations
│ ├── InputStickerSetPremiumGifts
│ ├── InputStickerSetEmojiGenericAnimations
│ ├── InputStickerSetEmojiDefaultStatuses
│ ├── InputStickerSetEmojiDefaultTopicIcons
│ ├── InputStickerSetEmojiChannelDefaultStatuses
│ └── InputStickerSetTonGifts
├── stars → long
├── availability_remains → int (optional)
├── availability_total → int (optional)
├── availability_resale → long (optional)
├── convert_stars → long
├── first_sale_date → int (optional)
├── last_sale_date → int (optional)
├── upgrade_stars → long (optional)
├── resell_min_stars → long (optional)
├── title → string (optional)
├── released_by → Peer (optional)
│ ├── PeerUser
│ │ └── user_id → long
│ ├── PeerChat
│ │ └── chat_id → long
│ └── PeerChannel
│ └── channel_id → long
├── per_user_total → int (optional)
├── per_user_remains → int (optional)
├── locked_until_date → int (optional)
├── auction_slug → string (optional)
├── gifts_per_round → int (optional)
├── auction_start_date → int (optional)
├── upgrade_variants → int (optional)
└── background → StarGiftBackground (optional)
└── StarGiftBackground
├── center_color → int
├── edge_color → int
└── text_color → int

Example

StarGift(
    limited=None,
    sold_out=None,
    birthday=None,
    require_premium=None,
    limited_per_user=None,
    peer_color_available=None,
    auction=None,
    id=0,
    sticker=DocumentEmpty(id=0),
    stars=0,
    availability_remains=0,
    availability_total=0,
    availability_resale=0,
    convert_stars=0,
    first_sale_date=0,
    last_sale_date=0,
    upgrade_stars=0,
    resell_min_stars=0,
    title="text",
    released_by=PeerUser(user_id=0),
    per_user_total=0,
    per_user_remains=0,
    locked_until_date=0,
    auction_slug="text",
    gifts_per_round=0,
    auction_start_date=0,
    upgrade_variants=0,
    background=StarGiftBackground(
        center_color=0,
        edge_color=0,
        text_color=0
    ),
)