</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">handler</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../types/Frontend_Script_API._internal_.Handler.html"class="tsd-signature-type tsd-kind-type-alias">Handler</a></span></li><li><span><spanclass="tsd-kind-parameter">namespace</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> = null</span></span><divclass="tsd-comment tsd-typography"><p>specify namespace of the handler for the cases where call for bind may be repeated.
If a handler with this ID exists, it's replaced by the new handler.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L412">src/public/app/services/frontend_script_api.ts:412</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="createlink"><span>create<wbr/>Link</span><ahref="#createlink"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">createLink</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">notePath</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">options</span><spanclass="tsd-signature-symbol">?:</span><ahref="Frontend_Script_API._internal_.CreateLinkOptions.html"class="tsd-signature-type tsd-kind-interface">CreateLinkOptions</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">JQuery</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">HTMLElement</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Create a note link (jQuery object) for given note.</p>
</div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L266">src/public/app/services/frontend_script_api.ts:266</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="currentnote"><span>current<wbr/>Note</span><ahref="#currentnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">currentNote</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a></div><divclass="tsd-comment tsd-typography"><p>Note where the script is currently executing, i.e. the note where the currently executing source code is written.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L76">src/public/app/services/frontend_script_api.ts:76</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="dayjs"><span>dayjs</span><ahref="#dayjs"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">dayjs</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">__module</span></div><divclass="tsd-comment tsd-typography"><p>day.js library for date manipulation.
</div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L88">src/public/app/services/frontend_script_api.ts:88</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="formatdateiso"><span>format<wbr/>DateISO</span><ahref="#formatdateiso"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">formatDateISO</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">date</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Date</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-type-declaration"><h4>Type declaration</h4><ulclass="tsd-parameters"><liclass="tsd-parameter-signature"><ulclass="tsd-signatures"><liclass="tsd-signature"><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">date</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Date</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>this is producing local time! *</p>
<divclass="tsd-comment tsd-typography"></div></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L443">src/public/app/services/frontend_script_api.ts:443</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getdaynote"><span>get<wbr/>Day<wbr/>Note</span><ahref="#getdaynote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">getDayNote</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">date</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Returns day note for a given date. If it doesn't exist, it is automatically created.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L359">src/public/app/services/frontend_script_api.ts:359</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getmonthnote"><span>get<wbr/>Month<wbr/>Note</span><ahref="#getmonthnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">getMonthNote</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">month</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Returns month-note. If it doesn't exist, it is automatically created.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L381">src/public/app/services/frontend_script_api.ts:381</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getquarternote"><span>get<wbr/>Quarter<wbr/>Note</span><ahref="#getquarternote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">getQuarterNote</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">quarter</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Returns quarter note for given date. If such a note doesn't exist, it is automatically created.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L389">src/public/app/services/frontend_script_api.ts:389</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="gettodaynote"><span>get<wbr/>Today<wbr/>Note</span><ahref="#gettodaynote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">getTodayNote</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Returns date-note for today. If it doesn't exist, it is automatically created.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L352">src/public/app/services/frontend_script_api.ts:352</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getweekfirstdaynote"><span>get<wbr/>Week<wbr/>First<wbr/>Day<wbr/>Note</span><ahref="#getweekfirstdaynote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">getWeekFirstDayNote</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">date</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L366">src/public/app/services/frontend_script_api.ts:366</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getweeknote"><span>get<wbr/>Week<wbr/>Note</span><ahref="#getweeknote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">getWeekNote</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">week</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Returns week note for given date. If such a note doesn't exist, it is automatically created.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L374">src/public/app/services/frontend_script_api.ts:374</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getyearnote"><span>get<wbr/>Year<wbr/>Note</span><ahref="#getyearnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">getYearNote</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">year</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Returns year-note. If it doesn't exist, it is automatically created.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"><divclass="tsd-tag-method"><h4class="tsd-anchor-link"id="method">Method<ahref="#method"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L398">src/public/app/services/frontend_script_api.ts:398</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="logmessages"><span>log<wbr/>Messages</span><ahref="#logmessages"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">logMessages</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Backend_Script_API._internal_.Record.html"class="tsd-signature-type tsd-kind-type-alias">Record</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">></span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L452">src/public/app/services/frontend_script_api.ts:452</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="logspacedupdates"><span>log<wbr/>Spaced<wbr/>Updates</span><ahref="#logspacedupdates"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">logSpacedUpdates</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Backend_Script_API._internal_.Record.html"class="tsd-signature-type tsd-kind-type-alias">Record</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><ahref="../classes/Frontend_Script_API._internal_.default-3.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">></span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L453">src/public/app/services/frontend_script_api.ts:453</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="notecontextawarewidget"><span>Note<wbr/>Context<wbr/>Aware<wbr/>Widget</span><ahref="#notecontextawarewidget"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">NoteContextAwareWidget</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-keyword">typeof</span><ahref="../classes/Frontend_Script_API.NoteContextAwareWidget.html"class="tsd-signature-type tsd-kind-class">NoteContextAwareWidget</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L81">src/public/app/services/frontend_script_api.ts:81</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="parsedate"><span>parse<wbr/>Date</span><ahref="#parsedate"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">parseDate</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">str</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Date</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L211">src/public/app/services/frontend_script_api.ts:211</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="protectnote"><span>protect<wbr/>Note</span><ahref="#protectnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">protectNote</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">noteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">protect</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">includingSubtree</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-type-declaration"><h4>Type declaration</h4><ulclass="tsd-parameters"><liclass="tsd-parameter-signature"><ulclass="tsd-signatures"><liclass="tsd-signature"><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">noteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">protect</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">includingSubtree</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">noteId</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">protect</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>true to protect note, false to unpro
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">includingSubtree</span>: <spanclass="tsd-signature-type">boolean</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L341">src/public/app/services/frontend_script_api.ts:341</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="protectsubtree"><span>protect<wbr/>Sub<wbr/>Tree</span><ahref="#protectsubtree"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">protectSubTree</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">noteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">protect</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">includingSubtree</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-type-declaration"><h4>Type declaration</h4><ulclass="tsd-parameters"><liclass="tsd-parameter-signature"><ulclass="tsd-signatures"><liclass="tsd-signature"><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">noteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">protect</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">includingSubtree</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">noteId</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">protect</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>true to protect subtree, false to unprotect</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">includingSubtree</span>: <spanclass="tsd-signature-type">boolean</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L347">src/public/app/services/frontend_script_api.ts:347</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="randomstring"><span>random<wbr/>String</span><ahref="#randomstring"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">randomString</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">len</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>Return randomly generated string of given length. This random string generation is NOT cryptographically secure.</p>
<divclass="tsd-comment tsd-typography"></div></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"><divclass="tsd-tag-method"><h4class="tsd-anchor-link"id="method-1">Method<ahref="#method-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L437">src/public/app/services/frontend_script_api.ts:437</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="rightpanelwidget"><span>Right<wbr/>Panel<wbr/>Widget</span><ahref="#rightpanelwidget"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">RightPanelWidget</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-keyword">typeof</span><ahref="../classes/Frontend_Script_API.RightPanelWidget.html"class="tsd-signature-type tsd-kind-class">RightPanelWidget</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L90">src/public/app/services/frontend_script_api.ts:90</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="setupelementtooltip"><span>setup<wbr/>Element<wbr/>Tooltip</span><ahref="#setupelementtooltip"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">setupElementTooltip</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">$el</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">JQuery</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">HTMLElement</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">void</span></div><divclass="tsd-type-declaration"><h4>Type declaration</h4><ulclass="tsd-parameters"><liclass="tsd-parameter-signature"><ulclass="tsd-signatures"><liclass="tsd-signature"><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">$el</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">JQuery</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">HTMLElement</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">$el</span>: <spanclass="tsd-signature-type">JQuery</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">HTMLElement</span><spanclass="tsd-signature-symbol">></span></span><divclass="tsd-comment tsd-typography"><p>jquery object on which to set up the tooltip</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L336">src/public/app/services/frontend_script_api.ts:336</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="showconfirmdialog"><span>show<wbr/>Confirm<wbr/>Dialog</span><ahref="#showconfirmdialog"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">showConfirmDialog</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Show confirm dialog to the user.</p>
</div><divclass="tsd-type-declaration"><h4>Type declaration</h4><ulclass="tsd-parameters"><liclass="tsd-parameter-signature"><ulclass="tsd-signatures"><liclass="tsd-signature"><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">message</span>: <spanclass="tsd-signature-type">string</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span></h4><p>promise resolving to true if the user confirmed</p>
<divclass="tsd-comment tsd-typography"></div></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L232">src/public/app/services/frontend_script_api.ts:232</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="showerror"><span>show<wbr/>Error</span><ahref="#showerror"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">showError</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">delay</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">void</span></div><divclass="tsd-comment tsd-typography"><p>Show an error toast message to the user.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L221">src/public/app/services/frontend_script_api.ts:221</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="showinfodialog"><span>show<wbr/>Info<wbr/>Dialog</span><ahref="#showinfodialog"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">showInfoDialog</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Show an info dialog to the user.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L226">src/public/app/services/frontend_script_api.ts:226</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="showmessage"><span>show<wbr/>Message</span><ahref="#showmessage"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">showMessage</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">delay</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">void</span></div><divclass="tsd-comment tsd-typography"><p>Show an info toast message to the user.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L216">src/public/app/services/frontend_script_api.ts:216</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="showpromptdialog"><span>show<wbr/>Prompt<wbr/>Dialog</span><ahref="#showpromptdialog"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">showPromptDialog</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">props</span><spanclass="tsd-signature-symbol">:</span><ahref="Frontend_Script_API._internal_.PromptDialogOptions.html"class="tsd-signature-type tsd-kind-interface">PromptDialogOptions</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Show prompt dialog to the user.</p>
</div><divclass="tsd-type-declaration"><h4>Type declaration</h4><ulclass="tsd-parameters"><liclass="tsd-parameter-signature"><ulclass="tsd-signatures"><liclass="tsd-signature"><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">props</span><spanclass="tsd-signature-symbol">:</span><ahref="Frontend_Script_API._internal_.PromptDialogOptions.html"class="tsd-signature-type tsd-kind-interface">PromptDialogOptions</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">></span></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">props</span>: <ahref="Frontend_Script_API._internal_.PromptDialogOptions.html"class="tsd-signature-type tsd-kind-interface">PromptDialogOptions</a></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">></span></h4><p>promise resolving to the answer provided by the user</p>
<divclass="tsd-comment tsd-typography"></div></li></ul></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L239">src/public/app/services/frontend_script_api.ts:239</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="startnote"><span>start<wbr/>Note</span><ahref="#startnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">startNote</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a></div><divclass="tsd-comment tsd-typography"><p>Note where the script started executing, i.e., the (event) entrypoint of the current script execution.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L71">src/public/app/services/frontend_script_api.ts:71</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="triggercommand"><span>trigger<wbr/>Command</span><ahref="#triggercommand"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">triggerCommand</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type tsd-kind-type-parameter">K</span><spanclass="tsd-signature-keyword">extends</span><spanclass="tsd-signature-keyword">keyof</span><ahref="../types/Frontend_Script_API._internal_.CommandMappings.html"class="tsd-signature-type tsd-kind-type-alias">CommandMappings</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">name</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type tsd-kind-type-parameter">K</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">_data</span><spanclass="tsd-signature-symbol">?:</span><ahref="../types/Frontend_Script_API._internal_.CommandMappings.html"class="tsd-signature-type tsd-kind-type-alias">CommandMappings</a><spanclass="tsd-signature-symbol">[</span><spanclass="tsd-signature-type tsd-kind-type-parameter">K</span><spanclass="tsd-signature-symbol">]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Trigger command. This is a very low-level API which should be avoided if possible.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L244">src/public/app/services/frontend_script_api.ts:244</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="triggerevent"><span>trigger<wbr/>Event</span><ahref="#triggerevent"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">triggerEvent</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type tsd-kind-type-parameter">K</span><spanclass="tsd-signature-keyword">extends</span><ahref="../types/Frontend_Script_API._internal_.EventNames.html"class="tsd-signature-type tsd-kind-type-alias">EventNames</a><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">name</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type tsd-kind-type-parameter">K</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">data</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.EventData.html"class="tsd-signature-type tsd-kind-type-alias">EventData</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type tsd-kind-type-parameter">K</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Trigger event. This is a very low-level API which should be avoided if possible.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L249">src/public/app/services/frontend_script_api.ts:249</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="waituntilsynced"><span>wait<wbr/>Until<wbr/>Synced</span><ahref="#waituntilsynced"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">waitUntilSynced</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Trilium runs in a backend and frontend process, when something is changed on the backend from a script,
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L421">src/public/app/services/frontend_script_api.ts:421</a></li></ul></aside></section></section></details><detailsclass="tsd-panel-group tsd-member-group tsd-accordion"open><summaryclass="tsd-accordion-summary"data-key="section-Methods"><svgwidth="20"height="20"viewBox="0 0 24 24"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="activatenewnote"><span>activate<wbr/>New<wbr/>Note</span><ahref="#activatenewnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="activatenewnote-1"><spanclass="tsd-kind-call-signature">activateNewNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">notePath</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><ahref="#activatenewnote-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L106">src/public/app/services/frontend_script_api.ts:106</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="activatenote"><span>activate<wbr/>Note</span><ahref="#activatenote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="activatenote-1"><spanclass="tsd-kind-call-signature">activateNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">notePath</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><ahref="#activatenote-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Activates note in the tree and in the note detail.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L99">src/public/app/services/frontend_script_api.ts:99</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="addbuttontotoolbar"><spanclass="deprecated">add<wbr/>Button<wbr/>To<wbr/>Toolbar</span><ahref="#addbuttontotoolbar"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="addbuttontotoolbar-1"><spanclass="tsd-kind-call-signature">addButtonToToolbar</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">opts</span><spanclass="tsd-signature-symbol">:</span><ahref="Frontend_Script_API._internal_.AddToToolbarOpts.html"class="tsd-signature-type tsd-kind-interface">AddToToolbarOpts</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#addbuttontotoolbar-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">opts</span>: <ahref="Frontend_Script_API._internal_.AddToToolbarOpts.html"class="tsd-signature-type tsd-kind-interface">AddToToolbarOpts</a></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"><divclass="tsd-tag-method"><h4class="tsd-anchor-link"id="method-2">Method<ahref="#method-2"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated-2">Deprecated<ahref="#deprecated-2"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>you can now create/modify launchers in the top-left Menu -> Configure Launchbar
for special needs there's also backend API's createOrUpdateLauncher()</p>
</div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L132">src/public/app/services/frontend_script_api.ts:132</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="addtexttoactivecontexteditor"><span>add<wbr/>Text<wbr/>To<wbr/>Active<wbr/>Context<wbr/>Editor</span><ahref="#addtexttoactivecontexteditor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="addtexttoactivecontexteditor-1"><spanclass="tsd-kind-call-signature">addTextToActiveContextEditor</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">text</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#addtexttoactivecontexteditor-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds given text to the editor cursor</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">text</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>this must be clear text, HTML is not supported.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span></h4><p>instance of CodeMirror</p>
<divclass="tsd-comment tsd-typography"><divclass="tsd-tag-method"><h4class="tsd-anchor-link"id="method-3">Method<ahref="#method-3"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L313">src/public/app/services/frontend_script_api.ts:313</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getactivecontextnote"><span>get<wbr/>Active<wbr/>Context<wbr/>Note</span><ahref="#getactivecontextnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getactivecontextnote-1"><spanclass="tsd-kind-call-signature">getActiveContextNote</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><ahref="#getactivecontextnote-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><h4class="tsd-returns-title">Returns <ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a></h4><p>active note (loaded into center pane)</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L278">src/public/app/services/frontend_script_api.ts:278</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getactivecontextnotepath"><span>get<wbr/>Active<wbr/>Context<wbr/>Note<wbr/>Path</span><ahref="#getactivecontextnotepath"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getactivecontextnotepath-1"><spanclass="tsd-kind-call-signature">getActiveContextNotePath</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">string</span><ahref="#getactivecontextnotepath-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">string</span></h4><p>returns a note path of active note or null if there isn't active note</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L323">src/public/app/services/frontend_script_api.ts:323</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getactivecontexttexteditor"><span>get<wbr/>Active<wbr/>Context<wbr/>Text<wbr/>Editor</span><ahref="#getactivecontexttexteditor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getactivecontexttexteditor-1"><spanclass="tsd-kind-call-signature">getActiveContextTextEditor</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span><ahref="#getactivecontexttexteditor-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>See <ahref="https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html">https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html</a> for documentation on the returned instance.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">></span></h4><p>instance of CKEditor</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L305">src/public/app/services/frontend_script_api.ts:305</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getactivemaincontext"><span>get<wbr/>Active<wbr/>Main<wbr/>Context</span><ahref="#getactivemaincontext"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getactivemaincontext-1"><spanclass="tsd-kind-call-signature">getActiveMainContext</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Frontend_Script_API._internal_.NoteContext.html"class="tsd-signature-type tsd-kind-class">NoteContext</a><ahref="#getactivemaincontext-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><h4class="tsd-returns-title">Returns <ahref="../classes/Frontend_Script_API._internal_.NoteContext.html"class="tsd-signature-type tsd-kind-class">NoteContext</a></h4><p>returns active main context (first split in a tab, represents the tab as a whole)</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L288">src/public/app/services/frontend_script_api.ts:288</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getactivenotedetailwidget"><span>get<wbr/>Active<wbr/>Note<wbr/>Detail<wbr/>Widget</span><ahref="#getactivenotedetailwidget"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getactivenotedetailwidget-1"><spanclass="tsd-kind-call-signature">getActiveNoteDetailWidget</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="../classes/Frontend_Script_API._internal_.default-2.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">></span><ahref="#getactivenotedetailwidget-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Get access to the widget handling note detail. Methods like <code>getWidgetType()</code> and <code>getTypeWidget()</code> to get to the
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="../classes/Frontend_Script_API._internal_.default-2.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L319">src/public/app/services/frontend_script_api.ts:319</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getcomponentbyel"><span>get<wbr/>Component<wbr/>By<wbr/>El</span><ahref="#getcomponentbyel"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getcomponentbyel-1"><spanclass="tsd-kind-call-signature">getComponentByEl</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">el</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">HTMLElement</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Frontend_Script_API._internal_.default.html"class="tsd-signature-type tsd-kind-class">default</a><ahref="#getcomponentbyel-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns component which owns the given DOM element (the nearest parent component in DOM tree)</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="../classes/Frontend_Script_API._internal_.default.html"class="tsd-signature-type tsd-kind-class">default</a></h4><divclass="tsd-comment tsd-typography"><divclass="tsd-tag-method"><h4class="tsd-anchor-link"id="method-4">Method<ahref="#method-4"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L331">src/public/app/services/frontend_script_api.ts:331</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getinstancename"><span>get<wbr/>Instance<wbr/>Name</span><ahref="#getinstancename"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getinstancename-1"><spanclass="tsd-kind-call-signature">getInstanceName</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><ahref="#getinstancename-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Instance name identifies particular Trilium instance. It can be useful for scripts
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">string</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L204">src/public/app/services/frontend_script_api.ts:204</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getmainnotecontexts"><span>get<wbr/>Main<wbr/>Note<wbr/>Contexts</span><ahref="#getmainnotecontexts"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getmainnotecontexts-1"><spanclass="tsd-kind-call-signature">getMainNoteContexts</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Frontend_Script_API._internal_.NoteContext.html"class="tsd-signature-type tsd-kind-class">NoteContext</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getmainnotecontexts-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><h4class="tsd-returns-title">Returns <ahref="../classes/Frontend_Script_API._internal_.NoteContext.html"class="tsd-signature-type tsd-kind-class">NoteContext</a><spanclass="tsd-signature-symbol">[]</span></h4><p>returns all main contexts representing tabs</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L298">src/public/app/services/frontend_script_api.ts:298</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getnote"><span>get<wbr/>Note</span><ahref="#getnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getnote-1"><spanclass="tsd-kind-call-signature">getNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">noteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span><ahref="#getnote-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns note by given noteId. If note is missing from the cache, it's loaded.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">noteId</span>: <spanclass="tsd-signature-type">string</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L183">src/public/app/services/frontend_script_api.ts:183</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getnotecontexts"><span>get<wbr/>Note<wbr/>Contexts</span><ahref="#getnotecontexts"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getnotecontexts-1"><spanclass="tsd-kind-call-signature">getNoteContexts</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Frontend_Script_API._internal_.NoteContext.html"class="tsd-signature-type tsd-kind-class">NoteContext</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getnotecontexts-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><h4class="tsd-returns-title">Returns <ahref="../classes/Frontend_Script_API._internal_.NoteContext.html"class="tsd-signature-type tsd-kind-class">NoteContext</a><spanclass="tsd-signature-symbol">[]</span></h4><p>returns all note contexts (splits) in all tabs</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L293">src/public/app/services/frontend_script_api.ts:293</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getnotes"><span>get<wbr/>Notes</span><ahref="#getnotes"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getnotes-1"><spanclass="tsd-kind-call-signature">getNotes</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">noteIds</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">silentNotFoundError</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">></span><ahref="#getnotes-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Returns list of notes. If note is missing from the cache, it's loaded.</p>
<p>This is often used to bulk-fill the cache with notes which would have to be picked one by one
otherwise (by e.g. createLink())</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">noteIds</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">silentNotFoundError</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>don't report error if the note is not found</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L193">src/public/app/services/frontend_script_api.ts:193</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="log"><span>log</span><ahref="#log"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="log-1"><spanclass="tsd-kind-call-signature">log</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#log-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Log given message to the log pane in UI</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">message</span>: <spanclass="tsd-signature-type">string</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L458">src/public/app/services/frontend_script_api.ts:458</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="opensplitwithnote"><span>open<wbr/>Split<wbr/>With<wbr/>Note</span><ahref="#opensplitwithnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="opensplitwithnote-1"><spanclass="tsd-kind-call-signature">openSplitWithNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">notePath</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">activate</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><ahref="#opensplitwithnote-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Open a note in a new split.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">activate</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>set to true to activate the new split, false to stay on the current split</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L123">src/public/app/services/frontend_script_api.ts:123</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="opentabwithnote"><span>open<wbr/>Tab<wbr/>With<wbr/>Note</span><ahref="#opentabwithnote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="opentabwithnote-1"><spanclass="tsd-kind-call-signature">openTabWithNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">notePath</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">activate</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><ahref="#opentabwithnote-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Open a note in a new tab.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">activate</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>set to true to activate the new tab, false to stay on the current tab</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"><divclass="tsd-tag-method"><h4class="tsd-anchor-link"id="method-5">Method<ahref="#method-5"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L115">src/public/app/services/frontend_script_api.ts:115</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="refreshincludednote"><span>refresh<wbr/>Included<wbr/>Note</span><ahref="#refreshincludednote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="refreshincludednote-1"><spanclass="tsd-kind-call-signature">refreshIncludedNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">includedNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#refreshincludednote-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>This will refresh all currently opened notes which have included note specified in the parameter</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">includedNoteId</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>noteId of the included note</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L428">src/public/app/services/frontend_script_api.ts:428</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="reloadnotes"><span>reload<wbr/>Notes</span><ahref="#reloadnotes"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="reloadnotes-1"><spanclass="tsd-kind-call-signature">reloadNotes</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">noteIds</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><ahref="#reloadnotes-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Update frontend tree (note) cache from the backend.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">noteIds</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L198">src/public/app/services/frontend_script_api.ts:198</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="runasynconbackendwithmanualtransactionhandling"><span>run<wbr/>Async<wbr/>On<wbr/>Backend<wbr/>With<wbr/>Manual<wbr/>Transaction<wbr/>Handling</span><ahref="#runasynconbackendwithmanualtransactionhandling"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="runasynconbackendwithmanualtransactionhandling-1"><spanclass="tsd-kind-call-signature">runAsyncOnBackendWithManualTransactionHandling</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">func</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.Func.html"class="tsd-signature-type tsd-kind-type-alias">Func</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">params</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">unknown</span><ahref="#runasynconbackendwithmanualtransactionhandling-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Executes given anonymous function on the backend.
Internally this serializes the anonymous function into string and sends it to backend via AJAX.
This function is meant for advanced needs where an async function is necessary.
In this case, the automatic request-scoped transaction management is not applied,
and you need to manually define transaction via api.transactional().</p>
<p>If you have a synchronous function, please use api.runOnBackend().</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">func</span>: <ahref="../types/Frontend_Script_API._internal_.Func.html"class="tsd-signature-type tsd-kind-type-alias">Func</a></span><divclass="tsd-comment tsd-typography"><p>(synchronous) function to be executed on the backend</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">params</span>: <spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>list of parameters to the anonymous function to be sent to backend</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">unknown</span></h4><p>return value of the executed function on the backend</p>
<divclass="tsd-comment tsd-typography"><divclass="tsd-tag-method"><h4class="tsd-anchor-link"id="method-6">Method<ahref="#method-6"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L166">src/public/app/services/frontend_script_api.ts:166</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="runonbackend"><span>run<wbr/>On<wbr/>Backend</span><ahref="#runonbackend"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="runonbackend-1"><spanclass="tsd-kind-call-signature">runOnBackend</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">func</span><spanclass="tsd-signature-symbol">:</span><ahref="../types/Frontend_Script_API._internal_.Func.html"class="tsd-signature-type tsd-kind-type-alias">Func</a><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">params</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">unknown</span><ahref="#runonbackend-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Executes given anonymous function on the backend.
Internally this serializes the anonymous function into string and sends it to backend via AJAX.
Please make sure that the supplied function is synchronous. Only sync functions will work correctly
with transaction management. If you really know what you're doing, you can call api.runAsyncOnBackendWithManualTransactionHandling()</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">func</span>: <ahref="../types/Frontend_Script_API._internal_.Func.html"class="tsd-signature-type tsd-kind-type-alias">Func</a></span><divclass="tsd-comment tsd-typography"><p>(synchronous) function to be executed on the backend</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">params</span>: <spanclass="tsd-signature-type">unknown</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>list of parameters to the anonymous function to be sent to backend</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">unknown</span></h4><p>return value of the executed function on the backend</p>
<divclass="tsd-comment tsd-typography"><divclass="tsd-tag-method"><h4class="tsd-anchor-link"id="method-7">Method<ahref="#method-7"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L150">src/public/app/services/frontend_script_api.ts:150</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="searchfornote"><span>search<wbr/>For<wbr/>Note</span><ahref="#searchfornote"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="searchfornote-1"><spanclass="tsd-kind-call-signature">searchForNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">searchString</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span><ahref="#searchfornote-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>This is a powerful search method - you can search by attributes and their values, e.g.:
"#dateModified =* MONTH AND #log". See full documentation for all options at: <ahref="https://triliumnext.github.io/Docs/Wiki/search.html">https://triliumnext.github.io/Docs/Wiki/search.html</a></p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">searchString</span>: <spanclass="tsd-signature-type">string</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L178">src/public/app/services/frontend_script_api.ts:178</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="searchfornotes"><span>search<wbr/>For<wbr/>Notes</span><ahref="#searchfornotes"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="searchfornotes-1"><spanclass="tsd-kind-call-signature">searchForNotes</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">searchString</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">></span><ahref="#searchfornotes-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>This is a powerful search method - you can search by attributes and their values, e.g.:
"#dateModified =* MONTH AND #log". See full documentation for all options at: <ahref="https://triliumnext.github.io/Docs/Wiki/search.html">https://triliumnext.github.io/Docs/Wiki/search.html</a></p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">searchString</span>: <spanclass="tsd-signature-type">string</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><ahref="../classes/Frontend_Script_API.FNote.html"class="tsd-signature-type tsd-kind-class">FNote</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/84c2ebd7f3245ef3f6cddc8669bb5117079e316c/src/public/app/services/frontend_script_api.ts#L172">src/public/app/services/frontend_script_api.ts:172</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="sethoistednoteid"><span>set<wbr/>Hoisted<wbr/>Note<wbr/>Id</span><ahref="#sethoistednoteid"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="sethoistednoteid-1"><spanclass="tsd-kind-call-signature">setHoistedNoteId</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">noteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#sethoistednoteid-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"aria-hidden="true"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></div><divclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Hoist note in the current tab. See <ahref="https://triliumnext.github.io/Docs/Wiki/note-hoisting.html">https://triliumnext.github.io/Docs/Wiki/note-hoisting.html</a></p>
