pro.zackpollard.telegrambot.api

Class TelegramBot

java.lang.Object

pro.zackpollard.telegrambot.api.TelegramBot

public final class TelegramBot
extends Object

Author:

Zack Pollard

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_URL The API URL endpoint that is constant for all bots
static com.google.gson.Gson	GSON A GSON instance that is used throughout the project wherever GSON is needed

Method Summary

Modifier and Type	Method and Description
boolean	answerCallbackQuery(String callbackQueryId, CallbackQueryResponse callbackQueryResponse) This allows you to respond to a callback query with some text as a response.
boolean	answerCallbackQuery(String callbackQueryId, String text, boolean showAlert) Deprecated. This method is deprecated in favour of the answerCallbackQuery(String, CallbackQueryResponse) method, this should be used for all new implementations
boolean	answerInlineQuery(String inlineQueryId, InlineQueryResponse inlineQueryResponse) This allows you to respond to an inline query with an InlineQueryResponse object
boolean	editInlineCaption(String inlineMessageId, String caption, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the caption of any captionable inline message you have sent previously (The inline message must have an InlineReplyMarkup object attached in order to be editable)
boolean	editInlineMessageReplyMarkup(String inlineMessageId, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the InlineReplyMarkup of any inline message that you have sent previously.
boolean	editInlineMessageText(String inlineMessageId, String text, ParseMode parseMode, boolean disableWebPagePreview, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the text of an inline message you have sent previously.
Message	editMessageCaption(Message oldMessage, String caption, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the caption of any captionable message you have sent previously
Message	editMessageCaption(String chatId, Long messageId, String caption, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the caption of any captionable message you have sent previously
Message	editMessageReplyMarkup(Message oldMessage, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the InlineReplyMarkup of any message that you have sent previously.
Message	editMessageReplyMarkup(String chatId, Long messageId, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the InlineReplyMarkup of any message that you have sent previously.
Message	editMessageText(Message oldMessage, String text, ParseMode parseMode, boolean disableWebPagePreview, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the text of a message you have already sent previously
Message	editMessageText(String chatId, Long messageId, String text, ParseMode parseMode, boolean disableWebPagePreview, InlineReplyMarkup inlineReplyMarkup) This allows you to edit the text of a message you have already sent previously
String	getBotAPIUrl() This provides the URL used to make all the API calls to the bot API
Chat	getChat(long chatID) A method used to get a Chat object via the chats ID
Chat	getChat(String chatID) A method used to get a Chat object via the chats ID
ListenerRegistry	getEventsManager() This provides access to the events manager which can be used to register and unregister Listeners
List<GameHighScore>	getGameHighScores(GameScoreRequest gameScoreRequest)
boolean	kickChatMember(String chatId, int userId) Use this method to kick a user from a group or a supergroup.
static TelegramBot	login(String authToken) Use this method to get a new TelegramBot instance with the selected auth token
Message	sendMessage(Chat chat, SendableMessage message) This will send the provided SendableMessage object to the Chat that the Chat object represents
GameScoreEditResponse	setGameScore(SendableGameScore sendableGameScore)
boolean	startUpdates(boolean getPreviousUpdates) Use this method to start the update thread which will begin retrieving messages from the API and firing the relevant events for you to process the data
void	stopUpdates() Calling this method will stop the updater from running and therefore no more events will be fired
boolean	unbanChatMember(String chatId, int userId) Use this method to unban a previously kicked user in a supergroup.

Methods inherited from class java.lang.Object

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

Field Detail

API_URL

public static final String API_URL

The API URL endpoint that is constant for all bots

See Also:

Constant Field Values

GSON

public static final com.google.gson.Gson GSON

A GSON instance that is used throughout the project wherever GSON is needed

Method Detail

login

public static TelegramBot login(String authToken)

Use this method to get a new TelegramBot instance with the selected auth token

Parameters:

authToken - The bots auth token

Returns:

A new TelegramBot instance or null if something failed

getChat

public Chat getChat(long chatID)

A method used to get a Chat object via the chats ID

Parameters:

chatID - The Chat ID of the chat you want a Chat object of

Returns:

A Chat object or null if the chat does not exist or you don't have permission to get this chat

getChat

public Chat getChat(String chatID)

A method used to get a Chat object via the chats ID

Parameters:

chatID - The Chat ID of the chat you want a Chat object of

Returns:

A Chat object or null if the chat does not exist or you don't have permission to get this chat

getBotAPIUrl

public String getBotAPIUrl()

This provides the URL used to make all the API calls to the bot API

Returns:

The URL used to make all the API calls to the bot API

sendMessage

public Message sendMessage(Chat chat,
                           SendableMessage message)

This will send the provided SendableMessage object to the Chat that the Chat object represents

Parameters:

chat - The chat you want to send the message to

message - The message you want to send to the chat

Returns:

A Message object that represents the message you sent, or null if sending failed

editMessageText

public Message editMessageText(Message oldMessage,
                               String text,
                               ParseMode parseMode,
                               boolean disableWebPagePreview,
                               InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the text of a message you have already sent previously

Parameters:

oldMessage - The Message object that represents the message you want to edit

text - The new text you want to display

parseMode - The ParseMode that should be used with this new text

disableWebPagePreview - Whether any URLs should be displayed with a preview of their content

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

A new Message object representing the edited message

editMessageText

public Message editMessageText(String chatId,
                               Long messageId,
                               String text,
                               ParseMode parseMode,
                               boolean disableWebPagePreview,
                               InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the text of a message you have already sent previously

Parameters:

chatId - The chat ID of the chat containing the message you want to edit

messageId - The message ID of the message you want to edit

text - The new text you want to display

parseMode - The ParseMode that should be used with this new text

disableWebPagePreview - Whether any URLs should be displayed with a preview of their content

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

A new Message object representing the edited message

editInlineMessageText

public boolean editInlineMessageText(String inlineMessageId,
                                     String text,
                                     ParseMode parseMode,
                                     boolean disableWebPagePreview,
                                     InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the text of an inline message you have sent previously. (The inline message must have an InlineReplyMarkup object attached in order to be editable)

Parameters:

inlineMessageId - The ID of the inline message you want to edit

text - The new text you want to display

parseMode - The ParseMode that should be used with this new text

disableWebPagePreview - Whether any URLs should be displayed with a preview of their content

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

True if the edit succeeded, otherwise false

editMessageCaption

public Message editMessageCaption(Message oldMessage,
                                  String caption,
                                  InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the caption of any captionable message you have sent previously

Parameters:

oldMessage - The Message object that represents the message you want to edit

caption - The new caption you want to display

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

A new Message object representing the edited message

editMessageCaption

public Message editMessageCaption(String chatId,
                                  Long messageId,
                                  String caption,
                                  InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the caption of any captionable message you have sent previously

Parameters:

chatId - The chat ID of the chat containing the message you want to edit

messageId - The message ID of the message you want to edit

caption - The new caption you want to display

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

A new Message object representing the edited message

editInlineCaption

public boolean editInlineCaption(String inlineMessageId,
                                 String caption,
                                 InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the caption of any captionable inline message you have sent previously (The inline message must have an InlineReplyMarkup object attached in order to be editable)

Parameters:

inlineMessageId - The ID of the inline message you want to edit

caption - The new caption you want to display

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

True if the edit succeeded, otherwise False

editMessageReplyMarkup

public Message editMessageReplyMarkup(Message oldMessage,
                                      InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the InlineReplyMarkup of any message that you have sent previously.

Parameters:

oldMessage - The Message object that represents the message you want to edit

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

A new Message object representing the edited message

editMessageReplyMarkup

public Message editMessageReplyMarkup(String chatId,
                                      Long messageId,
                                      InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the InlineReplyMarkup of any message that you have sent previously.

Parameters:

chatId - The chat ID of the chat containing the message you want to edit

messageId - The message ID of the message you want to edit

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

A new Message object representing the edited message

editInlineMessageReplyMarkup

public boolean editInlineMessageReplyMarkup(String inlineMessageId,
                                            InlineReplyMarkup inlineReplyMarkup)

This allows you to edit the InlineReplyMarkup of any inline message that you have sent previously. (The inline message must have an InlineReplyMarkup object attached in order to be editable)

Parameters:

inlineMessageId - The ID of the inline message you want to edit

inlineReplyMarkup - Any InlineReplyMarkup object you want to edit into the message

Returns:

True if the edit succeeded, otherwise False

answerInlineQuery

public boolean answerInlineQuery(String inlineQueryId,
                                 InlineQueryResponse inlineQueryResponse)

This allows you to respond to an inline query with an InlineQueryResponse object

Parameters:

inlineQueryId - The ID of the inline query you are responding to

inlineQueryResponse - The InlineQueryResponse object that you want to send to the user

Returns:

True if the response was sent successfully, otherwise False

answerCallbackQuery

@Deprecated
public boolean answerCallbackQuery(String callbackQueryId,
                                               String text,
                                               boolean showAlert)

Deprecated. This method is deprecated in favour of the answerCallbackQuery(String, CallbackQueryResponse) method, this should be used for all new implementations

This allows you to respond to a callback query with some text as a response. This will either show up as an alert or as a toast on the telegram client

Parameters:

callbackQueryId - The ID of the callback query you are responding to

text - The text you would like to respond with

showAlert - True will show the text as an alert, false will show it as a toast notification

Returns:

True if the response was sent successfully, otherwise False

answerCallbackQuery

public boolean answerCallbackQuery(String callbackQueryId,
                                   CallbackQueryResponse callbackQueryResponse)

This allows you to respond to a callback query with some text as a response. This will either show up as an alert or as a toast on the telegram client

Parameters:

callbackQueryId - The ID of the callback query you are responding to

callbackQueryResponse - The response that you would like to send in reply to this callback query

Returns:

True if the response was sent successfully, otherwise False

kickChatMember

public boolean kickChatMember(String chatId,
                              int userId)

Use this method to kick a user from a group or a supergroup. In the case of supergroups, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the group for this to work

Parameters:

chatId - The ID of the chat that you want to kick the user from

userId - The ID of the user that you want to kick from the chat

Returns:

True if the user was kicked successfully, otherwise False

unbanChatMember

public boolean unbanChatMember(String chatId,
                               int userId)

Use this method to unban a previously kicked user in a supergroup. The user will not return to the group automatically, but will be able to join via link, etc. The bot must be an administrator in the group for this to work

Parameters:

chatId - The ID of the chat that you want to unban the user from

userId - The ID of the user that you want to unban from the chat

Returns:

True if the user was unbanned, otherwise False

setGameScore

public GameScoreEditResponse setGameScore(SendableGameScore sendableGameScore)

getGameHighScores

public List<GameHighScore> getGameHighScores(GameScoreRequest gameScoreRequest)

startUpdates

public boolean startUpdates(boolean getPreviousUpdates)

Use this method to start the update thread which will begin retrieving messages from the API and firing the relevant events for you to process the data

Parameters:

getPreviousUpdates - Whether you want to retrieve any updates that haven't been processed before, but were created prior to calling the startUpdates method

Returns:

True if the updater was started, otherwise False

stopUpdates

public void stopUpdates()

Calling this method will stop the updater from running and therefore no more events will be fired

getEventsManager

public ListenerRegistry getEventsManager()

This provides access to the events manager which can be used to register and unregister Listeners

Returns:

The current events manager as a ListenerRegistry object