io.github.ageofwar.telejam

Class Bot

java.lang.Object

io.github.ageofwar.telejam.Bot

public final class Bot
extends java.lang.Object

Class representing a connection to the Telegram API.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	downloadFile(java.lang.String fileId) Returns the file with the specified id.
<T extends java.io.Serializable> T	execute(TelegramMethod<T> method) Invokes a method of the Telegram Bot API.
static Bot	fromApiUrl(java.lang.String apiUrl, java.lang.String apiFileUrl) Constructs and returns a Telegram Bot with the API url and ensures that it is a valid bot.
static Bot	fromToken(java.lang.String token) Constructs and returns a Telegram Bot with a token and ensures that it is a valid bot.
long	getId() Returns the id of the bot.
java.lang.String	getUsername() Returns the username of the bot.

Methods inherited from class java.lang.Object

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

Method Detail

fromToken

public static Bot fromToken(java.lang.String token)
                     throws java.io.IOException

Constructs and returns a Telegram Bot with a token and ensures that it is a valid bot.

Parameters:

token - the token used for the connection to the Telegram API

Returns:

the created bot

Throws:

java.io.IOException - if an I/O Exception occurs

TelegramException - if the token is invalid

fromApiUrl

public static Bot fromApiUrl(java.lang.String apiUrl,
                             java.lang.String apiFileUrl)
                      throws java.io.IOException

Constructs and returns a Telegram Bot with the API url and ensures that it is a valid bot.

Parameters:

apiUrl - the API url

apiFileUrl - the API file url

Returns:

the created bot

Throws:

java.io.IOException - if an I/O Exception occurs

TelegramException - if the token is invalid

execute

public <T extends java.io.Serializable> T execute(TelegramMethod<T> method)
                                           throws java.io.IOException

Invokes a method of the Telegram Bot API.

Type Parameters:

T - the return type of the method

Parameters:

method - the method to execute

Returns:

the result of the method invocation

Throws:

java.io.IOException - if an I/O error occurs

TelegramException - if the method invocation returns an error

downloadFile

public java.io.InputStream downloadFile(java.lang.String fileId)
                                 throws java.io.IOException

Returns the file with the specified id.

Parameters:

fileId - the id of the file to download

Returns:

the file

Throws:

java.io.IOException - when an I/O Exception occurs

getUsername

public java.lang.String getUsername()

Returns the username of the bot.

Returns:

the username of the bot

getId

public long getId()

Returns the id of the bot.

Returns:

the id of the bot