Class MessageEntities

constructor

• new MessageEntities(client, searchText, entities): MessageEntities

• Creates an instance of the MessageEntities class.

  Parameters

  • client: TelegramClient | BaseClient

    The client that instantiated this.
  • searchText: string

    The text to search within.
  • entities: MessageEntity[]

    The array of message entities.

  Returns MessageEntities

ReadonlysearchText

blockquote

• get blockquote(): SearchResult[]

• Retrieves all blockquote entities from the message.

  Returns SearchResult[]

  An array of objects representing blockquote entities.

bold

• get bold(): SearchResult[]

• Retrieves all bold entities from the message.

  Returns SearchResult[]

  An array of objects representing bold entities.

botCommand

• get botCommand(): SearchResult[]

• Retrieves all bot command entities from the message.

  Returns SearchResult[]

  An array of objects representing bot command entities.

cashtag

• get cashtag(): SearchResult[]

• Retrieves all cashtag entities from the message.

  Returns SearchResult[]

  An array of objects representing cashtag entities.

code

• get code(): SearchResult[]

• Retrieves all code entities from the message.

  Returns SearchResult[]

  An array of objects representing code entities.

customEmoji

• get customEmoji(): (SearchResult & {
      customEmojiId: string;
  })[]

• Retrieves all custom emoji entities from the message.

  Returns (SearchResult & {
      customEmojiId: string;
  })[]

  An array of objects representing custom emoji entities.

email

• get email(): SearchResult[]

• Retrieves all email entities from the message.

  Returns SearchResult[]

  An array of objects representing email entities.

hashtag

• get hashtag(): SearchResult[]

• Retrieves all hashtag entities from the message.

  Returns SearchResult[]

  An array of objects representing hashtag entities.

italic

• get italic(): SearchResult[]

• Retrieves all italic entities from the message.

  Returns SearchResult[]

  An array of objects representing italic entities.

mention

• get mention(): SearchResult[]

• Retrieves all mention entities from the message.

  Returns SearchResult[]

  An array of objects representing mention entities.

phoneNumber

• get phoneNumber(): SearchResult[]

• Retrieves all phone number entities from the message.

  Returns SearchResult[]

  An array of objects representing phone number entities.

pre

• get pre(): (SearchResult & {
      language?: string;
  })[]

• Retrieves all pre entities from the message.

  Returns (SearchResult & {
      language?: string;
  })[]

  An array of objects representing pre entities.

spoiler

• get spoiler(): SearchResult[]

• Retrieves all spoiler entities from the message.

  Returns SearchResult[]

  An array of objects representing spoiler entities.

strikethrough

• get strikethrough(): SearchResult[]

• Retrieves all strikethrough entities from the message.

  Returns SearchResult[]

  An array of objects representing strikethrough entities.

textLink

• get textLink(): (SearchResult & {
      url: string;
  })[]

• Retrieves all text link entities from the message.

  Returns (SearchResult & {
      url: string;
  })[]

  An array of objects representing text link entities.

textMention

• get textMention(): (SearchResult & {
      user: User;
  })[]

• Retrieves all text mention entities from the message.

  Returns (SearchResult & {
      user: User;
  })[]

  An array of objects representing text mention entities.

underline

• get underline(): SearchResult[]

• Retrieves all underline entities from the message.

  Returns SearchResult[]

  An array of objects representing underline entities.

url

• get url(): SearchResult[]

• Retrieves all URL entities from the message.

  Returns SearchResult[]

  An array of objects representing URL entities.

[iterator]

• [iterator](): Generator<never, any, unknown>

• Enables iteration over the message entities.

  Returns Generator<never, any, unknown>

  An iterator over the message entities.

searchEntity

• searchEntity(searchType): (SearchResult & (
      | {
          language?: string;
      }
      | {
          url: string;
      }
      | {
          user: User;
      }
      | {
          customEmojiId: string;
      }))[]

• Searches for a specific type of entity in the message.

  Parameters

  • searchType:
        | "bold"
        | "url"
        | "code"
        | "phone_number"
        | "email"
        | "mention"
        | "hashtag"
        | "cashtag"
        | "bot_command"
        | "italic"
        | "underline"
        | "strikethrough"
        | "spoiler"
        | "blockquote"
        | "pre"
        | "text_link"
        | "text_mention"
        | "custom_emoji"

    The type of entity to search for.

  Returns (SearchResult & (
      | {
          language?: string;
      }
      | {
          url: string;
      }
      | {
          user: User;
      }
      | {
          customEmojiId: string;
      }))[]

  An array of objects representing the found entities.