InlineQuery¶
- class aiogram.types.inline_query.InlineQuery(*, id: str, from_user: User, query: str, offset: str, chat_type: str | None = None, location: Location | None = None, **extra_data: Any)[source]¶
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
Source: https://core.telegram.org/bots/api#inlinequery
- id: str¶
Unique identifier for this query
- query: str¶
Text of the query (up to 256 characters)
- offset: str¶
Offset of the results to be returned, can be controlled by the bot
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}¶
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_post_init(context: Any, /) None ¶
We need to both initialize private attributes and call the user-defined model_post_init method.
- chat_type: str | None¶
Optional. Type of the chat from which the inline query was sent. Can be either ‘sender’ for a private chat with the inline query sender, ‘private’, ‘group’, ‘supergroup’, or ‘channel’. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat
- answer(results: list[InlineQueryResultCachedAudio | InlineQueryResultCachedDocument | InlineQueryResultCachedGif | InlineQueryResultCachedMpeg4Gif | InlineQueryResultCachedPhoto | InlineQueryResultCachedSticker | InlineQueryResultCachedVideo | InlineQueryResultCachedVoice | InlineQueryResultArticle | InlineQueryResultAudio | InlineQueryResultContact | InlineQueryResultGame | InlineQueryResultDocument | InlineQueryResultGif | InlineQueryResultLocation | InlineQueryResultMpeg4Gif | InlineQueryResultPhoto | InlineQueryResultVenue | InlineQueryResultVideo | InlineQueryResultVoice], cache_time: int | None = None, is_personal: bool | None = None, next_offset: str | None = None, button: InlineQueryResultsButton | None = None, switch_pm_parameter: str | None = None, switch_pm_text: str | None = None, **kwargs: Any) AnswerInlineQuery [source]¶
Shortcut for method
aiogram.methods.answer_inline_query.AnswerInlineQuery
will automatically fill method attributes:inline_query_id
Use this method to send answers to an inline query. On success,
True
is returned.No more than 50 results per query are allowed.
Source: https://core.telegram.org/bots/api#answerinlinequery
- Parameters:
results – A JSON-serialized array of results for the inline query
cache_time – The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
is_personal – Pass
True
if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.next_offset – Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed 64 bytes.
button – A JSON-serialized object describing a button to be shown above inline query results
switch_pm_parameter – 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.switch_pm_text – If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter
- Returns:
instance of method
aiogram.methods.answer_inline_query.AnswerInlineQuery