AnswerInlineQueryRequest

data class AnswerInlineQueryRequest(inlineQueryId: String, results: List<InlineQueryResult>, cacheTime: Int?, isPersonal: Boolean, nextOffset: String?, switchPmText: String?, switchPmParameter: String?)

Request body for answerInlineQuery

Parameters

inlineQueryId

Unique identifier for the answered query

results

A JSON-serialized array of results for the inline query

cacheTime

The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.

isPersonal

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

nextOffset

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.

switchPmText

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

switchPmParameter

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.

Constructors

AnswerInlineQueryRequest

common

fun AnswerInlineQueryRequest(inlineQueryId: String, results: List<InlineQueryResult> = emptyList(), cacheTime: Int? = null, isPersonal: Boolean = false, nextOffset: String? = null, switchPmText: String? = null, switchPmParameter: String? = null)

Unique identifier for the answered query

Functions

component1

common

operator fun component1(): String

component2

common

operator fun component2(): List<InlineQueryResult>

component3

common

operator fun component3(): Int?

component4

common

operator fun component4(): Boolean

component5

common

operator fun component5(): String?

component6

common

operator fun component6(): String?

component7

common

operator fun component7(): String?

copy

common

fun copy(inlineQueryId: String, results: List<InlineQueryResult> = emptyList(), cacheTime: Int? = null, isPersonal: Boolean = false, nextOffset: String? = null, switchPmText: String? = null, switchPmParameter: String? = null): AnswerInlineQueryRequest

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String

Properties

cacheTime

common

val cacheTime: Int? = null

The maximum amount of time in seconds that the result of the inline query may be cached on the server.

inlineQueryId

common

val inlineQueryId: String

Unique identifier for the answered query

isPersonal

common

val isPersonal: Boolean = false

Pass True, if results may be cached on the server side only for the user that sent the query.

nextOffset

common

val nextOffset: String? = null

Pass the offset that a client should send in the next query with the same text to receive more results.

results

common

val results: List<InlineQueryResult>

A JSON-serialized array of results for the inline query

switchPmParameter

common

val switchPmParameter: String? = null

Deep-linking parameter for the /start message sent to the bot when user presses the switch button.

switchPmText

common

val switchPmText: String? = null

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