Package org.telegram.telegrambots.meta.generics

Interface TelegramClient

public interface TelegramClient

Method Summary

Modifier and Type	Method	Description
default File	downloadFile(String filePath)
File	downloadFile(File file)
default InputStream	downloadFileAsStream(String filePath)
InputStream	downloadFileAsStream(File file)
default CompletableFuture<InputStream>	downloadFileAsStreamAsync(String filePath)
CompletableFuture<InputStream>	downloadFileAsStreamAsync(File file)
default CompletableFuture<File>	downloadFileAsync(String filePath)
CompletableFuture<File>	downloadFileAsync(File file)
<T extends Serializable, Method extends BotApiMethod<T>> T	execute(Method method)
Boolean	execute(SetChatPhoto setChatPhoto)	Set chat profile photo
Message	execute(SendAnimation sendAnimation)	Send animation
Message	execute(SendAudio sendAudio)	Sends a file using Send Audio method
Message	execute(SendDocument sendDocument)
List<Message>	execute(SendMediaGroup sendMediaGroup)	Send a media group
Message	execute(SendPhoto sendPhoto)
Message	execute(SendSticker sendSticker)
Message	execute(SendVideo sendVideo)
Message	execute(SendVideoNote sendVideoNote)
Message	execute(SendVoice sendVoice)	Sends a voice note using Send Voice method For this to work, your audio must be in an .ogg file encoded with OPUS
Boolean	execute(AddStickerToSet addStickerToSet)	Adds a new sticker to a set
Boolean	execute(CreateNewStickerSet createNewStickerSet)	Creates a new sticker set ≈
Boolean	execute(ReplaceStickerInSet replaceStickerInSet)	Replace a sticker in a set
Boolean	execute(SetStickerSetThumbnail setStickerSetThumbnail)	Set sticker set thumb
File	execute(UploadStickerFile uploadStickerFile)	Upload a new file as sticker
Serializable	execute(EditMessageMedia editMessageMedia)	Edit media in a message
<T extends Serializable, Method extends BotApiMethod<T>> CompletableFuture<T>	executeAsync(Method method)
CompletableFuture<Boolean>	executeAsync(SetChatPhoto setChatPhoto)	Set chat profile photo
CompletableFuture<Message>	executeAsync(SendAnimation sendAnimation)	Send animation
CompletableFuture<Message>	executeAsync(SendAudio sendAudio)	Sends a file using the Send Audio method
CompletableFuture<Message>	executeAsync(SendDocument sendDocument)
CompletableFuture<List<Message>>	executeAsync(SendMediaGroup sendMediaGroup)	Send a media group
CompletableFuture<Message>	executeAsync(SendPhoto sendPhoto)
CompletableFuture<Message>	executeAsync(SendSticker sendSticker)
CompletableFuture<Message>	executeAsync(SendVideo sendVideo)
CompletableFuture<Message>	executeAsync(SendVideoNote sendVideoNote)
CompletableFuture<Message>	executeAsync(SendVoice sendVoice)	Sends a voice note using the Send Voice method For this to work, your audio must be in an .ogg file encoded with OPUS
CompletableFuture<Boolean>	executeAsync(AddStickerToSet addStickerToSet)	Adds a new sticker to a set
CompletableFuture<Boolean>	executeAsync(CreateNewStickerSet createNewStickerSet)	Creates a new sticker set
CompletableFuture<Boolean>	executeAsync(ReplaceStickerInSet replaceStickerInSet)	Replace a sticker in a set
CompletableFuture<Boolean>	executeAsync(SetStickerSetThumbnail setStickerSetThumbnail)	Set sticker set thumb
CompletableFuture<File>	executeAsync(UploadStickerFile uploadStickerFile)	Upload a new file as sticker
CompletableFuture<Serializable>	executeAsync(EditMessageMedia editMessageMedia)	Edit media in a message

Method Details

executeAsync

<T extends Serializable,
Method extends BotApiMethod<T>>
CompletableFuture<T> executeAsync(Method method)
                           throws TelegramApiException

Throws:

TelegramApiException

execute

<T extends Serializable,
Method extends BotApiMethod<T>>
T execute(Method method)
   throws TelegramApiException

Throws:

TelegramApiException

execute

Message execute(SendDocument sendDocument)
         throws TelegramApiException

Throws:

TelegramApiException

execute

Message execute(SendPhoto sendPhoto)
         throws TelegramApiException

Throws:

TelegramApiException

execute

Message execute(SendVideo sendVideo)
         throws TelegramApiException

Throws:

TelegramApiException

execute

Message execute(SendVideoNote sendVideoNote)
         throws TelegramApiException

Throws:

TelegramApiException

execute

Message execute(SendSticker sendSticker)
         throws TelegramApiException

Throws:

TelegramApiException

execute

Message execute(SendAudio sendAudio)
         throws TelegramApiException

Sends a file using Send Audio method

Parameters:

sendAudio - Information to send

Returns:

If success, the sent Message is returned

Throws:

TelegramApiException - If there is any error sending the audio

See Also:

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

execute

Message execute(SendVoice sendVoice)
         throws TelegramApiException

Sends a voice note using Send Voice method For this to work, your audio must be in an .ogg file encoded with OPUS

Parameters:

sendVoice - Information to send

Returns:

If success, the sent Message is returned

Throws:

TelegramApiException - If there is any error sending the audio

See Also:

• https://core.telegram.org/bots/api#sendvoice)

execute

List<Message> execute(SendMediaGroup sendMediaGroup)
               throws TelegramApiException

Send a media group

Returns:

If success, list of generated messages

Throws:

TelegramApiException - If there is any error sending the media group

See Also:

• https://core.telegram.org/bots/api#sendMediaGroup

execute

Boolean execute(SetChatPhoto setChatPhoto)
         throws TelegramApiException

Set chat profile photo

Parameters:

setChatPhoto - Information to set the photo

Returns:

If success, true is returned

Throws:

TelegramApiException - If there is any error setting the photo.

See Also:

• https://core.telegram.org/bots/api#setChatPhoto

execute

Boolean execute(AddStickerToSet addStickerToSet)
         throws TelegramApiException

Adds a new sticker to a set

Parameters:

addStickerToSet - Information of the sticker to set

Returns:

If success, true is returned

Throws:

TelegramApiException - If there is any error adding the sticker to the set

See Also:

• https://core.telegram.org/bots/api#addStickerToSet

execute

Boolean execute(ReplaceStickerInSet replaceStickerInSet)
         throws TelegramApiException

Replace a sticker in a set

Parameters:

replaceStickerInSet - Information of the sticker to set

Returns:

If success, true is returned

Throws:

TelegramApiException - If there is any error adding the sticker to the set

See Also:

• https://core.telegram.org/bots/api#replaceStickerInSet

execute

Boolean execute(SetStickerSetThumbnail setStickerSetThumbnail)
         throws TelegramApiException

Set sticker set thumb

Parameters:

setStickerSetThumbnail - Information of the sticker to set

Returns:

If success, true is returned

Throws:

TelegramApiException - If there is any error setting the thumb to the set

See Also:

• https://core.telegram.org/bots/api#setStickerSetThumbail

execute

Boolean execute(CreateNewStickerSet createNewStickerSet)
         throws TelegramApiException

Creates a new sticker set ≈

Parameters:

createNewStickerSet - Information of the sticker set to create

Returns:

If success, true is returned

Throws:

TelegramApiException - If there is any error creating the new sticker set

See Also:

• https://core.telegram.org/bots/api#setStickerSetThumbail

execute

File execute(UploadStickerFile uploadStickerFile)
      throws TelegramApiException

Upload a new file as sticker

Parameters:

uploadStickerFile - Information of the file to upload as sticker

Returns:

If success, true is returned

Throws:

TelegramApiException - If there is any error uploading the new file

See Also:

• https://core.telegram.org/bots/api#uploadStickerFile

execute

Serializable execute(EditMessageMedia editMessageMedia)
              throws TelegramApiException

Edit media in a message

Parameters:

editMessageMedia - Information of the new media

Returns:

If the edited message is not an inline message, the edited Message is returned, otherwise True is returned

Throws:

TelegramApiException - If there is any error editing the media

downloadFile

File downloadFile(File file)
           throws TelegramApiException

Throws:

TelegramApiException

downloadFile

default File downloadFile(String filePath)
                   throws TelegramApiException

Throws:

TelegramApiException

downloadFileAsStream

InputStream downloadFileAsStream(File file)
                          throws TelegramApiException

Throws:

TelegramApiException

downloadFileAsStream

default InputStream downloadFileAsStream(String filePath)
                                  throws TelegramApiException

Throws:

TelegramApiException

execute

Message execute(SendAnimation sendAnimation)
         throws TelegramApiException

Send animation

Parameters:

sendAnimation - Information of the animation

Returns:

Sent message

Throws:

TelegramApiException - If there is any error sending animation

executeAsync

CompletableFuture<Message> executeAsync(SendDocument sendDocument)

executeAsync

CompletableFuture<Message> executeAsync(SendPhoto sendPhoto)

executeAsync

CompletableFuture<Message> executeAsync(SendVideo sendVideo)

executeAsync

CompletableFuture<Message> executeAsync(SendVideoNote sendVideoNote)

executeAsync

CompletableFuture<Message> executeAsync(SendSticker sendSticker)

executeAsync

CompletableFuture<Message> executeAsync(SendAudio sendAudio)

Sends a file using the Send Audio method

Parameters:

sendAudio - Information to send

Returns:

If success, the sent Message is returned

executeAsync

CompletableFuture<Message> executeAsync(SendVoice sendVoice)

Sends a voice note using the Send Voice method For this to work, your audio must be in an .ogg file encoded with OPUS

Parameters:

sendVoice - Information to send

Returns:

If success, the sent Message is returned

executeAsync

CompletableFuture<List<Message>> executeAsync(SendMediaGroup sendMediaGroup)

Send a media group

Returns:

If success, list of generated messages

See Also:

• https://core.telegram.org/bots/api#sendMediaGroup

executeAsync

CompletableFuture<Boolean> executeAsync(SetChatPhoto setChatPhoto)

Set chat profile photo

Parameters:

setChatPhoto - Information to set the photo

Returns:

If success, true is returned

See Also:

• https://core.telegram.org/bots/api#setChatPhoto

executeAsync

CompletableFuture<Boolean> executeAsync(AddStickerToSet addStickerToSet)

Adds a new sticker to a set

Parameters:

addStickerToSet - Information of the sticker to set

Returns:

If success, true is returned

See Also:

• https://core.telegram.org/bots/api#addStickerToSet

executeAsync

CompletableFuture<Boolean> executeAsync(ReplaceStickerInSet replaceStickerInSet)

Replace a sticker in a set

Parameters:

replaceStickerInSet - Information of the sticker to set

Returns:

If success, true is returned

See Also:

• https://core.telegram.org/bots/api#replaceStickerInSet

executeAsync

CompletableFuture<Boolean> executeAsync(SetStickerSetThumbnail setStickerSetThumbnail)

Set sticker set thumb

Parameters:

setStickerSetThumbnail - Information of the sticker to set

Returns:

If success, true is returned

See Also:

• https://core.telegram.org/bots/api#setStickerSetThumbail

executeAsync

CompletableFuture<Boolean> executeAsync(CreateNewStickerSet createNewStickerSet)

Creates a new sticker set

Parameters:

createNewStickerSet - Information of the sticker set to create

Returns:

If success, true is returned

See Also:

• https://core.telegram.org/bots/api#createNewStickerSet

executeAsync

CompletableFuture<File> executeAsync(UploadStickerFile uploadStickerFile)

Upload a new file as sticker

Parameters:

uploadStickerFile - Information of the file to upload as sticker

Returns:

If success, true is returned

See Also:

• https://core.telegram.org/bots/api#uploadStickerFile

executeAsync

CompletableFuture<Serializable> executeAsync(EditMessageMedia editMessageMedia)

Edit media in a message

Parameters:

editMessageMedia - Information of the new media

Returns:

If the edited message is not an inline message, the edited Message is returned, otherwise True is returned

executeAsync

CompletableFuture<Message> executeAsync(SendAnimation sendAnimation)

Send animation

Parameters:

sendAnimation - Information of the animation

Returns:

Sent message

downloadFileAsync

CompletableFuture<File> downloadFileAsync(File file)

downloadFileAsync

default CompletableFuture<File> downloadFileAsync(String filePath)

downloadFileAsStreamAsync

CompletableFuture<InputStream> downloadFileAsStreamAsync(File file)

downloadFileAsStreamAsync

default CompletableFuture<InputStream> downloadFileAsStreamAsync(String filePath)