GramIO API Reference / gramio/dist / TelegramMessageEntity
Interface: TelegramMessageEntity
Defined in: @gramio/types/out/objects.d.ts:1001
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
custom_emoji_id? | string | Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker | @gramio/types/out/objects.d.ts:1029 |
date_time_format? | string | Optional. For “date_time” only, the string that defines the formatting of the date and time. See date-time entity formatting for more details. | @gramio/types/out/objects.d.ts:1037 |
language? | string | Optional. For “pre” only, the programming language of the entity text | @gramio/types/out/objects.d.ts:1025 |
length | number | Length of the entity in UTF-16 code units | @gramio/types/out/objects.d.ts:1013 |
offset | number | Offset in UTF-16 code units to the start of the entity | @gramio/types/out/objects.d.ts:1009 |
type | TelegramMessageEntityType | 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) | @gramio/types/out/objects.d.ts:1005 |
unix_time? | number | Optional. For “date_time” only, the Unix time associated with the entity | @gramio/types/out/objects.d.ts:1033 |
url? | string | Optional. For “text_link” only, URL that will be opened after user taps on the text | @gramio/types/out/objects.d.ts:1017 |
user? | TelegramUser | Optional. For “text_mention” only, the mentioned user | @gramio/types/out/objects.d.ts:1021 |