Configuration
All settings:
class TelegramBotConfig {
/** Telegram bot token */
var token: String? = null
/** Telegram bot username */
var username: String? = null
/** Telegram bot client additional configuration */
var clientConfiguration: (HttpClientConfig<ApacheEngineConfig>.() -> Unit)? = null
/** Source for saving messages */
var messageSource: (TelegramBotActualConfig.() -> MessageSource)? = null
/** Templater for build message templates */
var templater: (TelegramBotActualConfig.() -> Templater)? = null
var receiving: UpdateReceiverConfig = UpdateReceiverConfig()
/** Telegram bot client additional configuration */
fun client(block: HttpClientConfig<ApacheEngineConfig>.() -> Unit) {
clientConfiguration = block
}
/** Configure receiving */
fun receiving(block: UpdateReceiverConfig.() -> Unit) {
receiving.apply(block)
}
}
data class UpdateReceiverConfig(
/** Source for saving callback.data */
var callbackContentSource: (TelegramBotActualConfig.() -> CallbackContentSource)? = null,
/** Source for saving chain state */
var chainSource: (TelegramBotActualConfig.() -> ChainSource)? = null,
/** Source for saving users */
var telegramUserSource: (TelegramBotActualConfig.() -> TelegramUserSource)? = null,
/** Source for saving chats (except private) */
var telegramChatSource: (TelegramBotActualConfig.() -> TelegramChatSource)? = null,
/** Source for saving all changes of bot`s status in all chats */
var telegramChatStatusEventSource: (TelegramBotActualConfig.() -> TelegramChatStatusEventSource)? = null,
/** Converter from object to string and back */
var contentConverter: (TelegramBotActualConfig.() -> ContentConverter)? = null,
/** Serializer from string to callback.data and back */
var callbackSerializer: (TelegramBotActualConfig.() -> CallbackSerializer)? = null,
/** Text templates for show to user when exception throws */
var messageTemplate: (TelegramBotActualConfig.() -> MessageTemplate)? = null,
/** Strategy for invoking BotHandler actions */
var invocationStrategy: (TelegramBotActualConfig.() -> HandlerInvocationStrategy)? = null,
/** Handler for catch internal exceptions */
var exceptionHandler: (TelegramBotActualConfig.() -> ExceptionHandler)? = null,
/** Handler for process exceptions in message chains */
var chainExceptionHandler: (TelegramBotActualConfig.() -> ChainExceptionHandler)? = null,
/** Receiver for getting and handling updates */
var updateReceiver: (TelegramBotActualConfig.(UpdateResolver) -> UpdateReceiver)? = null,
/** Handlers declaration */
var handling: BotHandling.() -> Unit = {},
/** Update handlers declaration */
var updateHandling: BotUpdateHandling.() -> Unit = {},
/** Activate and configure long polling for receiving updates */
fun longPolling(block: LongPollingConfig.() -> Unit)
/** Declare chain handlers */
fun handling(block: BotHandling.() -> Unit)
/** Declare any update handlers */
fun update(block: BotUpdateHandling.() -> Unit)
)
Set your custom implementations
To set your own implementation, it is enough to set a lambda with its creation. You can use already initialized elements for creation.
@EnableTelegramBot
@Configuration
class BotConfig {
@Bean
fun telegramBotConfig(): TelegramBotConfig = TelegramBotConfig().apply {
// customize bot client
client {
defaultRequest {
url {
host = "my.custom.server.url"
port = 1234
}
}
}
eventListening {
after method "getUpdates" called { args ->
val offset: Long? by args
val limit: Int? by args
val timeout: Int? by args
val allowedUpdates: Iterable<String>? by args
logger.info("Called \"getUpdates\" while long polling with offset = $offset, limit = $limit, timeout = $timeout, allowedUpdates = $allowedUpdates")
}
}
receiving {
// you can use other initialized elements in lambda
// (for example, 'telegramBot', 'receiving.messageTemplate', 'templater')
exceptionHandler = { CustomExceptionHandler(telegramBot, receiving.messageTemplate, templater) }
}
}
}
fun Application.configureTelegramBot() {
install(TelegramBot) {
// customize bot client
client {
defaultRequest {
url {
host = "my.custom.server.url"
port = 1234
}
}
}
eventListening {
after method "getUpdates" called { args ->
val offset: Long? by args
val limit: Int? by args
val timeout: Int? by args
val allowedUpdates: Iterable<String>? by args
logger.info("Called \"getUpdates\" while long polling with offset = $offset, limit = $limit, timeout = $timeout, allowedUpdates = $allowedUpdates")
}
}
receiving {
// you can use other initialized elements in lambda
// (for example, 'telegramBot', 'receiving.messageTemplate', 'templater')
exceptionHandler = { CustomExceptionHandler(telegramBot, receiving.messageTemplate, templater) }
}
}
}
val config = TelegramBotConfig().apply {
// customize bot client
client {
defaultRequest {
url {
host = "my.custom.server.url"
port = 1234
}
}
}
eventListening {
after method "getUpdates" called { args ->
val offset: Long? by args
val limit: Int? by args
val timeout: Int? by args
val allowedUpdates: Iterable<String>? by args
logger.info("Called \"getUpdates\" while long polling with offset = $offset, limit = $limit, timeout = $timeout, allowedUpdates = $allowedUpdates")
}
}
receiving {
// you can use other initialized elements in lambda
// (for example, 'telegramBot', 'receiving.messageTemplate', 'templater')
exceptionHandler = { CustomExceptionHandler(telegramBot, receiving.messageTemplate, templater) }
}
}
val context = TelegramBotFactory.createTelegramBotContext(config)
Last modified: 02 March 2025