InsanusMokrassar/PlaguBotCommandsPlugin
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/PlaguBotCommandsPlugin.git synced 2024-11-30 11:48:44 +00:00
Code Issues Projects Releases Wiki Activity
kdocs
PlaguBotCommandsPlugin/plagubot.plugins.commands/dev.inmo.plagubot.plugins.commands/index.html

161 lines
22 KiB
HTML
Raw Permalink Normal View History

deploy: 8c1c33fdf221644b5e917f62f8c29c765e072014
2022-07-09 19:49:59 +00:00
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dev.inmo.plagubot.plugins.commands</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../";</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
const savedDarkMode = storage ? JSON.parse(storage) : false
if(savedDarkMode === true){
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}</script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
</head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../index.html">
<span>plagubot.plugins.commands</span>
</a>
</div>
<div>
deploy: 252f0daf3fa28f2961b1833523e73126cc9af0ff
2022-09-19 18:53:21 +00:00
0.3.4 </div>
deploy: 8c1c33fdf221644b5e917f62f8c29c765e072014
2022-07-09 19:49:59 +00:00
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="plagubot.plugins.commands::dev.inmo.plagubot.plugins.commands////PointingToDeclaration//769193423">
<div class="breadcrumbs"><a href="../../index.html">plagubot.plugins.commands</a><span class="delimiter">/</span><a href="index.html">dev.inmo.plagubot.plugins.commands</a></div>
<div class="cover ">
<h1 class="cover"><span><span>Package</span></span> <span>dev.</span><wbr></wbr><span>inmo.</span><wbr></wbr><span>plagubot.</span><wbr></wbr><span>plugins.</span><wbr></wbr><span>commands</span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="1180098275%2FClasslikes%2F769193423" anchor-label="BotCommandFullInfo" id="1180098275%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-bot-command-full-info/index.html"><span>Bot</span><wbr></wbr><span>Command</span><wbr></wbr><span>Full</span><wbr></wbr><span><span>Info</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1180098275%2FClasslikes%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="-bot-command-full-info/index.html">BotCommandFullInfo</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>key<span class="token operator">: </span><a href="-commands-keeper-key/index.html">CommandsKeeperKey</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>command<span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.types/BotCommand///PointingToDeclaration/">BotCommand</span></span></span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Full info about the command its <a href="-bot-command-full-info/key.html">key</a> and the <a href="-bot-command-full-info/command.html">command</a> itself</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-783705494%2FClasslikes%2F769193423" anchor-label="CommandsKeeper" id="-783705494%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-commands-keeper/index.html"><span>Commands</span><wbr></wbr><span><span>Keeper</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-783705494%2FClasslikes%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="-commands-keeper/index.html">CommandsKeeper</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">preset<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-bot-command-full-info/index.html">BotCommandFullInfo</a><span class="token operator">&gt;</span><span class="token operator"> = </span>emptyList()</span></span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">In memory commands keeper. Contains all the registered commands inside and can be useful in case you wish to <a href="-commands-keeper/add-command.html">addCommand</a> or <a href="-commands-keeper/remove-command.html">removeCommand</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1960867335%2FClasslikes%2F769193423" anchor-label="CommandsKeeperKey" id="-1960867335%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-commands-keeper-key/index.html"><span>Commands</span><wbr></wbr><span>Keeper</span><wbr></wbr><span><span>Key</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1960867335%2FClasslikes%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.html"><span class="token annotation">JvmInline</span></a></div></div><span class="token keyword">value </span><span class="token keyword">class </span><a href="-commands-keeper-key/index.html">CommandsKeeperKey</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>key<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="dev.inmo.tgbotapi.types.commands/BotCommandScope///PointingToDeclaration/">BotCommandScope</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Full info about the command scope including <span data-unresolved-link="dev.inmo.tgbotapi.types.commands/BotCommandScope///PointingToDeclaration/">BotCommandScope</span> and its optional language code (see <a href="-commands-keeper-key/language-code.html">languageCode</a> and <a href="-commands-keeper-key/language-code-ietf.html">languageCodeIetf</a>)</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="974270793%2FClasslikes%2F769193423" anchor-label="CommandsPlugin" id="974270793%2FClasslikes%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-commands-plugin/index.html"><span>Commands</span><wbr></wbr><span><span>Plugin</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="974270793%2FClasslikes%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="-commands-plugin/index.html">CommandsPlugin</a> : <span data-unresolved-link="dev.inmo.plagubot/Plugin///PointingToDeclaration/">Plugin</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">This plugin has been created for centralized work with commands in context of <span data-unresolved-link="dev.inmo.plagubot/Plugin///PointingToDeclaration/">Plugin</span>s system of plagubot. Pass <a href="-bot-command-full-info/index.html">BotCommandFullInfo</a> in your <span data-unresolved-link="dev.inmo.plagubot/Plugin/setupDI/org.koin.core.module.Module#org.jetbrains.exposed.sql.Database#kotlinx.serialization.json.JsonObject/PointingToDeclaration/">Plugin.setupDI</span> section to declare some command. You may use <a href="-commands-keeper/index.html">CommandsKeeper</a> for flexible setup of commands in runtime.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1675832436%2FFunctions%2F769193423" anchor-label="full" id="1675832436%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="full.html"><span><span>full</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1675832436%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="dev.inmo.tgbotapi.types/BotCommand///PointingToDeclaration/">BotCommand</span><span class="token punctuation">.</span><a href="full.html"><span class="token function">full</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">languageCode<span class="token operator">: </span><span data-unresolved-link="dev.inmo.micro_utils.language_codes/IetfLanguageCode///PointingToDeclaration/">IetfLanguageCode</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-bot-command-full-info/index.html">BotCommandFullInfo</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="dev.inmo.tgbotapi.types/BotCommand///PointingToDeclaration/">BotCommand</span><span class="token punctuation">.</span><a href="full.html"><span class="token function">full</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="-commands-keeper-key/index.html">CommandsKeeperKey</a><span class="token operator"> = </span>CommandsKeeperKey.DEFAULT</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-bot-command-full-info/index.html">BotCommandFullInfo</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="dev.inmo.tgbotapi.types/BotCommand///PointingToDeclaration/">BotCommand</span><span class="token punctuation">.</span><a href="full.html"><span class="token function">full</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="dev.inmo.tgbotapi.types.commands/BotCommandScope///PointingToDeclaration/">BotCommandScope</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-bot-command-full-info/index.html">BotCommandFullInfo</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="dev.inmo.tgbotapi.types/BotCommand///PointingToDeclaration/">BotCommand</span><span class="token punctuation">.</span><a href="full.html"><span class="token function">full</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">languageCode<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-bot-command-full-info/index.html">BotCommandFullInfo</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="dev.inmo.tgbotapi.types/BotCommand///Pointin
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="-1631045901%2FProperties%2F769193423" anchor-label="commandsKeeper" id="-1631045901%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
deploy: 07a263734e8d47a3e7e4aaf5b833d5d7e824b002
2022-08-05 19:38:49 +00:00
<div><a href="commands-keeper.html"><span>commands</span><wbr></wbr><span><span>Keeper</span></span></a></div>
deploy: 8c1c33fdf221644b5e917f62f8c29c765e072014
2022-07-09 19:49:59 +00:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1631045901%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1631045901%2FProperties%2F769193423" anchor-label="commandsKeeper" id="-1631045901%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><span data-unresolved-link="org.koin.core.scope/Scope///PointingToDeclaration/">Scope</span><span class="token punctuation">.</span><a href="commands-keeper.html">commandsKeeper</a><span class="token operator">: </span><a href="-commands-keeper/index.html">CommandsKeeper</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><span data-unresolved-link="org.koin.core/Koin///PointingToDeclaration/">Koin</span><span class="token punctuation">.</span><a href="commands-keeper.html">commandsKeeper</a><span class="token operator">: </span><a href="-commands-keeper/index.html">CommandsKeeper</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
deploy: 07a263734e8d47a3e7e4aaf5b833d5d7e824b002
2022-08-05 19:38:49 +00:00
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
deploy: 8c1c33fdf221644b5e917f62f8c29c765e072014
2022-07-09 19:49:59 +00:00
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
deploy: 07a263734e8d47a3e7e4aaf5b833d5d7e824b002
2022-08-05 19:38:49 +00:00
</div>
deploy: 8c1c33fdf221644b5e917f62f8c29c765e072014
2022-07-09 19:49:59 +00:00
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink