Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# InlineQueryResultsButton

class telegram.InlineQueryResultsButton(text, web_app=None, start_parameter=None, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.

  Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their `text`, `web_app` and `start_parameter` are equal.

  Use In

  `telegram.Bot.answer_inline_query()`

  Parameters:

    - text (`str`) – Label text on the button.

    - web_app (`telegram.WebAppInfo`, optional) – Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App.

    - start_parameter (`str`, optional) –

      Deep-linking parameter for the /start message sent to the bot when user presses the switch button. `1`- `64` characters, only `A-Z`, `a-z`, `0-9`, `_` and `-` are allowed.

      Example

      An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot’s inline capabilities.

  text

    Label text on the button.

    Type:

      `str`

  web_app

    Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method `web_app_switch_inline_query` inside the Web App.

    Type:

      `telegram.WebAppInfo`

  start_parameter

    Optional. Deep-linking parameter for the /start message sent to the bot when user presses the switch button. `1`- `64` characters, only `A-Z`, `a-z`, `0-9`, `_` and `-` are allowed.

    Type:

      `str`

  MAX_START_PARAMETER_LENGTH = 64

    `telegram.constants.InlineQueryResultsButtonLimit.MAX_START_PARAMETER_LENGTH`

  MIN_START_PARAMETER_LENGTH = 1

    `telegram.constants.InlineQueryResultsButtonLimit.MIN_START_PARAMETER_LENGTH`

  classmethod de_json(data, bot=None)

    See `telegram.TelegramObject.de_json()`.