peyk.platforms.telegram.types.message_entity

Classes

MessageEntity(type, offset, length[, url, ...])

This object represents one special entity in a text message.
class peyk.platforms.telegram.types.message_entity.MessageEntity(type: str, offset: int, length: int, url: str | None = None, user: User | None = None, language: str | None = None, custom_emoji_id: str | None = None)[source]

Bases: object

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

Variables:

  • type (str) – Type of the entity. Currently, can be ‘mention’ (@username), ‘hashtag’ (#hashtag or #hashtag@chatusername), ‘cashtag’ ($USD or $USD@chatusername), ‘bot_command’ (/start@jobs_bot), ‘url’ (https://telegram.org), ‘email’ (do-not-reply@telegram.org), ‘phone_number’ (+1-212-555-0123), ‘bold’ (bold text), ‘italic’ (italic text), ‘underline’ (underlined text), ‘strikethrough’ (strikethrough text), ‘spoiler’ (spoiler message), ‘blockquote’ (block quotation), ‘expandable_blockquote’ (collapsed-by-default block quotation), ‘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), or ‘date_time’ (for formatted date and time).

  • 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 | None) – For ‘text_link’ only, URL that will be opened after user taps on the text

  • user (peyk.platforms.telegram.types.user.User | None) – For ‘text_mention’ only, the mentioned user

  • language (str | None) – For ‘pre’ only, the programming language of the entity text

  • custom_emoji_id (str | None) – For ‘custom_emoji’ only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker.

  • unix_time – For ‘date_time’ only, the Unix time associated with the entity

  • date_time_format – For ‘date_time’ only, the string that defines the formatting of the date and time. See date-time entity formatting for more details.

type: str
offset: int
length: int
url: str | None = None
user: User | None = None
language: str | None = None
custom_emoji_id: str | None = None
classmethod from_dict(data: dict | None) → MessageEntity | None[source]

Parse a Telegram API mapping into this type.

Parameters:

data – Raw Telegram API mapping, or None.

Returns:

Parsed type instance, or None when data is None.

classmethod list_from(data: List[dict] | None) → List[MessageEntity] | None[source]

Parse a Telegram API result list into this type.

Parameters:

data – Raw result list, or None.

Returns:

Parsed type instances.

to_dict() → Dict[str, object][source]

Serialize for outgoing request bodies (T2: send/edit params).

Returns:

The operation result (Dict[str, object]).