telegram.MessageEntity¶

class telegram.MessageEntity(type, offset, length, url=None, user=None, language=None, custom_emoji_id=None, **_kwargs)¶

Bases: telegram.base.TelegramObject

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their type, offset and length are equal.

Parameters

type (str) –
Type of the entity. Currently, can be mention (@username), hashtag, bot_command, url, email, phone_number, bold (bold text), italic (italic text), strikethrough, spoiler (spoiler message), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs), text_mention (for users without usernames), custom_emoji (for inline custom emoji stickers).

New in version 13.14: added inline custom emoji
offset (int) – Offset in UTF-16 code units to the start of the entity.
length (int) – Length of the entity in UTF-16 code units.
url (str, optional) – For TEXT_LINK only, url that will be opened after user taps on the text.
user (telegram.User, optional) – For TEXT_MENTION only, the mentioned user.
language (str, optional) –

For PRE only, the programming language of
the entity text.

custom_emoji_id (str, optional): For CUSTOM_EMOJI only, unique identifier
of the custom emoji. Use telegram.Bot.get_custom_emoji_stickers() to get full information about the sticker.

New in version 13.14.

type¶

Type of the entity.

Type: str

offset¶

Offset in UTF-16 code units to the start of the entity.

Type: int

length¶

Length of the entity in UTF-16 code units.

Type: int

url¶

Optional. Url that will be opened after user taps on the text.

Type: str

user¶

Optional. The mentioned user.

Type: telegram.User

language¶

Optional. Programming language of the entity text.

Type: str

custom_emoji_id¶

Optional. Unique identifier of the custom emoji.

New in version 13.14.

Type: str

ALL_TYPES: ClassVar[List[str]] = ['mention', 'hashtag', 'cashtag', 'phone_number', 'bot_command', 'url', 'email', 'bold', 'italic', 'code', 'pre', 'text_link', 'text_mention', 'underline', 'strikethrough', 'spoiler', 'custom_emoji']¶

telegram.constants.MESSAGEENTITY_ALL_TYPES

List of all the types

BOLD: ClassVar[str] = 'bold'¶: telegram.constants.MESSAGEENTITY_BOLD

BOT_COMMAND: ClassVar[str] = 'bot_command'¶: telegram.constants.MESSAGEENTITY_BOT_COMMAND

CASHTAG: ClassVar[str] = 'cashtag'¶: telegram.constants.MESSAGEENTITY_CASHTAG

CODE: ClassVar[str] = 'code'¶: telegram.constants.MESSAGEENTITY_CODE

CUSTOM_EMOJI: ClassVar[str] = 'custom_emoji'¶: telegram.constants.MESSAGEENTITY_CUSTOM_EMOJI

New in version 13.14.

EMAIL: ClassVar[str] = 'email'¶: telegram.constants.MESSAGEENTITY_EMAIL

HASHTAG: ClassVar[str] = 'hashtag'¶: telegram.constants.MESSAGEENTITY_HASHTAG

ITALIC: ClassVar[str] = 'italic'¶: telegram.constants.MESSAGEENTITY_ITALIC

MENTION: ClassVar[str] = 'mention'¶: telegram.constants.MESSAGEENTITY_MENTION

PHONE_NUMBER: ClassVar[str] = 'phone_number'¶: telegram.constants.MESSAGEENTITY_PHONE_NUMBER

PRE: ClassVar[str] = 'pre'¶: telegram.constants.MESSAGEENTITY_PRE

SPOILER: ClassVar[str] = 'spoiler'¶: telegram.constants.MESSAGEENTITY_SPOILER

New in version 13.10.

STRIKETHROUGH: ClassVar[str] = 'strikethrough'¶: telegram.constants.MESSAGEENTITY_STRIKETHROUGH

TEXT_LINK: ClassVar[str] = 'text_link'¶: telegram.constants.MESSAGEENTITY_TEXT_LINK

TEXT_MENTION: ClassVar[str] = 'text_mention'¶: telegram.constants.MESSAGEENTITY_TEXT_MENTION

UNDERLINE: ClassVar[str] = 'underline'¶: telegram.constants.MESSAGEENTITY_UNDERLINE

URL: ClassVar[str] = 'url'¶: telegram.constants.MESSAGEENTITY_URL

classmethod de_json(data, bot)¶: See telegram.TelegramObject.de_json().