pro.zackpollard.telegrambot.api.chat.inline

Interface InlineQuery

All Known Implementing Classes:

InlineQueryImpl

public interface InlineQuery

Author:

Zack Pollard

Method Summary

Modifier and Type	Method and Description
default boolean	answer(TelegramBot telegramBot, InlineQueryResponse response) This method allows you to directly answer the Inline Query from this object.
default boolean	answer(TelegramBot telegramBot, InlineQueryResult... results) This method allows you to directly answer the Inline Query from this object.
org.json.JSONObject	asJson() Gets the JSONObject that was sent by the bot API to produce this object
Location	getLocation() Gets the Location of the User that sent this inline query
String	getOffset() The offset for this query, this can be used to enable pagination when the user scrolls to the end of the current list of results.
String	getQuery() Gets the query string that was sent by the User
String	getQueryId() Gets the ID of this inline query
User	getSender() Gets the User that sent this inline query

Method Detail

getQueryId

String getQueryId()

Gets the ID of this inline query

Returns:

The ID of this inline query

getSender

User getSender()

Gets the User that sent this inline query

Returns:

The User that sent this inline query

getLocation

Location getLocation()

Gets the Location of the User that sent this inline query

Returns:

The Location of the User that sent the query, or null if no Location was sent

getQuery

String getQuery()

Gets the query string that was sent by the User

Returns:

The query string that was sent by the user

getOffset

String getOffset()

The offset for this query, this can be used to enable pagination when the user scrolls to the end of the current list of results. When this happens, the API will provide an identical InlineQuery object with an offset that was set in the previous inline query response. This makes it possible to return more results that are different from the first set of results

Returns:

The offset for the current query

asJson

org.json.JSONObject asJson()

Gets the JSONObject that was sent by the bot API to produce this object

Returns:

The JSONObject version of this object

answer

default boolean answer(TelegramBot telegramBot,
                       InlineQueryResult... results)

This method allows you to directly answer the Inline Query from this object. If you provide a list of InlineQueryResults then the response will be instantly sent back to the User

Parameters:

telegramBot - The TelegramBot instance that is related to this query

results - An array of results to be sent back to the User

Returns:

True if the response was sent successfully, otherwise False

answer

default boolean answer(TelegramBot telegramBot,
                       InlineQueryResponse response)

This method allows you to directly answer the Inline Query from this object. If you provide an InlineQueryResponse object then the response will be instantly sent back to the User

Parameters:

telegramBot - The TelegramBot instance that is related to this query

response - An InlineQueryResponse object containing the results to the inline query

Returns:

True if the response was sent successfully, otherwise False