class

Tourmaline::MessageEntity

Inherits JSON::Serializable / Reference / Object

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

Constructors

new(type : String, offset : Int32 | Int64, length : Int32 | Int64, url : String | Nil = nil, user : Tourmaline::User | Nil = nil, language : String | Nil = nil, custom_emoji_id : String | Nil = nil)

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

custom_emoji_id

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

custom_emoji_id=(custom_emoji_id : String | Nil)

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

language

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

language=(language : String | Nil)

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

length

Length of the entity in UTF-16 code units

length=(length : Int32 | Int64)

Length of the entity in UTF-16 code units

offset

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

offset=(offset : Int32 | Int64)

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

type

Type of the entity. Currently, can be "mention" (@username), "hashtag" (#hashtag), "cashtag" ($USD), "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), "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)

type=(type : String)

Type of the entity. Currently, can be "mention" (@username), "hashtag" (#hashtag), "cashtag" ($USD), "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), "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

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

url=(url : String | Nil)

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

user

Optional. For "text_mention" only, the mentioned user

user=(user : Tourmaline::User | Nil)

Optional. For "text_mention" only, the mentioned user