TelegramBot (TelegramBots4Java)

java.lang.Object
- co.vandenham.telegram.botapi.TelegramBot

Direct Known Subclasses:

ChatContextTelegramBot, RegistrableTelegramBot
```
public abstract class TelegramBot
extends 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(String botToken)` Convenience constructor for `TelegramBot(botToken, true)`
`TelegramBot(String botToken, boolean sendAsync)` Constructs a TelegramBot using the provided `botToken`, If `sendAsync` is `true`, the bot invokes all `sendXXX` methods asynchronously.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiResponse<Message>`	`forwardMessage(int chatId, int fromChatId, int messageId)` Forwards a message with ID `messageId` from `fromChatId` to `chatId`.
`ApiResponse<User>`	`getMe()` A simple method for testing your bot's auth token.
`ApiResponse<UserProfilePhotos>`	`getUserProfilePhotos(int userId)`
`ApiResponse<UserProfilePhotos>`	`getUserProfilePhotos(int userId, OptionalArgs optionalArgs)` Returns a `UserProfilePhotos` for a user.
`protected void`	`notifyNewMessages(List<Message> messages)` This method is called by this class to process all new `Message`s asynchronously.
`protected void`	`onMessage(Message message)` This method is called when a new message has arrived.
`protected void`	`onStart()`
`protected void`	`onStop()`
`protected ExecutorService`	`provideExecutorService()` Instantiates and returns an `ExecutorService`.
`ApiResponse<Message>`	`replyTo(Message message, String text)` Convenience method for `sendMessage(message.getChat().getId(), text, new OptionalArgs().replyToMessageId(message.getMessageId()))`
`ApiResponse<Message>`	`sendAudio(int chatId, File audioFile)`
`ApiResponse<Message>`	`sendAudio(int chatId, File audioFile, OptionalArgs optionalArgs)` Use this method to send audio files, if you want Telegram clients to display them in the music player.
`ApiResponse<Message>`	`sendAudio(int chatId, String audioFileId)`
`ApiResponse<Message>`	`sendAudio(int chatId, String audioFileId, OptionalArgs optionalArgs)` This version takes a file id instead of a `File`, as a `String` argument.
`ApiResponse<Boolean>`	`sendChatAction(int chatId, ChatAction chatAction)` Use this method when you need to tell the user that something is happening on the bot's side.
`ApiResponse<Message>`	`sendDocument(int chatId, File documentFile)`
`ApiResponse<Message>`	`sendDocument(int chatId, File documentFile, OptionalArgs optionalArgs)` Use this method to send general files.
`ApiResponse<Message>`	`sendDocument(int chatId, String documentFileId)`
`ApiResponse<Message>`	`sendDocument(int chatId, String documentFileId, OptionalArgs optionalArgs)` This version takes a file id instead of a `File`.
`ApiResponse<Message>`	`sendLocation(int chatId, float latitude, float longitude)`
`ApiResponse<Message>`	`sendLocation(int chatId, float latitude, float longitude, OptionalArgs optionalArgs)` Use this method to send point on the map.
`ApiResponse<Message>`	`sendMessage(int chatId, String text)`
`ApiResponse<Message>`	`sendMessage(int chatId, String text, OptionalArgs optionalArgs)` Use this method to send text messages.
`ApiResponse<Message>`	`sendPhoto(int chatId, File photoFile)`
`ApiResponse<Message>`	`sendPhoto(int chatId, File photoFile, OptionalArgs optionalArgs)` Use this method to send photos.
`ApiResponse<Message>`	`sendPhoto(int chatId, String photoFileId)`
`ApiResponse<Message>`	`sendPhoto(int chatId, String photoFileId, OptionalArgs optionalArgs)` This version takes a file id instead of a `File`
`ApiResponse<Message>`	`sendSticker(int chatId, File stickerFile)`
`ApiResponse<Message>`	`sendSticker(int chatId, File stickerFile, OptionalArgs optionalArgs)` Use this method to send .webp stickers.
`ApiResponse<Message>`	`sendSticker(int chatId, String stickerFileId)`
`ApiResponse<Message>`	`sendSticker(int chatId, String stickerFileId, OptionalArgs optionalArgs)` This version takes a file id instead of a `File`.
`ApiResponse<Message>`	`sendVideo(int chatId, File videoFile)`
`ApiResponse<Message>`	`sendVideo(int chatId, File videoFile, OptionalArgs optionalArgs)` Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document (`sendDocument(int, File, OptionalArgs)`)).
`ApiResponse<Message>`	`sendVideo(int chatId, String videoFileId)`
`ApiResponse<Message>`	`sendVideo(int chatId, String videoFileId, OptionalArgs optionalArgs)` This version uses a file id rather than a `File`
`ApiResponse<Message>`	`sendVoice(int chatId, File voiceFile)`
`ApiResponse<Message>`	`sendVoice(int chatId, File voiceFile, OptionalArgs optionalArgs)` Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.
`ApiResponse<Message>`	`sendVoice(int chatId, String voiceFileId)` This version uses a String rather than a File.
`ApiResponse<Message>`	`sendVoice(int chatId, String voiceFileId, OptionalArgs optionalArgs)` This version uses a String rather than a File
`void`	`start()` Starts the bot.
`void`	`stop()` Stops the bot and joins the polling `Thread`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TelegramBot
```
public TelegramBot(String botToken)
```
    Convenience constructor for TelegramBot(botToken, true)
  - TelegramBot
```
public TelegramBot(String botToken,
                   boolean sendAsync)
```
    Constructs a TelegramBot using the provided botToken, If sendAsync is true, the bot invokes all sendXXX methods asynchronously.
    
    Parameters:
    
    botToken - The token provided by @BotFather
    
    sendAsync - Whether this bot should invoke sendXXX methods asynchronously.
- Method Detail
  - start
```
public final void start()
```
    Starts the bot.
    First, it instantiates a ExecutorService by calling provideExecutorService(). If this instance is constructed with sendAsync set to true, it instantiates a asynchronous ApiRequestExecutor, otherwise a synchronous version is used.
    After this, a polling Thread is instantiated and the bot starts polling the Telegram API.
  - onStart
```
protected void onStart()
```
  - stop
```
public final void stop()
```
    Stops the bot and joins the polling Thread.
  - onStop
```
protected void onStop()
```
  - provideExecutorService
```
protected ExecutorService provideExecutorService()
```
    Instantiates and returns an ExecutorService.
    By default, Executors.newCachedThreadPool() is used. This method can safely be overridden to adjust this behaviour. This method can safely be overridden to return null, but if you decide to do so, notifyNewMessages(List) must be overridden to avoid a NPE.
    
    Returns:
    
    An instantiated ExecutorService
  - forwardMessage
```
public final ApiResponse<Message> forwardMessage(int chatId,
                                                 int fromChatId,
                                                 int messageId)
```
    Forwards a message with ID messageId from fromChatId to chatId.
    
    Parameters:
    
    chatId - Unique identifier for the message recipient — User or GroupChat id
    
    fromChatId - Unique identifier for the chat where the original message was sent — User or GroupChat id
    
    messageId - Unique message identifier
    
    Returns:
    
    An ApiResponse with the sent Message
    
    See Also:
    
    https://core.telegram.org/bots/api#forwardmessage
  - getMe
```
public final ApiResponse<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 wrapped in a ApiResponse
    
    See Also:
    
    https://core.telegram.org/bots/api#getme
  - getUserProfilePhotos
```
public final ApiResponse<UserProfilePhotos> getUserProfilePhotos(int userId)
```
    See Also:
    
    getUserProfilePhotos(int, OptionalArgs)
  - getUserProfilePhotos
```
public final ApiResponse<UserProfilePhotos> getUserProfilePhotos(int 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 ApiResponse<Message> sendAudio(int chatId,
                                            File audioFile)
```
    See Also:
    
    sendAudio(int, File, OptionalArgs)
  - sendAudio
```
public final ApiResponse<Message> sendAudio(int chatId,
                                            File audioFile,
                                            OptionalArgs optionalArgs)
```
    Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For backward compatibility, when the fields title and performer are both empty and the mime-type of the file to be sent is not audio/mpeg, the file will be sent as a playable voice message. For this to work, the audio must be in an .ogg file encoded with OPUS. This behavior will be phased out in the future. For sending voice messages, use the sendVoice method instead. For any optional arguments, refer to the Telegram documentation.
    
    Parameters:
    
    chatId - Unique identifier for the message recipient - User or GroupChat id
    
    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 ApiResponse<Message> sendAudio(int chatId,
                                            String audioFileId)
```
    See Also:
    
    sendAudio(int, String, OptionalArgs)
  - sendAudio
```
public final ApiResponse<Message> sendAudio(int chatId,
                                            String audioFileId,
                                            OptionalArgs optionalArgs)
```
    This version takes a file id instead of a File, as a String argument.
    
    See Also:
    
    sendAudio(int, File, OptionalArgs)
  - sendChatAction
```
public final ApiResponse<Boolean> sendChatAction(int 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 - User or GroupChat id.
    
    chatAction - The target ChatAction
    
    Returns:
    
    True if the request was successful
    
    See Also:
    
    https://core.telegram.org/bots/api#sendchataction
  - sendDocument
```
public final ApiResponse<Message> sendDocument(int chatId,
                                               File documentFile)
```
    See Also:
    
    sendAudio(int, File, OptionalArgs)
  - sendDocument
```
public final ApiResponse<Message> sendDocument(int chatId,
                                               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 - User or GroupChat id
    
    documentFile - File to send
    
    optionalArgs - Any optional arguments
    
    Returns:
    
    The sent Message
    
    See Also:
    
    https://core.telegram.org/bots/api#senddocument
  - sendDocument
```
public final ApiResponse<Message> sendDocument(int chatId,
                                               String documentFileId)
```
    See Also:
    
    sendDocument(int, String, OptionalArgs)
  - sendDocument
```
public final ApiResponse<Message> sendDocument(int chatId,
                                               String documentFileId,
                                               OptionalArgs optionalArgs)
```
    This version takes a file id instead of a File.
    
    See Also:
    
    sendDocument(int, File, OptionalArgs)
  - sendLocation
```
public final ApiResponse<Message> sendLocation(int chatId,
                                               float latitude,
                                               float longitude)
```
    See Also:
    
    sendLocation(int, float, float, OptionalArgs)
  - sendLocation
```
public final ApiResponse<Message> sendLocation(int 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 - User or GroupChat id
    
    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 ApiResponse<Message> sendMessage(int chatId,
                                              String text)
```
    See Also:
    
    sendMessage(int, String, OptionalArgs)
  - sendMessage
```
public final ApiResponse<Message> sendMessage(int chatId,
                                              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 - User or GroupChat id
    
    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
  - sendPhoto
```
public final ApiResponse<Message> sendPhoto(int chatId,
                                            File photoFile)
```
    See Also:
    
    sendPhoto(int, File, OptionalArgs)
  - sendPhoto
```
public final ApiResponse<Message> sendPhoto(int chatId,
                                            File photoFile,
                                            OptionalArgs optionalArgs)
```
    Use this method to send photos.
    
    Parameters:
    
    chatId - Unique identifier for the message recipient - User or GroupChat id
    
    photoFile - Photo to send
    
    optionalArgs - Any optional arguments
    
    Returns:
    
    The sent Message
    
    See Also:
    
    https://core.telegram.org/bots/api#sendphoto
  - sendPhoto
```
public final ApiResponse<Message> sendPhoto(int chatId,
                                            String photoFileId)
```
    See Also:
    
    sendPhoto(int, String, OptionalArgs)
  - sendPhoto
```
public final ApiResponse<Message> sendPhoto(int chatId,
                                            String photoFileId,
                                            OptionalArgs optionalArgs)
```
    This version takes a file id instead of a File
    
    See Also:
    
    sendPhoto(int, File, OptionalArgs)
  - sendSticker
```
public final ApiResponse<Message> sendSticker(int chatId,
                                              File stickerFile)
```
    See Also:
    
    sendSticker(int, File, OptionalArgs)
  - sendSticker
```
public final ApiResponse<Message> sendSticker(int chatId,
                                              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 - User or GroupChat id
    
    stickerFile - Sticker to send.
    
    optionalArgs - Any optional arguments
    
    Returns:
    
    The sent Message
    
    See Also:
    
    https://core.telegram.org/bots/api#sendsticker
  - sendSticker
```
public final ApiResponse<Message> sendSticker(int chatId,
                                              String stickerFileId)
```
    See Also:
    
    sendSticker(int, String, OptionalArgs)
  - sendSticker
```
public final ApiResponse<Message> sendSticker(int chatId,
                                              String stickerFileId,
                                              OptionalArgs optionalArgs)
```
    This version takes a file id instead of a File.
    
    See Also:
    
    sendSticker(int, File, OptionalArgs)
  - sendVideo
```
public final ApiResponse<Message> sendVideo(int chatId,
                                            File videoFile)
```
    See Also:
    
    sendVideo(int, File, OptionalArgs)
  - sendVideo
```
public final ApiResponse<Message> sendVideo(int chatId,
                                            File videoFile,
                                            OptionalArgs optionalArgs)
```
    Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document (sendDocument(int, 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 - User or GroupChat id
    
    videoFile - Video to send
    
    optionalArgs - Any optional arguments.
    
    Returns:
    
    The sent Message
    
    See Also:
    
    https://core.telegram.org/bots/api#sendvideo
  - sendVideo
```
public final ApiResponse<Message> sendVideo(int chatId,
                                            String videoFileId)
```
    See Also:
    
    sendVideo(int, File, OptionalArgs)
  - sendVideo
```
public final ApiResponse<Message> sendVideo(int chatId,
                                            String videoFileId,
                                            OptionalArgs optionalArgs)
```
    This version uses a file id rather than a File
    
    See Also:
    
    sendVideo(int, File, OptionalArgs)
  - sendVoice
```
public final ApiResponse<Message> sendVoice(int chatId,
                                            File voiceFile)
```
    See Also:
    
    sendVoice(int, File, OptionalArgs)
  - sendVoice
```
public final ApiResponse<Message> sendVoice(int chatId,
                                            File voiceFile,
                                            OptionalArgs optionalArgs)
```
    Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages 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 — User or GroupChat id
    
    voiceFile - Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data.
    
    optionalArgs - Any optional arguments
    
    Returns:
    
    the sent Message
  - sendVoice
```
public final ApiResponse<Message> sendVoice(int chatId,
                                            String voiceFileId)
```
    This version uses a String rather than a File.
    
    See Also:
    
    sendVoice(int, File, OptionalArgs)
  - sendVoice
```
public final ApiResponse<Message> sendVoice(int chatId,
                                            String voiceFileId,
                                            OptionalArgs optionalArgs)
```
    This version uses a String rather than a File
    
    See Also:
    
    sendVoice(int, File, OptionalArgs)
  - replyTo
```
public final ApiResponse<Message> replyTo(Message message,
                                          String text)
```
    Convenience method for sendMessage(message.getChat().getId(), text, new OptionalArgs().replyToMessageId(message.getMessageId()))
  - 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
  - notifyNewMessages
```
protected void notifyNewMessages(List<Message> messages)
```
    This method is called by this class to process all new Messages asynchronously. It must be overridden if provideExecutorService() is overridden to return null, otherwise a NullPointerException may be thrown.
    
    Parameters:
    
    messages - The newly arrived Messages

Class TelegramBot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TelegramBot

TelegramBot

Method Detail

start

onStart

stop

onStop

provideExecutorService

forwardMessage

getMe

getUserProfilePhotos

getUserProfilePhotos

sendAudio

sendAudio

sendAudio

sendAudio

sendChatAction

sendDocument

sendDocument

sendDocument

sendDocument

sendLocation

sendLocation

sendMessage

sendMessage

sendPhoto

sendPhoto

sendPhoto

sendPhoto

sendSticker

sendSticker

sendSticker

sendSticker

sendVideo

sendVideo

sendVideo

sendVideo

sendVoice

sendVoice

sendVoice

sendVoice

replyTo

onMessage

notifyNewMessages