Constructor: availableEffect
Represents a message effect ».
All long IDs except for id are document.ids from the containing messages.availableEffects constructor.
See here » for more info on how to use following fields.
Attributes:
| Name | Type | Required | Description |
|---|---|---|---|
| premium_required | Bool | Optional | Whether a Premium subscription is required to use this effect. |
| id | long | Yes | Unique effect ID. |
| emoticon | string | Yes | Emoji corresponding to the effect, to be used as icon for the effect if static_icon_id is not set. |
| static_icon_id | long | Optional | ID of the document containing the static icon (WEBP) of the effect. |
| effect_sticker_id | long | Yes | Contains the preview animation (TGS format »), used for the effect selection menu. |
| effect_animation_id | long | Optional | If set, contains the actual animated effect (TGS format »). If not set, the animated effect must be set equal to the premium animated sticker effect associated to the animated sticker specified in effect_sticker_id (always different from the preview animation, fetched thanks to the videoSize of type f as specified here »). |
Type: AvailableEffect
Example:
$availableEffect = ['_' => 'availableEffect', 'premium_required' => Bool, 'id' => long, 'emoticon' => 'string', 'static_icon_id' => long, 'effect_sticker_id' => long, 'effect_animation_id' => long];