InsanusMokrassar/PlaguBot
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/PlaguBot.git synced 2024-11-21 23:23:47 +00:00
Code Issues Projects Releases Wiki Activity

add docs

Browse Source
This commit is contained in:
InsanusMokrassar 2020-11-12 12:16:43 +06:00
parent b367fd21c5
commit 799e76b487
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
plugin/src/main/kotlin/dev/inmo/plagubot/Plugin.kt
View File

@ -6,8 +6,22 @@ import dev.inmo.tgbotapi.updateshandlers.FlowsUpdatesFilter
import kotlinx.coroutines.CoroutineScope
import org.jetbrains.exposed.sql.Database
/**
* Use this interface for your bot. It is possible to use [kotlinx.serialization.SerialName] annotations on your plugins
* to set up short name for your plugin. Besides, simple name of your class will be used as key for deserialization
* too.
*/
interface Plugin {
/**
* In case you want to publish some processed by your plugin commands, you can provide it via this method
*
* @see BotCommand
*/
suspend fun getCommands(): List<BotCommand> = emptyList()
/**
* This method (usually) will be invoked just one time in the whole application.
*/
suspend operator fun invoke(
bot: TelegramBot,
database: Database,