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

TelegramBot

interface TelegramBot : Bot(source)

A Telegram Bot of this component.

Author

ForteScarlet

Properties

commandsUpdater

abstract val commandsUpdater: TelegramBotCommandsUpdater

An updater for set commands.

abstract override val component: TelegramComponent

contactRelation

open override val contactRelation: ContactRelation?

coroutineContext

abstract override val coroutineContext: CoroutineContext

open override val groupRelation: GroupRelation?

open override val guildRelation: GuildRelation?

abstract override val id: ID

The bot token configured.

open override val name: String

The name (User.username or User.firstName if it is null) of current bot.

abstract val source: StdlibBot

The source bot.

open val userId: ID

The id of userInfo.

abstract val userInfo: User

User info of current bot. The value is updated each time queryUserInfo is used.

Inherited properties

abstract val isActive: Boolean

abstract val isCompleted: Boolean

abstract val isStarted: Boolean

Functions

open suspend fun commands(): TelegramBotCommands

Fetches a TelegramBotCommands.

abstract suspend fun commands(scope: BotCommandScope?, languageCode: String?): TelegramBotCommands

Fetches a TelegramBotCommands with scope and languageCode.

open suspend fun <R : Any> execute(api: TelegramApi<R>): R

Execute TelegramApi by this bot.

open suspend fun executeRaw(api: TelegramApi<*>): HttpResponse

Execute TelegramApi by this bot.

open suspend fun <R : Any> executeResult(api: TelegramApi<R>): TelegramApiResult<R>

Execute TelegramApi by this bot.

open suspend fun pushUpdate(update: Update, raw: String? = null)

Same to source.pushUpdate

abstract suspend fun queryUserInfo(): User

Query user info of the current bot. And update the value of userInfo.

Inherited functions

open fun cancel()

abstract fun cancel(reason: Throwable?)

abstract infix fun isMe(id: ID): Boolean

abstract suspend fun join()

open suspend fun messageFromId(id: ID): MessageContent

messageFromReference

open suspend fun messageFromReference(reference: MessageReference): MessageContent

abstract fun onCompletion(handle: OnCompletion)

abstract suspend fun start()

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

Update bot commands by TelegramBot.commandsUpdater