mirror of
https://github.com/laurent22/joplin.git
synced 2025-03-23 21:09:30 +02:00
362 lines
16 KiB
HTML
362 lines
16 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>joplin.commands | Joplin Plugin API Documentation</title>
|
|
<meta name="description" content="Documentation for Joplin Plugin API Documentation">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="joplin.html" class="title">Joplin Plugin API Documentation</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<!--
|
|
<li>
|
|
<a href="../globals.html">Globals</a>
|
|
</li>
|
|
-->
|
|
<li>
|
|
<a href="joplincommands.html">joplin.commands</a>
|
|
</li>
|
|
</ul>
|
|
<h1><!-- Class -->joplin.commands</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>This class allows executing or registering new Joplin commands. Commands
|
|
can be executed or associated with
|
|
<a href="joplinviewstoolbarbuttons.html">toolbar buttons</a> or
|
|
<a href="joplinviewsmenuitems.html">menu items</a>.</p>
|
|
</div>
|
|
<p><a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/register_command">View the demo plugin</a></p>
|
|
<a href="#executing-joplin39s-internal-commands" id="executing-joplin39s-internal-commands" style="color: inherit; text-decoration: none;">
|
|
<h2>Executing Joplin's internal commands</h2>
|
|
</a>
|
|
<p>It is also possible to execute internal Joplin's commands which, as of
|
|
now, are not well documented. You can find the list directly on GitHub
|
|
though at the following locations:</p>
|
|
<ul>
|
|
<li><a href="https://github.com/laurent22/joplin/tree/dev/packages/app-desktop/gui/MainScreen/commands">Main screen commands</a></li>
|
|
<li><a href="https://github.com/laurent22/joplin/tree/dev/packages/app-desktop/commands">Global commands</a></li>
|
|
<li><a href="https://github.com/laurent22/joplin/tree/dev/packages/app-desktop/gui/NoteEditor/commands/editorCommandDeclarations.ts">Editor commands</a></li>
|
|
</ul>
|
|
<p>To view what arguments are supported, you can open any of these files
|
|
and look at the <code>execute()</code> command.</p>
|
|
</div>
|
|
</section>
|
|
<!--
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">JoplinCommands</span>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
</section>
|
|
-->
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="joplincommands.html#execute" class="tsd-kind-icon">execute</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="joplincommands.html#register" class="tsd-kind-icon">register</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="execute" class="tsd-anchor"></a>
|
|
<h3>execute</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>commandName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><span class="platform-desktop">desktop</span> Executes the given
|
|
command.</p>
|
|
</div>
|
|
<p>The command can take any number of arguments, and the supported
|
|
arguments will vary based on the command. For custom commands, this
|
|
is the <code>args</code> passed to the <code>execute()</code> function. For built-in
|
|
commands, you can find the supported arguments by checking the links
|
|
above.</p>
|
|
<pre><code class="language-typescript"><span class="hljs-comment">// Create a new note in the current notebook:</span>
|
|
<span class="hljs-keyword">await</span> joplin.commands.execute(<span class="hljs-string">'newNote'</span>);
|
|
|
|
<span class="hljs-comment">// Create a new sub-notebook under the provided notebook</span>
|
|
<span class="hljs-comment">// Note: internally, notebooks are called "folders".</span>
|
|
<span class="hljs-keyword">await</span> joplin.commands.execute(<span class="hljs-string">'newFolder'</span>, <span class="hljs-string">"SOME_FOLDER_ID"</span>);</code></pre>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>commandName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<!-- JOPLINCHANGE
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
|
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="register" class="tsd-anchor"></a>
|
|
<h3>register</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="../interfaces/command.html" class="tsd-signature-type">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><span class="platform-desktop">desktop</span> Registers a new command.</p>
|
|
</div>
|
|
<pre><code class="language-typescript"><span class="hljs-comment">// Register a new commmand called "testCommand1"</span>
|
|
|
|
<span class="hljs-keyword">await</span> joplin.commands.register({
|
|
<span class="hljs-attr">name</span>: <span class="hljs-string">'testCommand1'</span>,
|
|
<span class="hljs-attr">label</span>: <span class="hljs-string">'My Test Command 1'</span>,
|
|
<span class="hljs-attr">iconName</span>: <span class="hljs-string">'fas fa-music'</span>,
|
|
<span class="hljs-attr">execute</span>: <span class="hljs-function">() =></span> {
|
|
alert(<span class="hljs-string">'Testing plugin command 1'</span>);
|
|
},
|
|
});</code></pre>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <a href="../interfaces/command.html" class="tsd-signature-type">Command</a></h5>
|
|
</li>
|
|
</ul>
|
|
<!-- JOPLINCHANGE
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
|
|
|
-->
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<!--
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals ">
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
-->
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-enum">
|
|
<a href="../enums/contentscripttype.html" class="tsd-kind-icon">ContentScriptType</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="../enums/filesystemitem.html" class="tsd-kind-icon">FileSystemItem</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="../enums/importmoduleoutputformat.html" class="tsd-kind-icon">ImportModuleOutputFormat</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="../enums/menuitemlocation.html" class="tsd-kind-icon">MenuItemLocation</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="../enums/settingitemtype.html" class="tsd-kind-icon">SettingItemType</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum">
|
|
<a href="../enums/toolbarbuttonlocation.html" class="tsd-kind-icon">ToolbarButtonLocation</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplin.html" class="tsd-kind-icon">joplin</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class">
|
|
<a href="joplincommands.html" class="tsd-kind-icon">joplin.commands</a>
|
|
<ul>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="joplincommands.html#execute" class="tsd-kind-icon">execute</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="joplincommands.html#register" class="tsd-kind-icon">register</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplindata.html" class="tsd-kind-icon">joplin.data</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplininterop.html" class="tsd-kind-icon">joplin.interop</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinplugins.html" class="tsd-kind-icon">joplin.plugins</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinsettings.html" class="tsd-kind-icon">joplin.settings</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinviews.html" class="tsd-kind-icon">joplin.views</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinviewsdialogs.html" class="tsd-kind-icon">joplin.views.dialogs</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinviewsmenuitems.html" class="tsd-kind-icon">joplin.views.menuItems</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinviewsmenus.html" class="tsd-kind-icon">joplin.views.menus</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinviewspanels.html" class="tsd-kind-icon">joplin.views.panels</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinviewstoolbarbuttons.html" class="tsd-kind-icon">joplin.views.toolbarButtons</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="joplinworkspace.html" class="tsd-kind-icon">joplin.workspace</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/buttonspec.html" class="tsd-kind-icon">ButtonSpec</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/command.html" class="tsd-kind-icon">Command</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/createmenuitemoptions.html" class="tsd-kind-icon">CreateMenuItemOptions</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/editorcommand.html" class="tsd-kind-icon">EditorCommand</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/exportcontext.html" class="tsd-kind-icon">ExportContext</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/exportmodule.html" class="tsd-kind-icon">ExportModule</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/exportoptions.html" class="tsd-kind-icon">ExportOptions</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/importcontext.html" class="tsd-kind-icon">ImportContext</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/importmodule.html" class="tsd-kind-icon">ImportModule</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/menuitem.html" class="tsd-kind-icon">MenuItem</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/script.html" class="tsd-kind-icon">Script</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/settingitem.html" class="tsd-kind-icon">SettingItem</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="../interfaces/settingsection.html" class="tsd-kind-icon">SettingSection</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="../globals.html#buttonid" class="tsd-kind-icon">ButtonId</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="../globals.html#path" class="tsd-kind-icon">Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="../globals.html#viewhandle" class="tsd-kind-icon">ViewHandle</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<!-- JOPLINCHANGE
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
-->
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |