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

    Class ShippingQueryHandler<C, R>

    Handler for incoming shipping queries (shipping_query updates).

    Allows providing available shipping options based on the delivery address provided by the user.

    const handler = new ShippingQueryHandler(async (update, context) => {
      await context.bot.answerShippingQuery({
        shipping_query_id: update.shipping_query!.id,
        ok: true,
        shipping_options: [
          { id: "std", title: "Standard Delivery", prices: [{ label: "Shipping", amount: 200 }] },
        ],
      });
    });

    Type Parameters

    Hierarchy (View Summary)

    Index
    constructor
    callback
    checkUpdate handleUpdate

    • Creates a new handler instance.

      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

      • callback: HandlerCallback<C, R>

        Async function executed when this handler matches an update.

      Returns ShippingQueryHandler<C, R>

    callback: HandlerCallback<C, R>

    The underlying callback function to invoke on match.

    • Checks whether the incoming update contains a shipping_query.

      Parameters

      • update: Update

        The update to test.

      Returns Promise<boolean>

      true if update has shipping_query.

    • Executes the registered handler callback with the given update and context.

      Parameters

      • update: Update

        The Telegram update to process.

      • context: C

        Callback context instance.

      Returns Promise<R>

      The value returned by the callback function.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods