telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Class InlineQueryHandler<C, R>

    Handler for Telegram inline queries triggered when a user types @bot query in any chat.

    const inlineHandler = new InlineQueryHandler(/^search:(.+)$/, async (update, context) => {
      const query = update.inline_query!.query;
      await context.bot.answerInlineQuery({
        inline_query_id: update.inline_query!.id,
        results: [],
      });
    });

    Type Parameters

    Hierarchy (View Summary)

    Index
    constructor
    callback pattern?
    checkUpdate handleUpdate

    • Constructs a new InlineQueryHandler.

      Type Parameters

      • C extends CallbackContext<
            Record<string, unknown>,
            Record<string, unknown>,
            Record<string, unknown>,
        > = CallbackContext<
            Record<string, unknown>,
            Record<string, unknown>,
            Record<string, unknown>,
        >

        Type of the callback context.

      • R = unknown

        Return value type.

      Parameters

      • callbackOrPattern:
            | string
            | RegExp
            | HandlerCallback<C, R>
            | ((query: string) => boolean)
            | null
            | undefined

        Callback function or string/RegExp match pattern.

      • OptionalcallbackOrPattern2: string | RegExp | HandlerCallback<C, R> | ((query: string) => boolean) | null

        Callback function or string/RegExp match pattern.

      Returns InlineQueryHandler<C, R>

    callback: HandlerCallback<C, R>

    The underlying callback function to invoke on match.

    pattern?: string | RegExp | ((query: string) => boolean)

    Optional pattern or predicate string/regex matching inline_query.query.

    • Checks whether the update contains a matching inline query.

      Parameters

      • update: Update

        The update to test.

      Returns Promise<boolean>

      true if inline query matches, false otherwise.

    • Populates context.matches if using a RegExp pattern and executes callback.

      Parameters

      • update: Update

        The incoming update.

      • context: C

        Callback context instance.

      Returns Promise<R>

      Result from callback execution.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods