class MessageEntity

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

Methods

__construct(string $type, int $offset, int $length, string|null $url = null, User|null $user = null, string|null $language = null, string|null $custom_emoji_id = null)

No description

string
getType()

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).

int
getOffset()

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

int
getLength()

Length of the entity in UTF-16 code units.

string|null
getUrl()

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

User|null
getUser()

Optional. For “text_mention” only, the mentioned user.

string|null
getLanguage()

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

string|null
getCustomEmojiId()

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

Details

at line 19
__construct(string $type, int $offset, int $length, string|null $url = null, User|null $user = null, string|null $language = null, string|null $custom_emoji_id = null)

No description

Parameters

string $type
int $offset
int $length
string|null $url
User|null $user
string|null $language
string|null $custom_emoji_id

at line 33
string getType()

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).

Return Value

string

at line 41
int getOffset()

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

Return Value

int

at line 49
int getLength()

Length of the entity in UTF-16 code units.

Return Value

int

at line 57
string|null getUrl()

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

Return Value

string|null

at line 65
User|null getUser()

Optional. For “text_mention” only, the mentioned user.

Return Value

User|null

at line 73
string|null getLanguage()

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

Return Value

string|null

at line 81
string|null getCustomEmojiId()

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

Return Value

string|null