telegram.ext.ShippingQueryHandler

class telegram.ext.ShippingQueryHandler(callback, pass_update_queue=False, pass_job_queue=False, pass_user_data=False, pass_chat_data=False, run_async=False)

Bases: telegram.ext.handler.Handler[telegram.update.Update]

Handler class to handle Telegram shipping callback queries.

Note

pass_user_data and pass_chat_data determine whether a dict you can use to keep any data in will be sent to the callback function. Related to either the user or the chat that the update was sent in. For each update from the same user or in the same chat, it will be the same dict.

Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for more info.

Warning

When setting run_async to True, you cannot rely on adding custom attributes to telegram.ext.CallbackContext. See its docs for more info.

Parameters

  • callback (callable) –

    The callback function for this handler. Will be called when check_update has determined that an update should be processed by this handler. Callback signature for context based API:

    def callback(update: Update, context: CallbackContext)

    The return value of the callback is usually ignored except for the special case of telegram.ext.ConversationHandler.

  • pass_update_queue (bool, optional) – If set to True, a keyword argument called update_queue will be passed to the callback function. It will be the Queue instance used by the telegram.ext.Updater and telegram.ext.Dispatcher that contains new updates which can be used to insert updates. Default is False. DEPRECATED: Please switch to context based callbacks.

  • pass_job_queue (bool, optional) – If set to True, a keyword argument called job_queue will be passed to the callback function. It will be a telegram.ext.JobQueue instance created by the telegram.ext.Updater which can be used to schedule new jobs. Default is False. DEPRECATED: Please switch to context based callbacks.

  • pass_user_data (bool, optional) – If set to True, a keyword argument called user_data will be passed to the callback function. Default is False. DEPRECATED: Please switch to context based callbacks.

  • pass_chat_data (bool, optional) – If set to True, a keyword argument called chat_data will be passed to the callback function. Default is False. DEPRECATED: Please switch to context based callbacks.

  • run_async (bool) – Determines whether the callback will run asynchronously. Defaults to False.

callback

The callback function for this handler.

Type

callable

pass_update_queue

Determines whether update_queue will be passed to the callback function.

Type

bool

pass_job_queue

Determines whether job_queue will be passed to the callback function.

Type

bool

pass_user_data

Determines whether user_data will be passed to the callback function.

Type

bool

pass_chat_data

Determines whether chat_data will be passed to the callback function.

Type

bool

run_async

Determines whether the callback will run asynchronously.

Type

bool

check_update(update)

Determines whether an update should be passed to this handlers callback.

Parameters

update (telegram.Update | object) – Incoming update.

Returns

bool