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

Class InlineQueryResponse

java.lang.Object

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

public class InlineQueryResponse
extends Object

Author:

Zack Pollard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InlineQueryResponse.InlineQueryResponseBuilder

Constructor Summary

Constructors

Constructor and Description
InlineQueryResponse()

Method Summary

Modifier and Type	Method and Description
static InlineQueryResponse.InlineQueryResponseBuilder	builder() This builder will allow you to progressively construct this object.
Integer	getCacheTime() Gets the cache time for this result in seconds
String	getNextOffset() Gets the offset key that has been set for if the user scrolls to the end of the list of results and requires more
List<InlineQueryResult>	getResults() Gets a list of all the result objects that will be sent with this response
String	getSwitchPmParameter() Gets the parameter for the start message sent to the bot when user presses the switch button, if set 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.
String	getSwitchPmText() Gets the switch PM text.
boolean	isPersonal() Gets whether this result is personal.

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineQueryResponse

public InlineQueryResponse()

Method Detail

builder

public static InlineQueryResponse.InlineQueryResponseBuilder builder()

This builder will allow you to progressively construct this object.

Returns:

An InlineQueryResponseBuilder object used to construct the InlineQueryResponse object

getResults

@NonNull
public List<InlineQueryResult> getResults()

Gets a list of all the result objects that will be sent with this response

Returns:

List of result objects that will be sent

getCacheTime

public Integer getCacheTime()

Gets the cache time for this result in seconds

Returns:

The cache time for this result in seconds

isPersonal

public boolean isPersonal()

Gets whether this result is personal. If isPersonal() is false, it means that the cache can be shared between users. If isPersonal() is true the cache will not be shared and will be specific to the user

Returns:

Whether the response is personal or not

getNextOffset

public String getNextOffset()

Gets the offset key that has been set for if the user scrolls to the end of the list of results and requires more

Returns:

The next offset key or a blank string if none was set

getSwitchPmText

public String getSwitchPmText()

Gets the 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 from getSwitchPmParameter()

Returns:

The switch pm text

getSwitchPmParameter

public String getSwitchPmParameter()

Gets the parameter for the start message sent to the bot when user presses the switch button, if set 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.

Returns:

The switch pm parameter