com.antonioaltieri.telegram.botapi

Class TelegramBot

java.lang.Object

com.antonioaltieri.telegram.botapi.TelegramBot

public abstract class TelegramBot
extends java.lang.Object

This class represents a TelegramBot. To use it, use any of the available subclasses or subclass it yourself.

Constructor Summary

Constructors

Constructor and Description
TelegramBot(java.lang.String botToken) Constructs a TelegramBot using the provided botToken.

Method Summary

Methods

Modifier and Type	Method and Description
Message	forwardMessage(long chatId, long fromChatId, long messageId) Forwards a message with ID messageId from fromChatId to chatId.
User	getMe() A simple method for testing your bot's auth token.
UserProfilePhotos	getUserProfilePhotos(long userId)
UserProfilePhotos	getUserProfilePhotos(long userId, OptionalArgs optionalArgs) Returns a UserProfilePhotos for a user.
protected void	notifyNewMessage(Message message) This method is called by this class to process all new Messages .
void	notifyNewUpdate(Update update) This method is called by another class to process all new Updates asynchronously.
protected void	onMessage(Message message) This method is called when a new message has arrived.
protected void	onStart()
protected void	onStop()
Message	replyTo(Message message, java.lang.String text) Convenience method for sendMessage(message.getChat().getId(), text, new OptionalArgs().replyToMessageId(message.getMessageId()))
Message	sendAudio(long chatId, java.io.File audioFile)
Message	sendAudio(long chatId, java.io.File audioFile, OptionalArgs optionalArgs) Use this method to send audio files, if you want Telegram clients to display the file as a music playable with the internal player.
Message	sendAudio(long chatId, java.lang.String audioFileId)
Message	sendAudio(long chatId, java.lang.String audioFileId, OptionalArgs optionalArgs) This version takes a file id instead of a File, as a String argument.
java.lang.Boolean	sendChatAction(long chatId, ChatAction chatAction) Use this method when you need to tell the user that something is happening on the bot's side.
Message	sendDocument(long chatId, java.io.File documentFile)
Message	sendDocument(long chatId, java.io.File documentFile, OptionalArgs optionalArgs) Use this method to send general files.
Message	sendDocument(long chatId, java.lang.String documentFileId)
Message	sendDocument(long chatId, java.lang.String documentFileId, OptionalArgs optionalArgs) This version takes a file id instead of a File.
Message	sendLocation(long chatId, float latitude, float longitude)
Message	sendLocation(long chatId, float latitude, float longitude, OptionalArgs optionalArgs) Use this method to send point on the map.
Message	sendMessage(long chatId, java.lang.String text)
Message	sendMessage(long chatId, java.lang.String text, OptionalArgs optionalArgs) Use this method to send text messages.
Message	sendMessage(java.lang.String channelUsername, java.lang.String text)
Message	sendMessage(java.lang.String chatId, java.lang.String text, OptionalArgs optionalArgs)
Message	sendPhoto(long chatId, java.io.File photoFile)
Message	sendPhoto(long chatId, java.io.File photoFile, OptionalArgs optionalArgs) Use this method to send photos.
Message	sendPhoto(long chatId, java.lang.String photoFileId)
Message	sendPhoto(long chatId, java.lang.String photoFileId, OptionalArgs optionalArgs) This version takes a file id instead of a File
Message	sendSticker(long chatId, java.io.File stickerFile)
Message	sendSticker(long chatId, java.io.File stickerFile, OptionalArgs optionalArgs) Use this method to send .webp stickers.
Message	sendSticker(long chatId, java.lang.String stickerFileId)
Message	sendSticker(long chatId, java.lang.String stickerFileId, OptionalArgs optionalArgs) This version takes a file id instead of a File.
Message	sendVideo(long chatId, java.io.File videoFile)
Message	sendVideo(long chatId, java.io.File videoFile, OptionalArgs optionalArgs) Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document (sendDocument(long, File, OptionalArgs))).
Message	sendVideo(long chatId, java.lang.String videoFileId)
Message	sendVideo(long chatId, java.lang.String videoFileId, OptionalArgs optionalArgs) This version uses a file id rather than a File
boolean	setWebHook(java.lang.String servletAddress) set the webhook of the bot.
void	start() Starts the bot.
void	stop() Stops the bot.

Methods inherited from class java.lang.Object

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

Constructor Detail

TelegramBot

public TelegramBot(java.lang.String botToken)

Constructs a TelegramBot using the provided botToken.

Parameters:

botToken - The token provided by @BotFather

Method Detail

start

public final void start()

Starts the bot.

onStart

protected void onStart()

stop

public final void stop()

Stops the bot.

onStop

protected void onStop()

forwardMessage

public final Message forwardMessage(long chatId,
                     long fromChatId,
                     long messageId)

Forwards a message with ID messageId from fromChatId to chatId.

Parameters:

chatId - Unique identifier for the message recipient — Chat id

fromChatId - Unique identifier for the chat where the original message was sent — Chat id

messageId - Unique message identifier

Returns:

The sent Message

See Also:

https://core.telegram.org/bots/api#forwardmessage

getMe

public final User getMe()

A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.

Returns:

this bot's information, in the form of a User

See Also:

https://core.telegram.org/bots/api#getme

getUserProfilePhotos

public final UserProfilePhotos getUserProfilePhotos(long userId)

See Also:

getUserProfilePhotos(long, OptionalArgs)

getUserProfilePhotos

public final UserProfilePhotos getUserProfilePhotos(long userId,
                                     OptionalArgs optionalArgs)

Returns a UserProfilePhotos for a user. For any optional arguments, refer to the Telegram documentation.

Parameters:

userId - Unique identifier of the target user

optionalArgs - Any optional arguments for this method

Returns:

The requested UserProfilePhotos

See Also:

https://core.telegram.org/bots/api#getuserprofilephotos, OptionalArgs

sendAudio

public final Message sendAudio(long chatId,
                java.io.File audioFile)

See Also:

sendAudio(long, File, OptionalArgs)

sendAudio

public final Message sendAudio(long chatId,
                java.io.File audioFile,
                OptionalArgs optionalArgs)

Use this method to send audio files, if you want Telegram clients to display the file as a music playable with the internal player. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For any optional arguments, refer to the Telegram documentation.

Parameters:

chatId - Unique identifier for the message recipient - Chat id or Channel Username

audioFile - Audio File to send

optionalArgs - Any optional arguments for this method

Returns:

The sent Message

See Also:

https://core.telegram.org/bots/api#sendaudio

sendAudio

public final Message sendAudio(long chatId,
                java.lang.String audioFileId)

See Also:

sendAudio(long, String, OptionalArgs)

sendAudio

public final Message sendAudio(long chatId,
                java.lang.String audioFileId,
                OptionalArgs optionalArgs)

This version takes a file id instead of a File, as a String argument.

See Also:

sendAudio(long, File, OptionalArgs)

sendChatAction

public final java.lang.Boolean sendChatAction(long chatId,
                               ChatAction chatAction)

Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).

Parameters:

chatId - Unique identifier for the message recipient - Chat id or Channel Username

chatAction - The target ChatAction

Returns:

True if the request was successful

See Also:

https://core.telegram.org/bots/api#sendchataction

sendDocument

public final Message sendDocument(long chatId,
                   java.io.File documentFile)

See Also:

sendAudio(long, File, OptionalArgs)

sendDocument

public final Message sendDocument(long chatId,
                   java.io.File documentFile,
                   OptionalArgs optionalArgs)

Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. For any optional arguments, refer to the Telegram documentation.

Parameters:

chatId - Unique identifier for the message recipient - Chat id or Channel Username

documentFile - File to send

optionalArgs - Any optional arguments

Returns:

The sent Message

See Also:

https://core.telegram.org/bots/api#senddocument

sendDocument

public final Message sendDocument(long chatId,
                   java.lang.String documentFileId)

See Also:

sendDocument(long, String, OptionalArgs)

sendDocument

public final Message sendDocument(long chatId,
                   java.lang.String documentFileId,
                   OptionalArgs optionalArgs)

This version takes a file id instead of a File.

See Also:

sendDocument(long, File, OptionalArgs)

sendLocation

public final Message sendLocation(long chatId,
                   float latitude,
                   float longitude)

See Also:

sendLocation(long, float, float, OptionalArgs)

sendLocation

public final Message sendLocation(long chatId,
                   float latitude,
                   float longitude,
                   OptionalArgs optionalArgs)

Use this method to send point on the map. For any optional arguments, refer to the Telegram documentation.

Parameters:

chatId - Unique identifier for the message recipient - Chat id or Channel Username

latitude - Latitude of location

longitude - Longitude of location

optionalArgs - Any optional arguments

Returns:

the sent Message

See Also:

https://core.telegram.org/bots/api#sendlocation

sendMessage

public final Message sendMessage(long chatId,
                  java.lang.String text)

See Also:

sendMessage(long, String, OptionalArgs)

sendMessage

public final Message sendMessage(java.lang.String channelUsername,
                  java.lang.String text)

See Also:

sendMessage(long, String, OptionalArgs)

sendMessage

public final Message sendMessage(long chatId,
                  java.lang.String text,
                  OptionalArgs optionalArgs)

Use this method to send text messages. For any optional arguments, refer to the Telegram documentation.

Parameters:

chatId - Unique identifier for the message recipient - Chat id or Channel Username

text - Text of the message to be sent

optionalArgs - Any optional arguments

Returns:

the sent Message

See Also:

https://core.telegram.org/bots/api#sendmessage

sendMessage

public final Message sendMessage(java.lang.String chatId,
                  java.lang.String text,
                  OptionalArgs optionalArgs)

See Also:

sendPhoto(long, File, OptionalArgs)

sendPhoto

public final Message sendPhoto(long chatId,
                java.io.File photoFile)

See Also:

sendPhoto(long, File, OptionalArgs)

sendPhoto

public final Message sendPhoto(long chatId,
                java.io.File photoFile,
                OptionalArgs optionalArgs)

Use this method to send photos.

Parameters:

chatId - Unique identifier for the message recipient - Chat id or Channel Username

photoFile - Photo to send

optionalArgs - Any optional arguments

Returns:

The sent Message

See Also:

https://core.telegram.org/bots/api#sendphoto

sendPhoto

public final Message sendPhoto(long chatId,
                java.lang.String photoFileId)

See Also:

sendPhoto(long, String, OptionalArgs)

sendPhoto

public final Message sendPhoto(long chatId,
                java.lang.String photoFileId,
                OptionalArgs optionalArgs)

This version takes a file id instead of a File

See Also:

sendPhoto(long, File, OptionalArgs)

sendSticker

public final Message sendSticker(long chatId,
                  java.io.File stickerFile)

See Also:

sendSticker(long, File, OptionalArgs)

sendSticker

public final Message sendSticker(long chatId,
                  java.io.File stickerFile,
                  OptionalArgs optionalArgs)

Use this method to send .webp stickers. For any optional arguments, refer to the Telegram documentation.

Parameters:

chatId - Unique identifier for the message recipient - Chat id or Channel Username

stickerFile - Sticker to send.

optionalArgs - Any optional arguments

Returns:

The sent Message

See Also:

https://core.telegram.org/bots/api#sendsticker

sendSticker

public final Message sendSticker(long chatId,
                  java.lang.String stickerFileId)

See Also:

sendSticker(long, String, OptionalArgs)

sendSticker

public final Message sendSticker(long chatId,
                  java.lang.String stickerFileId,
                  OptionalArgs optionalArgs)

This version takes a file id instead of a File.

See Also:

sendSticker(long, File, OptionalArgs)

sendVideo

public final Message sendVideo(long chatId,
                java.io.File videoFile)

See Also:

sendVideo(long, File, OptionalArgs)

sendVideo

public final Message sendVideo(long chatId,
                java.io.File videoFile,
                OptionalArgs optionalArgs)

Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document (sendDocument(long, File, OptionalArgs))). Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. For any optional arguments, refer to the Telegram documentation.

Parameters:

chatId - Unique identifier for the message recipient - Chat id or Channel Username

videoFile - Video to send

optionalArgs - Any optional arguments.

Returns:

The sent Message

See Also:

https://core.telegram.org/bots/api#sendvideo

sendVideo

public final Message sendVideo(long chatId,
                java.lang.String videoFileId)

See Also:

sendVideo(long, File, OptionalArgs)

sendVideo

public final Message sendVideo(long chatId,
                java.lang.String videoFileId,
                OptionalArgs optionalArgs)

This version uses a file id rather than a File

See Also:

sendVideo(long, File, OptionalArgs)

replyTo

public final Message replyTo(Message message,
              java.lang.String text)

Convenience method for sendMessage(message.getChat().getId(), text, new OptionalArgs().replyToMessageId(message.getMessageId()))

setWebHook

public final boolean setWebHook(java.lang.String servletAddress)

set the webhook of the bot.

Parameters:

servletAddress - address of the servlet that handles the requests

Returns:

if the webhook is setted succesfully

onMessage

protected void onMessage(Message message)

This method is called when a new message has arrived. It can safely be overridden by subclasses.

Parameters:

message - The newly arrived Message

notifyNewMessage

protected void notifyNewMessage(Message message)

This method is called by this class to process all new Messages .

Parameters:

message - The newly arrived Message

notifyNewUpdate

public void notifyNewUpdate(Update update)

This method is called by another class to process all new Updates asynchronously.

Parameters:

update - The newly arrived Updates