messages.AvailableEffects

class pyrogram.raw.types.messages.AvailableEffects

The full list of usable animated message effects ».

Constructor of AvailableEffects.

Details:

  • Layer: 223

  • ID: BDDB616E

Parameters:

  • hash (int 32-bit) – Hash used for caching, for more info click here

  • effects (List of AvailableEffect) – Message effects

  • documents (List of Document) – Documents specified in the effects constructors.

Functions:

This object can be returned by 1 function.

messages.GetAvailableEffects

Fetch the full list of usable animated message effects ».

TL Schema

messages.availableEffects#bddb616e
hash:int
effects:Vector<AvailableEffect>
documents:Vector<Document>

= messages.AvailableEffects

Parameter Tree

AvailableEffects
├── hash → int
├── effects → Vector < AvailableEffect >
│ └── AvailableEffect
│ ├── premium_required → true (optional)
│ ├── id → long
│ ├── emoticon → string
│ ├── static_icon_id → long (optional)
│ ├── effect_sticker_id → long
│ └── effect_animation_id → long (optional)
└── documents → Vector < 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

Example

AvailableEffects(
    hash=0,
    effects=[
            AvailableEffect(
                id=0,
                emoticon="text",
                effect_sticker_id=0
            )
        ],
    documents=[
            DocumentEmpty(id=0)
        ],
)