Telegram Bot/eu.vendeli.tgbot.types.msg/MessageEntity

MessageEntity

@Serializable

data class MessageEntity(val type: EntityType, val offset: Int, val length: Int, val url: String? = null, val user: User? = null, val language: String? = null, val customEmojiId: String? = null)

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

Api reference

Constructors

MessageEntity

constructor(type: EntityType, offset: Int, length: Int, url: String? = null, user: User? = null, language: String? = null, customEmojiId: String? = null)

Properties

customEmojiId

val customEmojiId: String? = null

Optional. For "custom_emoji" only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker

language

val language: String? = null

Optional. For "pre" only, the programming language of the entity text

length

val length: Int

Length of the entity in UTF-16 code units

offset

val offset: Int

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

type

val type: EntityType

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)

url

val url: String? = null

Optional. For "text_link" only, URL that will be opened after user taps on the text

user

val user: User? = null

Optional. For "text_mention" only, the mentioned user