telegram.MessageEntity

class telegram.MessageEntity(type: str, offset: int, length: int, url: str = None, user: telegram.user.User = None, language: str = 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 :attr`length` are equal.

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
Parameters:
  • type (str) – Type of the entity. Can be mention (@username), hashtag, bot_command, url, email, phone_number, bold (bold text), italic (italic text), strikethrough, code (monowidth string), pre (monowidth block), text_link (for clickable text URLs), text_mention (for users without usernames).
  • 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.
ALL_TYPES = ['mention', 'hashtag', 'cashtag', 'phone_number', 'bot_command', 'url', 'email', 'bold', 'italic', 'code', 'pre', 'text_link', 'text_mention', 'underline', 'strikethrough']

List of all the types.

Type:List[str]
BOLD = 'bold'

‘bold’

Type:str
BOT_COMMAND = 'bot_command'

‘bot_command’

Type:str
CASHTAG = 'cashtag'

‘cashtag’

Type:str
CODE = 'code'

‘code’

Type:str
EMAIL = 'email'

‘email’

Type:str
HASHTAG = 'hashtag'

‘hashtag’

Type:str
ITALIC = 'italic'

‘italic’

Type:str
MENTION = 'mention'

‘mention’

Type:str
PHONE_NUMBER = 'phone_number'

‘phone_number’

Type:str
PRE = 'pre'

‘pre’

Type:str
STRIKETHROUGH = 'strikethrough'

‘strikethrough’

Type:str

‘text_link’

Type:str
TEXT_MENTION = 'text_mention'

‘text_mention’

Type:str
UNDERLINE = 'underline'

‘underline’

Type:str
URL = 'url'

‘url’

Type:str