2020-10-15 16:08:01 +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.views.dialogs | 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 = "joplinviewsdialogs.html" > joplin.views.dialogs</ a >
</ li >
</ ul >
< h1 > <!-- Class --> joplin.views.dialogs</ 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 > Allows creating and managing dialogs. A dialog is modal window that contains a webview and a row of buttons. You can update the update the webview using the < code > setHtml</ code > method.
Dialogs are hidden by default and you need to call < code > open()</ code > to open them. Once the user clicks on a button, the < code > open</ code > call will return and provide the button ID that was
clicked on. There is currently no " close" method since the dialog should be thought as a modal one and thus can only be closed by clicking on one of the buttons.</ p >
</ div >
2020-11-06 21:52:57 +00:00
< p >< a href = "https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/dialog" > View the demo plugin</ a ></ p >
2020-10-15 16:08:01 +01:00
</ div >
</ section >
<!--
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">JoplinViewsDialogs</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 > Methods</ h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-class" >< a href = "joplinviewsdialogs.html#create" class = "tsd-kind-icon" > create</ a ></ li >
< li class = "tsd-kind-method tsd-parent-kind-class" >< a href = "joplinviewsdialogs.html#open" class = "tsd-kind-icon" > open</ a ></ li >
< li class = "tsd-kind-method tsd-parent-kind-class" >< a href = "joplinviewsdialogs.html#setbuttons" class = "tsd-kind-icon" > set< wbr > Buttons</ a ></ li >
< li class = "tsd-kind-method tsd-parent-kind-class" >< a href = "joplinviewsdialogs.html#sethtml" class = "tsd-kind-icon" > set< wbr > Html</ a ></ li >
< li class = "tsd-kind-method tsd-parent-kind-class" >< a href = "joplinviewsdialogs.html#showmessagebox" class = "tsd-kind-icon" > show< wbr > Message< wbr > Box</ 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 > Methods</ h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "create" class = "tsd-anchor" ></ a >
< h3 > create</ h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > create< 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 >< a href = "../globals.html#viewhandle" class = "tsd-signature-type" > ViewHandle</ a >< 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 > Creates a new dialog</ p >
</ div >
</ div >
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../globals.html#viewhandle" class="tsd-signature-type">ViewHandle</a><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 = "open" class = "tsd-anchor" ></ a >
< h3 > open</ h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > open< span class = "tsd-signature-symbol" > (</ span > handle< span class = "tsd-signature-symbol" > : </ span >< a href = "../globals.html#viewhandle" class = "tsd-signature-type" > ViewHandle</ 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 >< a href = "../globals.html#buttonid" class = "tsd-signature-type" > ButtonId</ a >< 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 > Opens the dialog</ p >
</ div >
</ div >
< h4 class = "tsd-parameters-title" > Parameters</ h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > handle: < a href = "../globals.html#viewhandle" class = "tsd-signature-type" > ViewHandle</ a ></ h5 >
</ li >
</ ul >
<!-- JOPLINCHANGE
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../globals.html#buttonid" class="tsd-signature-type">ButtonId</a><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 = "setbuttons" class = "tsd-anchor" ></ a >
< h3 > set< wbr > Buttons</ h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > set< wbr > Buttons< span class = "tsd-signature-symbol" > (</ span > handle< span class = "tsd-signature-symbol" > : </ span >< a href = "../globals.html#viewhandle" class = "tsd-signature-type" > ViewHandle</ a > , buttons< span class = "tsd-signature-symbol" > : </ span >< a href = "../interfaces/buttonspec.html" class = "tsd-signature-type" > ButtonSpec</ a >< 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 >< a href = "../interfaces/buttonspec.html" class = "tsd-signature-type" > ButtonSpec</ a >< span class = "tsd-signature-symbol" > []</ 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 > Sets the dialog buttons.</ p >
</ div >
</ div >
< h4 class = "tsd-parameters-title" > Parameters</ h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > handle: < a href = "../globals.html#viewhandle" class = "tsd-signature-type" > ViewHandle</ a ></ h5 >
</ li >
< li >
< h5 > buttons: < a href = "../interfaces/buttonspec.html" class = "tsd-signature-type" > ButtonSpec</ a >< 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><a href="../interfaces/buttonspec.html" class="tsd-signature-type">ButtonSpec</a><span class="tsd-signature-symbol">[]</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 = "sethtml" class = "tsd-anchor" ></ a >
< h3 > set< wbr > Html</ h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > set< wbr > Html< span class = "tsd-signature-symbol" > (</ span > handle< span class = "tsd-signature-symbol" > : </ span >< a href = "../globals.html#viewhandle" class = "tsd-signature-type" > ViewHandle</ a > , html< 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" > Promise</ span >< span class = "tsd-signature-symbol" > < </ span >< span class = "tsd-signature-type" > string</ 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 > Sets the dialog HTML content</ p >
</ div >
</ div >
< h4 class = "tsd-parameters-title" > Parameters</ h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > handle: < a href = "../globals.html#viewhandle" class = "tsd-signature-type" > ViewHandle</ a ></ h5 >
</ li >
< li >
< h5 > html: < span class = "tsd-signature-type" > string</ 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">string</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 = "showmessagebox" class = "tsd-anchor" ></ a >
< h3 > show< wbr > Message< wbr > Box</ h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > show< wbr > Message< wbr > Box< span class = "tsd-signature-symbol" > (</ span > message< 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" > Promise</ span >< span class = "tsd-signature-symbol" > < </ span >< span class = "tsd-signature-type" > number</ 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 > Displays a message box with OK/Cancel buttons. Returns the button index that was clicked - " 0" for OK and " 1" for " Cancel" </ p >
</ div >
</ div >
< h4 class = "tsd-parameters-title" > Parameters</ h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > message: < span class = "tsd-signature-type" > string</ 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">number</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" >
2020-10-21 00:27:11 +01:00
< li class = " tsd-kind-enum" >
< a href = "../enums/contentscripttype.html" class = "tsd-kind-icon" > ContentScriptType</ a >
</ li >
2020-10-15 16:08:01 +01:00
< 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 >
< li class = " tsd-kind-class" >
< a href = "joplincommands.html" class = "tsd-kind-icon" > joplin.commands</ a >
</ li >
< 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 >
</ ul >
< ul class = "current" >
< li class = "current tsd-kind-class" >
< a href = "joplinviewsdialogs.html" class = "tsd-kind-icon" > joplin.views.dialogs</ a >
< ul >
< li class = " tsd-kind-constructor tsd-parent-kind-class" >
< a href = "joplinviewsdialogs.html#constructor" class = "tsd-kind-icon" > constructor</ a >
</ li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "joplinviewsdialogs.html#create" class = "tsd-kind-icon" > create</ a >
</ li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "joplinviewsdialogs.html#open" class = "tsd-kind-icon" > open</ a >
</ li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "joplinviewsdialogs.html#setbuttons" class = "tsd-kind-icon" > set< wbr > Buttons</ a >
</ li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "joplinviewsdialogs.html#sethtml" class = "tsd-kind-icon" > set< wbr > Html</ a >
</ li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "joplinviewsdialogs.html#showmessagebox" class = "tsd-kind-icon" > show< wbr > Message< wbr > Box</ a >
</ li >
</ ul >
</ li >
</ ul >
< ul class = "after-current" >
< 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 >
