</div></section></div></details></section></section><detailsclass="tsd-panel-group tsd-member-group tsd-accordion"open><summaryclass="tsd-accordion-summary"data-key="section-Properties"><svgwidth="20"height="20"viewBox="0 0 24 24"fill="none"aria-hidden="true"><usehref="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="__private"><span>__private</span><ahref="#__private"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">__private</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">{</span><spanclass="tsd-kind-property">becca</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Backend_Script_API._internal_.default.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">}</span></div><divclass="tsd-comment tsd-typography"><p>This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.</p>
</div><divclass="tsd-type-declaration"><h4>Type declaration</h4><ulclass="tsd-parameters"><liclass="tsd-parameter"><h5><spanclass="tsd-kind-property">becca</span><spanclass="tsd-signature-symbol">: </span><ahref="../classes/Backend_Script_API._internal_.default.html"class="tsd-signature-type tsd-kind-class">default</a></h5><divclass="tsd-comment tsd-typography"><p>provides access to the backend in-memory object graph, see <ahref="../classes/Backend_Script_API._internal_.default.html"class="tsd-kind-class">Becca</a></p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L403">src/services/backend_script_api.ts:403</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="axios"><spanclass="deprecated">axios</span><ahref="#axios"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">axios</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API._internal_.AxiosStatic.html"class="tsd-signature-type tsd-kind-interface">AxiosStatic</a></div><divclass="tsd-comment tsd-typography"><p>Axios library for HTTP requests. See <ahref="https://axios-http.com">https://axios-http.com</a> for documentation</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L102">src/services/backend_script_api.ts:102</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/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></div><divclass="tsd-comment tsd-typography"><p>Note where the script is currently executing. This comes into play when your script is spread in multiple code
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L74">src/services/backend_script_api.ts:74</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. See <ahref="https://day.js.org">https://day.js.org</a> for documentation</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L90">src/services/backend_script_api.ts:90</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L207">src/services/backend_script_api.ts:207</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/Backend_Script_API._internal_.SpacedUpdate.html"class="tsd-signature-type tsd-kind-class">SpacedUpdate</a><spanclass="tsd-signature-symbol">></span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L208">src/services/backend_script_api.ts:208</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="originentity"><codeclass="tsd-tag">Optional</code><span>origin<wbr/>Entity</span><ahref="#originentity"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">originEntity</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.AbstractBeccaEntity.html"class="tsd-signature-type tsd-kind-class">AbstractBeccaEntity</a><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Entity whose event triggered this execution</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L79">src/services/backend_script_api.ts:79</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="sql"><span>sql</span><ahref="#sql"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">sql</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">any</span></div><divclass="tsd-comment tsd-typography"><p>sql</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L333">src/services/backend_script_api.ts:333</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="startnote"><codeclass="tsd-tag">Optional</code><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><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></div><divclass="tsd-comment tsd-typography"><p>Note where the script started executing (entrypoint).
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L66">src/services/backend_script_api.ts:66</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="xml2js"><span>xml2js</span><ahref="#xml2js"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">xml2js</span><spanclass="tsd-signature-symbol">:</span><ahref="../modules/Backend_Script_API._internal_.node_modules__types_xml2js.html"class="tsd-signature-type tsd-kind-namespace">node_modules/@types/xml2js</a></div><divclass="tsd-comment tsd-typography"><p>xml2js library for XML parsing. See <ahref="https://github.com/Leonidas-from-XIV/node-xml2js">https://github.com/Leonidas-from-XIV/node-xml2js</a> for documentation</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L96">src/services/backend_script_api.ts:96</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="backupnow"><span>backup<wbr/>Now</span><ahref="#backupnow"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="backupnow-1"><spanclass="tsd-kind-call-signature">backupNow</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">backupName</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">string</span><spanclass="tsd-signature-symbol">></span><ahref="#backupnow-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-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">backupName</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file</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">string</span><spanclass="tsd-signature-symbol">></span></h4><p>resolves once the backup is finished</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L398">src/services/backend_script_api.ts:398</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="createdatanote"><span>create<wbr/>Data<wbr/>Note</span><ahref="#createdatanote"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="createdatanote-1"><spanclass="tsd-kind-call-signature">createDataNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">parentNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">title</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">content</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">{}</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API._internal_.NoteAndBranch.html"class="tsd-signature-type tsd-kind-interface">NoteAndBranch</a><ahref="#createdatanote-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>Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and
<divclass="tsd-comment tsd-typography"><divclass="tsd-tag-deprecated"><h4class="tsd-anchor-link"id="deprecated-1">Deprecated<ahref="#deprecated-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><p>please use createTextNote() with similar API for simpler use cases or createNewNote() for more complex needs</p>
</div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L196">src/services/backend_script_api.ts:196</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="createorupdatelauncher"><span>create<wbr/>Or<wbr/>Update<wbr/>Launcher</span><ahref="#createorupdatelauncher"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="createorupdatelauncher-1"><spanclass="tsd-kind-call-signature">createOrUpdateLauncher</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">opts</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">{</span><br/><spanclass="tsd-kind-property">icon</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">id</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">isVisible</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">keyboardShortcut</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">scriptNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">targetNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">title</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">type</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">"script"</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"note"</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"customWidget"</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">widgetNoteId</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-signature-symbol">}</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">{</span><spanclass="tsd-kind-property">note</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><spanclass="tsd-signature-symbol">}</span><ahref="#createorupdatelauncher-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>Creates 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>: <spanclass="tsd-signature-symbol">{</span><br/><spanclass="tsd-kind-property">icon</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">id</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">isVisible</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">keyboardShortcut</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">scriptNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">targetNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">title</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">type</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">"script"</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"note"</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"customWidget"</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-kind-property">widgetNoteId</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">;</span><br/><spanclass="tsd-signature-symbol">}</span></span><ulclass="tsd-parameters"><liclass="tsd-parameter"><h5><spanclass="tsd-kind-property">icon</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">string</span></h5><divclass="tsd-comment tsd-typography"><p>name of the boxicon to be used (e.g. "bx-time")</p>
</div><divclass="tsd-comment tsd-typography"></div></li><liclass="tsd-parameter"><h5><spanclass="tsd-kind-property">id</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">string</span></h5><divclass="tsd-comment tsd-typography"><p>id of the launcher, only alphanumeric at least 6 characters long</p>
</div><divclass="tsd-comment tsd-typography"></div></li><liclass="tsd-parameter"><h5><spanclass="tsd-kind-property">isVisible</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span></h5><divclass="tsd-comment tsd-typography"><p>if true, will be created in the "Visible launchers", otherwise in "Available launchers"</p>
</div><divclass="tsd-comment tsd-typography"></div></li><liclass="tsd-parameter"><h5><spanclass="tsd-kind-property">keyboardShortcut</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">string</span></h5><divclass="tsd-comment tsd-typography"><p>will activate the target note/script upon pressing, e.g. "ctrl+e"</p>
</div><divclass="tsd-comment tsd-typography"></div></li><liclass="tsd-parameter"><h5><spanclass="tsd-kind-property">scriptNoteId</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">string</span></h5><divclass="tsd-comment tsd-typography"><p>for type "script"</p>
</div><divclass="tsd-comment tsd-typography"></div></li><liclass="tsd-parameter"><h5><spanclass="tsd-kind-property">targetNoteId</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">string</span></h5><divclass="tsd-comment tsd-typography"><p>for type "note"</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-symbol">{</span><spanclass="tsd-kind-property">note</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L340">src/services/backend_script_api.ts:340</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="createtextnote"><span>create<wbr/>Text<wbr/>Note</span><ahref="#createtextnote"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="createtextnote-1"><spanclass="tsd-kind-call-signature">createTextNote</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">parentNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">title</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">content</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API._internal_.NoteAndBranch.html"class="tsd-signature-type tsd-kind-interface">NoteAndBranch</a><ahref="#createtextnote-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>Create text note. See also createNewNote() for more options.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">parentNoteId</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">title</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">content</span>: <spanclass="tsd-signature-type">string</span></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="Backend_Script_API._internal_.NoteAndBranch.html"class="tsd-signature-type tsd-kind-interface">NoteAndBranch</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L178">src/services/backend_script_api.ts:178</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="ensurenoteisabsentfromparent"><span>ensure<wbr/>Note<wbr/>Is<wbr/>Absent<wbr/>From<wbr/>Parent</span><ahref="#ensurenoteisabsentfromparent"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="ensurenoteisabsentfromparent-1"><spanclass="tsd-kind-call-signature">ensureNoteIsAbsentFromParent</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-kind-parameter">parentNoteId</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="#ensurenoteisabsentfromparent-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>If there's a branch between note and parent note, remove it. Otherwise, do nothing.</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><li><span><spanclass="tsd-kind-parameter">parentNoteId</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L165">src/services/backend_script_api.ts:165</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="ensurenoteispresentinparent"><span>ensure<wbr/>Note<wbr/>Is<wbr/>Present<wbr/>In<wbr/>Parent</span><ahref="#ensurenoteispresentinparent"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="ensurenoteispresentinparent-1"><spanclass="tsd-kind-call-signature">ensureNoteIsPresentInParent</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">parentNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">prefix</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">{</span><spanclass="tsd-kind-property">branch</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BBranch.html"class="tsd-signature-type tsd-kind-class">BBranch</a><spanclass="tsd-signature-symbol">}</span><ahref="#ensurenoteispresentinparent-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>If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.</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><li><span><spanclass="tsd-kind-parameter">parentNoteId</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">prefix</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>if branch is created between note and parent note, set this prefix</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L108">src/services/backend_script_api.ts:108</a></li></ul></aside></div></li></ul></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><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getmonthnote-1"><spanclass="tsd-kind-call-signature">getMonthNote</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-kind-parameter">rootNote</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><spanclass="tsd-signature-symbol">></span><ahref="#getmonthnote-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 month note for given date. If such a note doesn't exist, it is created.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L139">src/services/backend_script_api.ts:139</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getnotewithlabel"><span>get<wbr/>Note<wbr/>With<wbr/>Label</span><ahref="#getnotewithlabel"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="getnotewithlabel-1"><spanclass="tsd-kind-call-signature">getNoteWithLabel</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">name</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">value</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">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><ahref="#getnotewithlabel-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>Retrieves first note with given label name & value</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">rootNote</span>: <ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></span><divclass="tsd-comment tsd-typography"><p>specify calendar root note, normally leave empty to use the default calendar</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/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L266">src/services/backend_script_api.ts:266</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getrevision"><span>get<wbr/>Revision</span><ahref="#getrevision"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="getrevision-1"><spanclass="tsd-kind-call-signature">getRevision</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">revisionId</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">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BRevision.html"class="tsd-signature-type tsd-kind-class">BRevision</a><ahref="#getrevision-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-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">revisionId</span>: <spanclass="tsd-signature-type">string</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BRevision.html"class="tsd-signature-type tsd-kind-class">BRevision</a></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L114">src/services/backend_script_api.ts:114</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getrootcalendarnote"><span>get<wbr/>Root<wbr/>Calendar<wbr/>Note</span><ahref="#getrootcalendarnote"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="getrootcalendarnote-1"><spanclass="tsd-kind-call-signature">getRootCalendarNote</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><ahref="#getrootcalendarnote-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 root note of the calendar.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L218">src/services/backend_script_api.ts:218</a></li></ul></aside></div></li></ul></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><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="gettodaynote-1"><spanclass="tsd-kind-call-signature">getTodayNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">rootNote</span><spanclass="tsd-signature-symbol">?:</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><spanclass="tsd-signature-symbol">></span><ahref="#gettodaynote-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 today's day note. If such note doesn't exist, it is created.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">rootNote</span>: <ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></span><divclass="tsd-comment tsd-typography"><p>specify calendar root note, normally leave empty to use the default calendar</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/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L234">src/services/backend_script_api.ts:234</a></li></ul></aside></div></li></ul></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><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getweekfirstdaynote-1"><spanclass="tsd-kind-call-signature">getWeekFirstDayNote</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-kind-parameter">rootNote</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><spanclass="tsd-signature-symbol">></span><ahref="#getweekfirstdaynote-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 for the first date of the week of the given date.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">rootNote</span>: <ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></span><divclass="tsd-comment tsd-typography"><p>specify calendar root note, normally leave empty to use the default calendar</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/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L242">src/services/backend_script_api.ts:242</a></li></ul></aside></div></li></ul></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><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getweeknote-1"><spanclass="tsd-kind-call-signature">getWeekNote</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-kind-parameter">rootNote</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><spanclass="tsd-signature-symbol">></span><ahref="#getweeknote-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 week note for given date. If such a note doesn't exist, it is created.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">rootNote</span>: <ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></span><divclass="tsd-comment tsd-typography"><p>specify calendar root note, normally leave empty to use the default calendar</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/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L250">src/services/backend_script_api.ts:250</a></li></ul></aside></div></li></ul></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><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="getyearnote-1"><spanclass="tsd-kind-call-signature">getYearNote</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-kind-parameter">rootNote</span><spanclass="tsd-signature-symbol">?:</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><ahref="#getyearnote-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 year note for given year. If such a note doesn't exist, it is created.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">rootNote</span>: <ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></span><divclass="tsd-comment tsd-typography"><p>specify calendar root note, normally leave empty to use the default calendar</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L274">src/services/backend_script_api.ts:274</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 trilium logs and 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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L213">src/services/backend_script_api.ts:213</a></li></ul></aside></div></li></ul></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><ulclass="tsd-signatures"><liclass=""><divclass="tsd-signature tsd-anchor-link"id="randomstring-1"><spanclass="tsd-kind-call-signature">randomString</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">length</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><ahref="#randomstring-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>Return randomly generated string of given length. This random string generation is NOT cryptographically secure.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">length</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>of the string</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L315">src/services/backend_script_api.ts:315</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="runonfrontend"><span>run<wbr/>On<wbr/>Frontend</span><ahref="#runonfrontend"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="runonfrontend-1"><spanclass="tsd-kind-call-signature">runOnFrontend</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">script</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">params</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">[</span><spanclass="tsd-signature-symbol">]</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#runonfrontend-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 frontend(s).
Internally, this serializes the anonymous function into string and sends it to frontend(s) via WebSocket.
Note that there can be multiple connected frontend instances (e.g. in different tabs). In such case, all
instances execute the given function.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">script</span>: <spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">void</span></span><divclass="tsd-comment tsd-typography"><p>script to be executed on the frontend</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">params</span>: <spanclass="tsd-signature-symbol">[</span><spanclass="tsd-signature-symbol">]</span></span><divclass="tsd-comment tsd-typography"><p>list of parameters to the anonymous function to be sent to frontend</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><p>no return value is provided.</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L379">src/services/backend_script_api.ts:379</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="runoutsideofsync"><span>run<wbr/>Outside<wbr/>Of<wbr/>Sync</span><ahref="#runoutsideofsync"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="runoutsideofsync-1"><spanclass="tsd-kind-call-signature">runOutsideOfSync</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">callback</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">void</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="#runoutsideofsync-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>Sync process can make data intermittently inconsistent. Scripts which require strong data consistency
can use this function to wait for a possible sync process to finish and prevent new sync process from starting
while it is running.</p>
<p>Because this is an async process, the inner callback doesn't have automatic transaction handling, so in case
you need to make some DB changes, you need to surround your call with api.transactional(...)</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">callback</span>: <spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">void</span></span><divclass="tsd-comment tsd-typography"><p>function to be executed while sync process is not running</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><p>resolves once the callback is finished (callback is awaited)</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L392">src/services/backend_script_api.ts:392</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">query</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">searchParams</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API._internal_.SearchParams.html"class="tsd-signature-type tsd-kind-interface">SearchParams</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><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 <ahref="https://triliumnext.github.io/Docs/Wiki/search.html">https://triliumnext.github.io/Docs/Wiki/search.html</a> for full documentation for all options</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">query</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">searchParams</span>: <ahref="Backend_Script_API._internal_.SearchParams.html"class="tsd-signature-type tsd-kind-interface">SearchParams</a></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L131">src/services/backend_script_api.ts:131</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">query</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><spanclass="tsd-kind-parameter">searchParams</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API._internal_.SearchParams.html"class="tsd-signature-type tsd-kind-interface">SearchParams</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</a><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 <ahref="https://triliumnext.github.io/Docs/Wiki/search.html">https://triliumnext.github.io/Docs/Wiki/search.html</a> for full documentation for all options</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">query</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">searchParams</span>: <ahref="Backend_Script_API._internal_.SearchParams.html"class="tsd-signature-type tsd-kind-interface">SearchParams</a></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="../classes/Backend_Script_API._internal_.BNote.html"class="tsd-signature-type tsd-kind-class">BNote</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L125">src/services/backend_script_api.ts:125</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="setnotetoparent"><spanclass="deprecated">set<wbr/>Note<wbr/>To<wbr/>Parent</span><ahref="#setnotetoparent"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="setnotetoparent-1"><spanclass="tsd-kind-call-signature">setNoteToParent</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">prefix</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">parentNoteId</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><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#setnotetoparent-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 method finds note by its noteId and prefix and either sets it to the given parentNoteId
</div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L298">src/services/backend_script_api.ts:298</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="sortnotes"><span>sort<wbr/>Notes</span><ahref="#sortnotes"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="sortnotes-1"><spanclass="tsd-kind-call-signature">sortNotes</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">parentNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">sortConfig</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">{</span><spanclass="tsd-kind-property">foldersFirst</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">;</span><spanclass="tsd-kind-property">reverse</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">;</span><spanclass="tsd-kind-property">sortBy</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</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">void</span><ahref="#sortnotes-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>Sort child notes of a given note.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">parentNoteId</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">sortConfig</span>: <spanclass="tsd-signature-symbol">{</span><spanclass="tsd-kind-property">foldersFirst</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">;</span><spanclass="tsd-kind-property">reverse</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">;</span><spanclass="tsd-kind-property">sortBy</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">}</span></span><ulclass="tsd-parameters"><liclass="tsd-parameter"><h5><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-property">foldersFirst</span><spanclass="tsd-signature-symbol">?: </span><spanclass="tsd-signature-type">boolean</span></h5></li><liclass="tsd-parameter"><h5><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-property">reverse</span><spanclass="tsd-signature-symbol">?: </span><spanclass="tsd-signature-type">boolean</span></h5></li><liclass="tsd-parameter"><h5><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-property">sortBy</span><spanclass="tsd-signature-symbol">?: </span><spanclass="tsd-signature-type">string</span></h5><divclass="tsd-comment tsd-typography"><p>'title', 'dateCreated', 'dateModified' or a label name
See <ahref="https://triliumnext.github.io/Docs/Wiki/sorting.html">https://triliumnext.github.io/Docs/Wiki/sorting.html</a> for details.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L279">src/services/backend_script_api.ts:279</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="togglenoteinparent"><span>toggle<wbr/>Note<wbr/>In<wbr/>Parent</span><ahref="#togglenoteinparent"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="togglenoteinparent-1"><spanclass="tsd-kind-call-signature">toggleNoteInParent</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">present</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">true</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">parentNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">prefix</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#togglenoteinparent-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>Based on the value, either create or remove branch between note and parent note.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">present</span>: <spanclass="tsd-signature-type">true</span></span><divclass="tsd-comment tsd-typography"><p>true if we want the branch to exist, false if we want it gone</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">noteId</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">parentNoteId</span>: <spanclass="tsd-signature-type">string</span></span></li><li><span><spanclass="tsd-kind-parameter">prefix</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>if branch is created between note and parent note, set this prefix</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/dd42c067f9b6d7a4612e40d3b9086d9e7101ea54/src/services/backend_script_api.ts#L173">src/services/backend_script_api.ts:173</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="transactional"><span>transactional</span><ahref="#transactional"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="transactional-1"><spanclass="tsd-kind-call-signature">transactional</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">func</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">=></span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">any</span><ahref="#transactional-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 functions wraps code which is supposed to be running in transaction. If transaction already
