pro.zackpollard.telegrambot.api.chat.inline.send

Class InlineQueryResponse.InlineQueryResponseBuilder

java.lang.Object

pro.zackpollard.telegrambot.api.chat.inline.send.InlineQueryResponse.InlineQueryResponseBuilder

Enclosing class:

InlineQueryResponse

public static class InlineQueryResponse.InlineQueryResponseBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
InlineQueryResponse	build() Builds the InlineQueryResultVoice object
InlineQueryResponse.InlineQueryResponseBuilder	cacheTime(Integer cacheTime) *Optional* Sets the cache time for this response in seconds.
InlineQueryResponse.InlineQueryResponseBuilder	isPersonal(boolean isPersonal) *Optional* Sets whether the response is personal to the user or not.
InlineQueryResponse.InlineQueryResponseBuilder	nextOffset(String nextOffset) *Optional* Sets the offset that a client should send in the next query with the same text to receive more results.
InlineQueryResponse.InlineQueryResponseBuilder	results(InlineQueryResult... results) *Required* Sets the InlineQueryResult's for the response
InlineQueryResponse.InlineQueryResponseBuilder	results(List<InlineQueryResult> results) *Required* Sets the list of InlineQueryResult's for the response
InlineQueryResponse.InlineQueryResponseBuilder	switchPMParameter(String switchPmParameter) *Optional* Sets the switch pm parameter for the response.
InlineQueryResponse.InlineQueryResponseBuilder	switchPMText(String switchPmText) *Optional* Sets the switch pm text for the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

results

public InlineQueryResponse.InlineQueryResponseBuilder results(List<InlineQueryResult> results)

*Required* Sets the list of InlineQueryResult's for the response

Parameters:

results - The list of InlineQueryResult objects

Returns:

The builder object

results

public InlineQueryResponse.InlineQueryResponseBuilder results(InlineQueryResult... results)

*Required* Sets the InlineQueryResult's for the response

Parameters:

results - A collection of InlineQueryResult objects

Returns:

The builder object

cacheTime

public InlineQueryResponse.InlineQueryResponseBuilder cacheTime(Integer cacheTime)

*Optional* Sets the cache time for this response in seconds. If not set this will default to 300 seconds

Parameters:

cacheTime - The cache time for the response in seconds

Returns:

The builder object

isPersonal

public InlineQueryResponse.InlineQueryResponseBuilder isPersonal(boolean isPersonal)

*Optional* Sets whether the response is personal to the user or not. If set to true then the cached response won't be served to anyone apart from the original user. New users will send new requests to the bot

Parameters:

isPersonal - Sets whether the response is personal or not

Returns:

The builder object

nextOffset

public InlineQueryResponse.InlineQueryResponseBuilder nextOffset(String nextOffset)

*Optional* Sets the offset that a client should send in the next query with the same text to receive more results. Ignore this if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.

Parameters:

nextOffset - The next offset for the results

Returns:

The builder object

switchPMText

public InlineQueryResponse.InlineQueryResponseBuilder switchPMText(String switchPmText)

*Optional* Sets the switch pm text for the response. If set, 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

Parameters:

switchPmText - The switch pm text

Returns:

The builder object

switchPMParameter

public InlineQueryResponse.InlineQueryResponseBuilder switchPMParameter(String switchPmParameter)

*Optional* Sets the switch pm parameter for the response. Parameter for the start message sent to the bot when user presses the switch button 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.

Parameters:

switchPmParameter - The switch pm parameter

Returns:

The builder object

build

public InlineQueryResponse build()

Builds the InlineQueryResultVoice object

Returns:

An InlineQueryResultVoice object based on the previously provided values