MessageEntity Class
extends BaseRepresents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
Properties
client: ClientcustomEmojiId: stringlanguage: stringlength: numberoffset: numbertype: MessageEntityTypeurl: stringuser: User
Methods
toJSON()
{
"id": 1625,
"name": "MessageEntity",
"variant": "declaration",
"kind": 128,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Represents one special entity in a text message. For example, hashtags, usernames, URLs, etc."
}
]
},
"children": [
{
"id": 1626,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 37,
"character": 1
}
],
"signatures": [
{
"id": 1627,
"name": "new MessageEntity",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 37,
"character": 1
}
],
"parameters": [
{
"id": 1628,
"name": "client",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 1,
"name": "Client",
"package": "tgkit",
"qualifiedName": "default"
}
},
{
"id": 1629,
"name": "data",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"target": 1625,
"name": "MessageEntity",
"package": "tgkit",
"qualifiedName": "default"
},
"overwrites": {
"type": "reference",
"target": -1,
"name": "Base.constructor"
}
}
],
"overwrites": {
"type": "reference",
"target": -1,
"name": "Base.constructor"
}
},
{
"id": 1639,
"name": "client",
"variant": "declaration",
"kind": 1024,
"flags": {
"isInherited": true
},
"sources": [
{
"fileName": "packages/tgkit/src/structures/Base.ts",
"line": 4,
"character": 1
}
],
"type": {
"type": "reference",
"target": 1,
"name": "Client",
"package": "tgkit",
"qualifiedName": "default"
},
"inheritedFrom": {
"type": "reference",
"target": -1,
"name": "Base.client"
}
},
{
"id": 1636,
"name": "customEmojiId",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "For 'customEmoji' only, unique identifier of the custom emoji.\nUse "
},
{
"kind": "code",
"text": "`<Client>.getCustomEmojiStickers`"
},
{
"kind": "text",
"text": " to get full information about the sticker."
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 34,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1635,
"name": "language",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "For 'pre' only, the programming language of the entity text"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 28,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1632,
"name": "length",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Length of the entity in UTF-16 code units"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 19,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 1631,
"name": "offset",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Offset in UTF-16 code units to the start of the entity"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 16,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 1630,
"name": "type",
"variant": "declaration",
"kind": 1024,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Type of the entity"
}
],
"blockTags": [
{
"tag": "@see",
"content": [
{
"kind": "inline-tag",
"tag": "@link",
"text": "https://core.telegram.org/bots/api#messageentity",
"target": "https://core.telegram.org/bots/api#messageentity"
}
]
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 13,
"character": 1
}
],
"type": {
"type": "reference",
"target": 2087,
"name": "MessageEntityType",
"package": "tgkit"
}
},
{
"id": 1633,
"name": "url",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "For 'textLink' only, url that will be opened after user taps on the text"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 22,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 1634,
"name": "user",
"variant": "declaration",
"kind": 1024,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "For 'textMention' only, the mentioned user"
}
]
},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 25,
"character": 1
}
],
"type": {
"type": "reference",
"target": 1888,
"name": "User",
"package": "tgkit",
"qualifiedName": "default"
}
},
{
"id": 1637,
"name": "toJSON",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 49,
"character": 1
}
],
"signatures": [
{
"id": 1638,
"name": "toJSON",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 49,
"character": 1
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [
1626
]
},
{
"title": "Properties",
"children": [
1639,
1636,
1635,
1632,
1631,
1630,
1633,
1634
]
},
{
"title": "Methods",
"children": [
1637
]
}
],
"sources": [
{
"fileName": "packages/tgkit/src/structures/MessageEntity.ts",
"line": 8,
"character": 21
}
],
"extendedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "packages/tgkit/src/structures/Base.ts",
"qualifiedName": "default"
},
"name": "default",
"package": "tgkit"
}
]
}