telegramsjs
    Preparing search index...

    Class MessageEntities

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    searchText

    Accessors

    blockquote bold botCommand cashtag client code customEmoji email hashtag italic mention phoneNumber pre spoiler strikethrough textLink textMention underline url

    Methods

    _clone _patch _update [iterator] searchEntity toJSON valueOf

    Constructors

    Properties

    searchText: string

    The text to search within.

    Accessors

    • get blockquote(): ReadonlyCollection<number, SearchResult>

      Retrieves all blockquote entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      An array of objects representing blockquote entities.

    • get bold(): ReadonlyCollection<number, SearchResult>

      Retrieves all bold entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of bold entities.

    • get botCommand(): ReadonlyCollection<number, SearchResult>

      Retrieves all bot command entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of bot command entities.

    • get cashtag(): ReadonlyCollection<number, SearchResult>

      Retrieves all cashtag entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of cashtag entities.

    • get code(): ReadonlyCollection<number, SearchResult>

      Retrieves all code entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of code entities.

    • get customEmoji(): ReadonlyCollection<
          number,
          SearchResult & { customEmojiId: string },
      >

      Retrieves all custom emoji entities from the message.

      Returns ReadonlyCollection<number, SearchResult & { customEmojiId: string }>

      A collection of custom emoji entities.

    • get email(): ReadonlyCollection<number, SearchResult>

      Retrieves all email entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of email entities.

    • get hashtag(): ReadonlyCollection<number, SearchResult>

      Retrieves all hashtag entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of hashtag entities.

    • get italic(): ReadonlyCollection<number, SearchResult>

      Retrieves all italic entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of italic entities.

    • get mention(): ReadonlyCollection<number, SearchResult>

      Retrieves all mention entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of mention entities.

    • get phoneNumber(): ReadonlyCollection<number, SearchResult>

      Retrieves all phone number entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of phone number entities.

    • get pre(): ReadonlyCollection<
          number,
          SearchResult & { language?: LanguageCode },
      >

      Retrieves all pre entities from the message.

      Returns ReadonlyCollection<number, SearchResult & { language?: LanguageCode }>

      A collection of pre entities.

    • get spoiler(): ReadonlyCollection<number, SearchResult>

      Retrieves all spoiler entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of spoiler entities.

    • get strikethrough(): ReadonlyCollection<number, SearchResult>

      Retrieves all strikethrough entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of strikethrough entities.

    • Retrieves all text link entities from the message.

      Returns ReadonlyCollection<number, SearchResult & { url: string }>

      A collection of text link entities.

    • get textMention(): ReadonlyCollection<number, SearchResult & { user: User }>

      Retrieves all text mention entities from the message.

      Returns ReadonlyCollection<number, SearchResult & { user: User }>

      A collection of text mention entities.

    • get underline(): ReadonlyCollection<number, SearchResult>

      Retrieves all underline entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of underline entities.

    • get url(): ReadonlyCollection<number, SearchResult>

      Retrieves all URL entities from the message.

      Returns ReadonlyCollection<number, SearchResult>

      A collection of url entities.

    Methods

    Protected_clone

    • _clone(): Base
      Protected

      Creates a clone of the current instance

      Returns Base

      A clone of the current instance

    Protected_patch

    • _patch(data: Record<string, any>): Record<string, any>
      Protected

      Patches the current instance with new data

      Parameters

      • data: Record<string, any>

        The data to patch the instance with

      Returns Record<string, any>

      The patched data

    Protected_update

    • _update(data: Record<string, any>): Base
      Protected

      Updates the current instance with new data and returns a clone of the updated instance

      Parameters

      • data: Record<string, any>

        The data to update the instance with

      Returns Base

      A clone of the updated instance

    • Enables iteration over the message entities.

      Returns Generator<SearchResult & (never)>

      An iterator over the message entities.

    • Parameters

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

      Returns ReadonlyCollection<
          number,
          SearchResult & (
              | { language?: LanguageCode | undefined }
              | { url: string }
              | { user: User }
              | { customEmojiId: string }
          ),
      >

    • Flatten an object. Any properties that are collections will get converted to an array of keys.

      Parameters

      • OptionalpropsRecursive: boolean

        Optional. If true, calls toJSON method on nested objects.

      • ...props: Record<string, string | boolean>[]

        Optional. Specific properties to include/exclude, or rename.

      Returns Record<string, any>

      Flattened object.

    • Returns the id instance Chat, User, ChatMember and other

      Returns string | null

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods