telegram.Sticker¶
- class telegram.Sticker(file_id, file_unique_id, width, height, is_animated, is_video, type, thumb=None, emoji=None, file_size=None, set_name=None, mask_position=None, premium_animation=None, custom_emoji_id=None, *, api_kwargs=None)[source]¶
Bases:
telegram.TelegramObject
This object represents a sticker.
Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
file_unique_id
is equal.Note
As of v13.11
is_video
is a required argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly.- Parameters
file_id (
str
) – Identifier for this file, which can be used to download or reuse the file.file_unique_id (
str
) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.is_animated (
bool
) –True
, if the sticker is animated.True
, if the sticker is a video sticker.New in version 13.11.
Type of the sticker. Currently one of
REGULAR
,MASK
,CUSTOM_EMOJI
. The type of the sticker is independent from its format, which is determined by the fieldsis_animated
andis_video
.New in version 20.0.
thumb (
telegram.PhotoSize
, optional) – Sticker thumbnail in the.WEBP
or.JPG
format.set_name (
str
, optional) – Name of the sticker set to which the sticker belongs.mask_position (
telegram.MaskPosition
, optional) – For mask stickers, the position where the mask should be placed.premium_animation (
telegram.File
, optional) –For premium regular stickers, premium animation for the sticker.
New in version 20.0.
custom_emoji_id (
str
, optional) –For custom emoji stickers, unique identifier of the custom emoji.
New in version 20.0.
- file_unique_id[source]¶
Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.
- Type
- type[source]¶
Type of the sticker. Currently one of
REGULAR
,MASK
,CUSTOM_EMOJI
. The type of the sticker is independent from its format, which is determined by the fieldsis_animated
andis_video
.New in version 20.0.
- Type
Optional. For premium regular stickers, premium animation for the sticker.
New in version 20.0.
- Type
- custom_emoji_id[source]¶
Optional. For custom emoji stickers, unique identifier of the custom emoji.
New in version 20.0.
- Type
- async get_file(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Convenience wrapper over
telegram.Bot.get_file
For the documentation of the arguments, please see
telegram.Bot.get_file()
.- Returns
- Raises