telegram.Sticker

class telegram.Sticker(file_id, file_unique_id, width, height, is_animated, thumb=None, emoji=None, file_size=None, set_name=None, mask_position=None, bot=None, **_kwargs)

Bases: telegram.base.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.

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.

  • width (int) – Sticker width.

  • height (int) – Sticker height.

  • is_animated (bool) – True, if the sticker is animated.

  • thumb (telegram.PhotoSize, optional) – Sticker thumbnail in the .WEBP or .JPG format.

  • emoji (str, optional) – Emoji associated with the sticker

  • 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.

  • file_size (int, optional) – File size.

  • bot (telegram.Bot, optional) – The Bot to use for instance methods.

  • (obj (**kwargs) – dict): Arbitrary keyword arguments.

file_id

Identifier for this file.

Type

str

file_unique_id

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

str

width

Sticker width.

Type

int

height

Sticker height.

Type

int

is_animated

True, if the sticker is animated.

Type

bool

thumb

Optional. Sticker thumbnail in the .webp or .jpg format.

Type

telegram.PhotoSize

emoji

Optional. Emoji associated with the sticker.

Type

str

set_name

Optional. Name of the sticker set to which the sticker belongs.

Type

str

mask_position

Optional. For mask stickers, the position where the mask should be placed.

Type

telegram.MaskPosition

file_size

Optional. File size.

Type

int

bot

Optional. The Bot to use for instance methods.

Type

telegram.Bot

get_file(timeout=None, api_kwargs=None)

Convenience wrapper over telegram.Bot.get_file

For the documentation of the arguments, please see telegram.Bot.get_file().

Returns

telegram.File

Raises

telegram.error.TelegramError –

Parameters

  • timeout (Optional[Union[DefaultValue[DVType], float]]) –

  • api_kwargs (Dict[str, Any]) –

Return type

File