simbot-component-telegram-core/love.forte.simbot.component.telegram.core.bot

Package-level declarations

Types

SerializableTelegramBotConfiguration

@SerialName(value = "simbot.telegram")

@InternalSimbotAPI

data class SerializableTelegramBotConfiguration(val ticket: SerializableTelegramBotConfiguration.Ticket, var config: SerializableTelegramBotConfiguration.Config? = null) : SerializableBotConfiguration

A configuration type for a serializable bot config file.

typealias StdlibBot = Bot

interface TelegramBot : Bot

A Telegram Bot of this component.

TelegramBotConfiguration

class TelegramBotConfiguration @JvmOverloads constructor(var botConfiguration: BotConfiguration = BotConfiguration())

A TelegramBot configuration.

TelegramBotManager

interface TelegramBotManager : BotManager

A BotManager for TelegramBot.

TelegramBotManagerConfiguration

class TelegramBotManagerConfiguration

Configuration for TelegramBotManager

TelegramBotManagerFactoryConfigurerProvider

interface TelegramBotManagerFactoryConfigurerProvider : PluginFactoryConfigurerProvider<TelegramBotManagerConfiguration>

A PluginFactoryConfigurerProvider for TelegramBotManagerFactoryProvider

TelegramBotManagerFactoryProvider

class TelegramBotManagerFactoryProvider : PluginFactoryProvider<TelegramBotManagerConfiguration>

A PluginFactoryProvider for TelegramBotManager

Inherited functions

suspend fun <R : Any> TelegramApi<R>.requestDataBy(bot: TelegramBot): R

Use TelegramBot to request the TelegramApi and get R.

suspend fun TelegramApi<*>.requestRawBy(bot: TelegramBot): HttpResponse

Use TelegramBot to request the TelegramApi and get HttpResponse.

requestResultBy

suspend fun <R : Any> TelegramApi<R>.requestResultBy(bot: TelegramBot): TelegramApiResult<R>

Use TelegramBot to request the TelegramApi and get TelegramApiResult with R.

inline suspend fun TelegramBot.updateCommands(block: TelegramBotCommandsUpdater.() -> Unit): TelegramBotCommands

Update bot commands by TelegramBot.commandsUpdater

useTelegramBotManager

fun PluginInstaller.useTelegramBotManager(configurer: ConfigurerFunction<TelegramBotManagerConfiguration>? = null)

install TelegramBotManager to PluginInstaller.