2021-07-04 19:12:50 +01:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > joplin | 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 = "joplin.html" > joplin< / a >
< / li >
< / ul >
< h1 > <!-- Class --> joplin< / 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 is the main entry point to the Joplin API. You can access various services using the provided accessors.< / p >
< / div >
2021-08-16 16:50:14 +01:00
< p > The API is now relatively stable and in general maintaining backward compatibility is a top priority, so you shouldn' t except much breakages.< / p >
< p > If a breaking change ever becomes needed, best effort will be done to:< / p >
2021-07-04 19:12:50 +01:00
< ul >
2021-08-16 16:50:14 +01:00
< li > Deprecate features instead of removing them, so as to give you time to fix the issue;< / li >
2021-07-04 19:12:50 +01:00
< li > Document breaking changes in the changelog;< / li >
< / ul >
2021-08-16 16:50:14 +01:00
< p > So if you are developing a plugin, please keep an eye on the changelog as everything will be in there with information about how to update your code.< / p >
2021-07-04 19:12:50 +01:00
< / div >
< / section >
<!--
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > Joplin< / 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 " >
< / section >
< section class = "tsd-index-section " >
< h3 > Accessors< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#clipboard" class = "tsd-kind-icon" > clipboard< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#commands" class = "tsd-kind-icon" > commands< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#contentscripts" class = "tsd-kind-icon" > content< wbr > Scripts< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#data" class = "tsd-kind-icon" > data< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#interop" class = "tsd-kind-icon" > interop< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#plugins" class = "tsd-kind-icon" > plugins< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#settings" class = "tsd-kind-icon" > settings< / a > < / li >
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#views" class = "tsd-kind-icon" > views< / a > < / li >
2021-07-24 11:15:07 +01:00
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#window" class = "tsd-kind-icon" > window< / a > < / li >
2021-07-04 19:12:50 +01:00
< li class = "tsd-kind-get-signature tsd-parent-kind-class" > < a href = "joplin.html#workspace" class = "tsd-kind-icon" > workspace< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "joplin.html#require" class = "tsd-kind-icon" > require< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Accessors< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "clipboard" class = "tsd-anchor" > < / a >
< h3 > clipboard< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > clipboard< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplinclipboard.html" class = "tsd-signature-type" > joplin.clipboard< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplinclipboard.html" class = "tsd-signature-type" > joplin.clipboard< / a > < / h4 >
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "commands" class = "tsd-anchor" > < / a >
< h3 > commands< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > commands< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplincommands.html" class = "tsd-signature-type" > joplin.commands< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplincommands.html" class = "tsd-signature-type" > joplin.commands< / a > < / h4 >
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "contentscripts" class = "tsd-anchor" > < / a >
< h3 > content< wbr > Scripts< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > contentScripts< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplincontentscripts.html" class = "tsd-signature-type" > joplin.contentScripts< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplincontentscripts.html" class = "tsd-signature-type" > joplin.contentScripts< / a > < / h4 >
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "data" class = "tsd-anchor" > < / a >
< h3 > data< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > data< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplindata.html" class = "tsd-signature-type" > joplin.data< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplindata.html" class = "tsd-signature-type" > joplin.data< / a > < / h4 >
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "interop" class = "tsd-anchor" > < / a >
< h3 > interop< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > interop< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplininterop.html" class = "tsd-signature-type" > joplin.interop< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplininterop.html" class = "tsd-signature-type" > joplin.interop< / a > < / h4 >
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "plugins" class = "tsd-anchor" > < / a >
< h3 > plugins< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > plugins< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplinplugins.html" class = "tsd-signature-type" > joplin.plugins< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplinplugins.html" class = "tsd-signature-type" > joplin.plugins< / a > < / h4 >
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "settings" class = "tsd-anchor" > < / a >
< h3 > settings< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > settings< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplinsettings.html" class = "tsd-signature-type" > joplin.settings< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplinsettings.html" class = "tsd-signature-type" > joplin.settings< / a > < / h4 >
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "views" class = "tsd-anchor" > < / a >
< h3 > views< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > views< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplinviews.html" class = "tsd-signature-type" > joplin.views< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplinviews.html" class = "tsd-signature-type" > joplin.views< / a > < / h4 >
2021-07-24 11:15:07 +01:00
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "window" class = "tsd-anchor" > < / a >
< h3 > window< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > window< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplinwindow.html" class = "tsd-signature-type" > joplin.window< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplinwindow.html" class = "tsd-signature-type" > joplin.window< / a > < / h4 >
2021-07-04 19:12:50 +01:00
-->
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class" >
< a name = "workspace" class = "tsd-anchor" > < / a >
< h3 > workspace< / h3 >
< ul class = "tsd-signatures tsd-kind-get-signature tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > get< / span > workspace< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "joplinworkspace.html" class = "tsd-signature-type" > joplin.workspace< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< / aside >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < a href = "joplinworkspace.html" class = "tsd-signature-type" > joplin.workspace< / a > < / h4 >
-->
< / li >
< / ul >
< / 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 = "require" class = "tsd-anchor" > < / a >
< h3 > require< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > require< span class = "tsd-signature-symbol" > (< / span > _path< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > any< / 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 > It is not possible to bundle native packages with a plugin, because they
need to work cross-platforms. Instead access to certain useful native
packages is provided using this function.< / p >
< / div >
< p > Currently these packages are available:< / p >
< ul >
< li > < a href = "https://www.npmjs.com/package/sqlite3" > sqlite3< / a > < / li >
< li > < a href = "https://www.npmjs.com/package/fs-extra" > fs-extra< / a > < / li >
< / ul >
< p > < a href = "https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/nativeModule" > View the demo plugin< / a > < / p >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > _path: < span class = "tsd-signature-type" > string< / span > < / h5 >
< / li >
< / ul >
<!-- JOPLINCHANGE
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > any< / 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" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-class" >
< a href = "joplin.html" class = "tsd-kind-icon" > joplin< / a >
< ul >
< li class = " tsd-kind-constructor tsd-parent-kind-class" >
< a href = "joplin.html#constructor" class = "tsd-kind-icon" > constructor< / a >
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#clipboard" class = "tsd-kind-icon" > clipboard< / a >
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#commands" class = "tsd-kind-icon" > commands< / a >
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#contentscripts" class = "tsd-kind-icon" > content< wbr > Scripts< / a >
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#data" class = "tsd-kind-icon" > data< / a >
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#interop" class = "tsd-kind-icon" > interop< / a >
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#plugins" class = "tsd-kind-icon" > plugins< / a >
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#settings" class = "tsd-kind-icon" > settings< / a >
< / li >
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#views" class = "tsd-kind-icon" > views< / a >
< / li >
2021-07-24 11:15:07 +01:00
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#window" class = "tsd-kind-icon" > window< / a >
< / li >
2021-07-04 19:12:50 +01:00
< li class = " tsd-kind-get-signature tsd-parent-kind-class" >
< a href = "joplin.html#workspace" class = "tsd-kind-icon" > workspace< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "joplin.html#require" class = "tsd-kind-icon" > require< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / 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 >
