MessageEntity

data class MessageEntity(offset: Int, length: Int, url: String?, user: User?, language: String?, type: String)

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

Parameters

offset

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

length

Length of the entity in UTF-16 code units

url

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

language

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

type

Type of the entity. 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), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)

Constructors

MessageEntity
Link copied to clipboard
common
fun MessageEntity(offset: Int, length: Int, url: String? = null, user: User? = null, language: String? = null, type: String)
Offset in UTF-16 code units to the start of the entity

Functions

component1
Link copied to clipboard
common
operator fun component1(): Int
component2
Link copied to clipboard
common
operator fun component2(): Int
component3
Link copied to clipboard
common
operator fun component3(): String?
component4
Link copied to clipboard
common
operator fun component4(): User?
component5
Link copied to clipboard
common
operator fun component5(): String?
component6
Link copied to clipboard
common
operator fun component6(): String
copy
Link copied to clipboard
common
fun copy(offset: Int, length: Int, url: String? = null, user: User? = null, language: String? = null, type: String): MessageEntity
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

language
Link copied to clipboard
common
val language: String? = null
Optional.
length
Link copied to clipboard
common
val length: Int
Length of the entity in UTF-16 code units
offset
Link copied to clipboard
common
val offset: Int
Offset in UTF-16 code units to the start of the entity
type
Link copied to clipboard
common
val type: String
Type of the entity.
url
Link copied to clipboard
common
val url: String? = null
Optional.
user
Link copied to clipboard
common
val user: User? = null
Optional.