Telegram Bot/eu.vendeli.tgbot.types.internal.configuration/BotConfiguration

BotConfiguration

@Serializable
data class BotConfiguration(var identifier: String = "KtGram", var apiHost: String = "https://api.telegram.org", var isTestEnv: Boolean = false, var inputListener: InputListener = InputListenerMapImpl(), var classManager: ClassManager = ClassManagerImpl(), var inputAutoRemoval: Boolean = true, var exceptionHandlingStrategy: ExceptionHandlingStrategy = ExceptionHandlingStrategy.CollectToChannel, var throwExOnActionsFailure: Boolean = false, rateLimiter: RateLimiterConfiguration = RateLimiterConfiguration(), httpClient: HttpConfiguration = HttpConfiguration(), logging: LoggingConfiguration = LoggingConfiguration(), updatesListener: UpdatesListenerConfiguration = UpdatesListenerConfiguration(), commandParsing: CommandParsingConfiguration = CommandParsingConfiguration())

The class containing the bot configuration.

Constructors

Link copied to clipboard
constructor(identifier: String = "KtGram", apiHost: String = "https://api.telegram.org", isTestEnv: Boolean = false, inputListener: InputListener = InputListenerMapImpl(), classManager: ClassManager = ClassManagerImpl(), inputAutoRemoval: Boolean = true, exceptionHandlingStrategy: ExceptionHandlingStrategy = ExceptionHandlingStrategy.CollectToChannel, throwExOnActionsFailure: Boolean = false, rateLimiter: RateLimiterConfiguration = RateLimiterConfiguration(), httpClient: HttpConfiguration = HttpConfiguration(), logging: LoggingConfiguration = LoggingConfiguration(), updatesListener: UpdatesListenerConfiguration = UpdatesListenerConfiguration(), commandParsing: CommandParsingConfiguration = CommandParsingConfiguration())

Properties

Link copied to clipboard
var apiHost: String

Host of telegram api.

Link copied to clipboard
@Transient
var classManager: ClassManager

The manager that will be used to get classes.

Link copied to clipboard
@Transient
var exceptionHandlingStrategy: ExceptionHandlingStrategy

Exception handling strategy.

Link copied to clipboard
var identifier: String

Property to identify different bot instances during multi-bot processing.

Link copied to clipboard
var inputAutoRemoval: Boolean

A flag that regulates the auto-deletion of the input point during processing.

Link copied to clipboard
@Transient
var inputListener: InputListener

Input handling class instance.

Link copied to clipboard
var isTestEnv: Boolean

Test environment flag.

Link copied to clipboard
var throwExOnActionsFailure: Boolean

Throw exception when the action (any bot request) ends with failure.

Functions

Link copied to clipboard
fun commandParsing(block: CommandParsingConfiguration.() -> Unit)

Function for specifying command parsing pattern. See CommandParsingConfiguration.

Link copied to clipboard
fun httpClient(block: HttpConfiguration.() -> Unit)

Function for configuring the http client. See HttpConfiguration.

Link copied to clipboard
fun logging(block: LoggingConfiguration.() -> Unit)

Function for configuring logging. See LoggingConfiguration.

Link copied to clipboard
fun rateLimiter(block: RateLimiterConfiguration.() -> Unit)

Function for configuring requests limiting. See RateLimiterConfiguration.

Link copied to clipboard
fun updatesListener(block: UpdatesListenerConfiguration.() -> Unit)

Function for updates listener configuring. See UpdatesListenerConfiguration.