pro.zackpollard.telegrambot.api.chat.message.content.type

Interface MessageEntity

All Known Implementing Classes:

MessageEntityImpl

public interface MessageEntity

Author:

zackp

Method Summary

Modifier and Type	Method and Description
int	getLength() Gets the length of the entity in UTF-16 code units
int	getOffset() Gets the offset in UTF-16 code units to the start of the entity
MessageEntityType	getType() Gets the MessageEntityType that this MessageEntity relates to.
String	getUrl() Gets the URL that the MessageEntity refers to.
User	getUser() Gets the User that the MessageEntity refers to.

Method Detail

getType

MessageEntityType getType()

Gets the MessageEntityType that this MessageEntity relates to. Can be mention (@username), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs), text_mention (for users without usernames)

Returns:

The MessageEntityType of this MessageEntity

getOffset

int getOffset()

Gets the offset in UTF-16 code units to the start of the entity

Returns:

The offset to the start of the entity

getLength

int getLength()

Gets the length of the entity in UTF-16 code units

Returns:

The length of the entity

getUrl

String getUrl()

Gets the URL that the MessageEntity refers to. For "text_link" only, urlthat will be opened after user taps on the text. Can be null

Returns:

The URL that the MessageEntity refers to or null if the MessageEntityType isn't a TEXT_LINK

getUser

User getUser()

Gets the User that the MessageEntity refers to. For "text_mention" only. Can be null

Returns:

The User that the MessageEntity refers to or null if the MessageEntityType isn't TEXT_MENTION