StickerSet

class telegram.StickerSet(name, title, stickers, sticker_type, is_animated=None, is_video=None, thumbnail=None, *, api_kwargs=None)[source]

Bases: telegram.TelegramObject

This object represents a sticker set.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their name 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.

Changed in version 20.0: The parameter contains_masks has been removed. Use sticker_type instead.

Changed in version 21.1: The parameters is_video and is_animated are deprecated and now made optional. Thus, the order of the arguments had to be changed.

Changed in version 20.5: Removed the deprecated argument and attribute thumb.

Parameters:
  • name (str) – Sticker set name.

  • title (str) – Sticker set title.

  • is_animated (bool) –

    True, if the sticker set contains animated stickers.

    Deprecated since version 21.1: Bot API 7.2 deprecated this field. This parameter will be removed in a future version of the library.

  • is_video (bool) –

    True, if the sticker set contains video stickers. .. versionadded:: 13.11

    Deprecated since version 21.1: Bot API 7.2 deprecated this field. This parameter will be removed in a future version of the library.

  • stickers (Sequence[telegram.Sticker]) –

    List of all set stickers.

    Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list. The input is converted to a tuple.

  • sticker_type (str) –

    Type of stickers in the set, currently one of telegram.Sticker.REGULAR, telegram.Sticker.MASK, telegram.Sticker.CUSTOM_EMOJI.

    New in version 20.0.

  • thumbnail (telegram.PhotoSize, optional) –

    Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format.

    New in version 20.2.

name[source]

Sticker set name.

Type:

str

title[source]

Sticker set title.

Type:

str

is_animated[source]

True, if the sticker set contains animated stickers.

Deprecated since version 21.1: Bot API 7.2 deprecated this field. This parameter will be removed in a future version of the library.

Type:

bool

is_video[source]

True, if the sticker set contains video stickers. .. versionadded:: 13.11

Deprecated since version 21.1: Bot API 7.2 deprecated this field. This parameter will be removed in a future version of the library.

Type:

bool

stickers[source]

List of all set stickers.

Changed in version 20.0: This attribute is now an immutable tuple.

Type:

Tuple[telegram.Sticker]

sticker_type[source]

Type of stickers in the set, currently one of telegram.Sticker.REGULAR, telegram.Sticker.MASK, telegram.Sticker.CUSTOM_EMOJI.

New in version 20.0.

Type:

str

thumbnail[source]

Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format.

New in version 20.2.

Type:

telegram.PhotoSize

classmethod de_json(data, bot)[source]

See telegram.TelegramObject.de_json().