</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L118">src/becca/entities/bnote.ts:118</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="contentandattachmentssize"><span>content<wbr/>And<wbr/>Attachments<wbr/>Size</span><ahref="#contentandattachmentssize"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">contentAndAttachmentsSize</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>size of the note content, attachment contents in bytes</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L116">src/becca/entities/bnote.ts:116</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="contentsize"><span>content<wbr/>Size</span><ahref="#contentsize"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">contentSize</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>size of the content in bytes</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L114">src/becca/entities/bnote.ts:114</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="datecreated"><codeclass="tsd-tag">Optional</code><span>date<wbr/>Created</span><ahref="#datecreated"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">dateCreated</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="Backend_Script_API.AbstractBeccaEntity.html">AbstractBeccaEntity</a>.<ahref="Backend_Script_API.AbstractBeccaEntity.html#datecreated">dateCreated</a></p><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/abstract_becca_entity.ts#L27">src/becca/entities/abstract_becca_entity.ts:27</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="datemodified"><codeclass="tsd-tag">Optional</code><span>date<wbr/>Modified</span><ahref="#datemodified"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">dateModified</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="Backend_Script_API.AbstractBeccaEntity.html">AbstractBeccaEntity</a>.<ahref="Backend_Script_API.AbstractBeccaEntity.html#datemodified">dateModified</a></p><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/abstract_becca_entity.ts#L28">src/becca/entities/abstract_becca_entity.ts:28</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isbeingdeleted"><span>is<wbr/>Being<wbr/>Deleted</span><ahref="#isbeingdeleted"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">isBeingDeleted</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>set during the deletion operation, before it is completed (removed from becca completely).</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L97">src/becca/entities/bnote.ts:97</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isdecrypted"><span>is<wbr/>Decrypted</span><ahref="#isdecrypted"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">isDecrypted</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L98">src/becca/entities/bnote.ts:98</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="isprotected"><codeclass="tsd-tag">Optional</code><span>is<wbr/>Protected</span><ahref="#isprotected"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">isProtected</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="Backend_Script_API.AbstractBeccaEntity.html">AbstractBeccaEntity</a>.<ahref="Backend_Script_API.AbstractBeccaEntity.html#isprotected">isProtected</a></p><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/abstract_becca_entity.ts#L32">src/becca/entities/abstract_becca_entity.ts:32</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="issynced"><codeclass="tsd-tag">Optional</code><span>is<wbr/>Synced</span><ahref="#issynced"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">isSynced</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><p>Inherited from <ahref="Backend_Script_API.AbstractBeccaEntity.html">AbstractBeccaEntity</a>.<ahref="Backend_Script_API.AbstractBeccaEntity.html#issynced">isSynced</a></p><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/abstract_becca_entity.ts#L33">src/becca/entities/abstract_becca_entity.ts:33</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="mime"><span>mime</span><ahref="#mime"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">mime</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L95">src/becca/entities/bnote.ts:95</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="noteid"><span>note<wbr/>Id</span><ahref="#noteid"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">noteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L120">src/becca/entities/bnote.ts:120</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="targetrelations"><span>target<wbr/>Relations</span><ahref="#targetrelations"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">targetRelations</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L104">src/becca/entities/bnote.ts:104</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="title"><span>title</span><ahref="#title"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">title</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L93">src/becca/entities/bnote.ts:93</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="type"><span>type</span><ahref="#type"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">type</span><spanclass="tsd-signature-symbol">:</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"canvas"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"code"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"search"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"image"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"text"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"file"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"noteMap"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"launcher"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"doc"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"contentWidget"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"relationMap"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"render"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"mermaid"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"book"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"webView"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"mindMap"</span><br/><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"geoMa
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>name of the attribute, not including the leading ~/#</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> = ""</span></span><divclass="tsd-comment tsd-typography"><p>value of the attribute - text for labels, target note ID for relations; optional.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">isInheritable</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span></li><li><span><spanclass="tsd-kind-parameter">position</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = null</span></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1306">src/becca/entities/bnote.ts:1306</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="addlabel"><span>add<wbr/>Label</span><ahref="#addlabel"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="addlabel-1"><spanclass="tsd-kind-call-signature">addLabel</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-kind-parameter">isInheritable</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><ahref="#addlabel-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 label to this note. The label attribute is saved and returned.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>name of the label, not including the leading #</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> = ""</span></span><divclass="tsd-comment tsd-typography"><p>text value of the label; optional</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">isInheritable</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1323">src/becca/entities/bnote.ts:1323</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="addrelation"><span>add<wbr/>Relation</span><ahref="#addrelation"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="addrelation-1"><spanclass="tsd-kind-call-signature">addRelation</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">name</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">targetNoteId</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">isInheritable</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><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><ahref="#addrelation-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 relation to this note. The relation attribute is saved and
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>name of the relation, not including the leading ~</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">opts</span>: <ahref="../interfaces/Backend_Script_API._internal_.ConvertOpts.html"class="tsd-signature-type tsd-kind-interface">ConvertOpts</a><spanclass="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="Backend_Script_API.BAttachment.html"class="tsd-signature-type tsd-kind-class">BAttachment</a></h4><p>null if note is not eligible for conversion</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1475">src/becca/entities/bnote.ts:1475</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="decrypt"><span>decrypt</span><ahref="#decrypt"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="decrypt-1"><spanclass="tsd-kind-call-signature">decrypt</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#decrypt-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">void</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1537">src/becca/entities/bnote.ts:1537</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="deletenote"><span>delete<wbr/>Note</span><ahref="#deletenote"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="deletenote-1"><spanclass="tsd-kind-call-signature">deleteNote</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">deleteId</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><spanclass="tsd-kind-parameter">taskContext</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><ahref="Backend_Script_API._internal_.TaskContext.html"class="tsd-signature-type tsd-kind-class">TaskContext</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#deletenote-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>(Soft) delete a note and all its descendants.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">[]</span></h4><p>array of notePaths (each represented by array of noteIds constituting the particular note path)</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="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a></h4><p>attribute of the given type and name. If there are more such attributes, first is returned.
</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">type</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>(optional) attribute type to filter</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>(optional) attribute name to filter</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><spanclass="tsd-signature-type">string</span></h4><p>attribute value of given type and name or null if no such attribute exists.</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L616">src/becca/entities/bnote.ts:616</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getbestnotepath"><span>get<wbr/>Best<wbr/>Note<wbr/>Path</span><ahref="#getbestnotepath"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="getbestnotepath-1"><spanclass="tsd-kind-call-signature">getBestNotePath</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">hoistedNoteId</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">string</span><spanclass="tsd-signature-symbol">[]</span><ahref="#getbestnotepath-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 a note path considered to be the "best"</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1208">src/becca/entities/bnote.ts:1208</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getbestnotepathstring"><span>get<wbr/>Best<wbr/>Note<wbr/>Path<wbr/>String</span><ahref="#getbestnotepathstring"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="getbestnotepathstring-1"><spanclass="tsd-kind-call-signature">getBestNotePathString</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">hoistedNoteId</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">string</span><ahref="#getbestnotepathstring-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 a note path considered to be the "best"</p>
part of Note entity with its own sync. Reasons behind this hybrid design has been:</p>
<ul>
<li>content can be quite large, and it's not necessary to load it / fill memory for any note access even if we don't need a content, especially for bulk operations like search</li>
<li>changes in the note metadata or title should not trigger note content sync (so we keep separate utcDateModified and entity changes records)</li>
<li>but to the user note content and title changes are one and the same - single dateModified (so all changes must go through Note and content is not a separate entity)</li>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L784">src/becca/entities/bnote.ts:784</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="geticon"><span>get<wbr/>Icon</span><ahref="#geticon"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="geticon-1"><spanclass="tsd-kind-call-signature">getIcon</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><ahref="#geticon-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">string</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1716">src/becca/entities/bnote.ts:1716</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getinheritingnotes"><span>get<wbr/>Inheriting<wbr/>Notes</span><ahref="#getinheritingnotes"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="getinheritingnotes-1"><spanclass="tsd-kind-call-signature">getInheritingNotes</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><ahref=""class="tsd-signature-type tsd-kind-class">BNote</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getinheritingnotes-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=""class="tsd-signature-type tsd-kind-class">BNote</a><spanclass="tsd-signature-symbol">[]</span></h4><p>returns only notes which are templated, does not include their subtrees
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1071">src/becca/entities/bnote.ts:1071</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getjsoncontent"><span>get<wbr/>Json<wbr/>Content</span><ahref="#getjsoncontent"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="getjsoncontent-1"><spanclass="tsd-kind-call-signature">getJsonContent</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">any</span><ahref="#getjsoncontent-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">any</span></h4><divclass="tsd-comment tsd-typography"><divclass="tsd-tag-throws"><h4class="tsd-anchor-link"id="throws">Throws<ahref="#throws"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>Error in case of invalid JSON</p>
</div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L242">src/becca/entities/bnote.ts:242</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getjsoncontentsafely"><span>get<wbr/>Json<wbr/>Content<wbr/>Safely</span><ahref="#getjsoncontentsafely"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="getjsoncontentsafely-1"><spanclass="tsd-kind-call-signature">getJsonContentSafely</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">any</span><ahref="#getjsoncontentsafely-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">any</span></h4><p>valid object or null if the content cannot be parsed as JSON</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="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a></h4><p>label if it exists, null otherwise</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L529">src/becca/entities/bnote.ts:529</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getlabeldefinitions"><span>get<wbr/>Label<wbr/>Definitions</span><ahref="#getlabeldefinitions"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="getlabeldefinitions-1"><spanclass="tsd-kind-call-signature">getLabelDefinitions</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getlabeldefinitions-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="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L851">src/becca/entities/bnote.ts:851</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getlabels"><span>get<wbr/>Labels</span><ahref="#getlabels"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="getlabels-1"><spanclass="tsd-kind-call-signature">getLabels</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-signature-symbol">:</span><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getlabels-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><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>label name to filter</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span></h4><p>all note's labels (attributes with type label), including inherited ones</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><spanclass="tsd-signature-type">string</span></h4><p>label value if label exists, null otherwise</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L711">src/becca/entities/bnote.ts:711</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getownedattributes"><span>get<wbr/>Owned<wbr/>Attributes</span><ahref="#getownedattributes"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="getownedattributes-1"><spanclass="tsd-kind-call-signature">getOwnedAttributes</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">type</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-kind-parameter">name</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-kind-parameter">value</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><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getownedattributes-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>Beware that the method must not create a copy of the array, but actually returns its internal array
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">type</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>(optional) attribute type to filter</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">name</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>(optional) attribute name to filter</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">value</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>(optional) attribute value to filter</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><spanclass="tsd-signature-type">string</span></h4><p>attribute value of given type and name or null if no such attribute exists.</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="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a></h4><p>label if it exists, null otherwise</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L537">src/becca/entities/bnote.ts:537</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getownedlabels"><span>get<wbr/>Owned<wbr/>Labels</span><ahref="#getownedlabels"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="getownedlabels-1"><spanclass="tsd-kind-call-signature">getOwnedLabels</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-signature-symbol">:</span><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getownedlabels-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">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>label name to filter</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span></h4><p>all note's labels (attributes with type label), excluding inherited ones</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><spanclass="tsd-signature-type">string</span></h4><p>label value if label exists, null otherwise</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="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a></h4><p>relation if it exists, null otherwise</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L553">src/becca/entities/bnote.ts:553</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getownedrelations"><span>get<wbr/>Owned<wbr/>Relations</span><ahref="#getownedrelations"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="getownedrelations-1"><spanclass="tsd-kind-call-signature">getOwnedRelations</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">name</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><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getownedrelations-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><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">null</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>relation name to filter</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span></h4><p>all note's relations (attributes with type relation), excluding inherited ones</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><spanclass="tsd-signature-type">string</span></h4><p>relation value if relation exists, null otherwise</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="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a></h4><p>relation if it exists, null otherwise</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L545">src/becca/entities/bnote.ts:545</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getrelationdefinitions"><span>get<wbr/>Relation<wbr/>Definitions</span><ahref="#getrelationdefinitions"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="getrelationdefinitions-1"><spanclass="tsd-kind-call-signature">getRelationDefinitions</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getrelationdefinitions-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="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L847">src/becca/entities/bnote.ts:847</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="getrelations"><span>get<wbr/>Relations</span><ahref="#getrelations"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="getrelations-1"><spanclass="tsd-kind-call-signature">getRelations</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-signature-symbol">:</span><ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span><ahref="#getrelations-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><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">name</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>relation name to filter</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="Backend_Script_API.BAttribute.html"class="tsd-signature-type tsd-kind-class">BAttribute</a><spanclass="tsd-signature-symbol">[]</span></h4><p>all note's relations (attributes with type relation), including inherited ones</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><spanclass="tsd-signature-type">string</span></h4><p>relation value if relation exists, null otherwise</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if note has an attribute with given type and name (excluding inherited)</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1226">src/becca/entities/bnote.ts:1226</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="ishtml"><span>is<wbr/>Html</span><ahref="#ishtml"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="ishtml-1"><spanclass="tsd-kind-call-signature">isHtml</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#ishtml-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">boolean</span></h4><p>true if this note is HTML</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L306">src/becca/entities/bnote.ts:306</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isimage"><span>is<wbr/>Image</span><ahref="#isimage"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="isimage-1"><spanclass="tsd-kind-call-signature">isImage</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#isimage-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">boolean</span></h4><p>true if this note is an image</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L311">src/becca/entities/bnote.ts:311</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isinherited"><span>is<wbr/>Inherited</span><ahref="#isinherited"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="isinherited-1"><spanclass="tsd-kind-call-signature">isInherited</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#isinherited-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">boolean</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L855">src/becca/entities/bnote.ts:855</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isinhiddensubtree"><span>is<wbr/>In<wbr/>Hidden<wbr/>Subtree</span><ahref="#isinhiddensubtree"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="isinhiddensubtree-1"><spanclass="tsd-kind-call-signature">isInHiddenSubtree</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#isinhiddensubtree-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">boolean</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1061">src/becca/entities/bnote.ts:1061</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isjavascript"><span>is<wbr/>Java<wbr/>Script</span><ahref="#isjavascript"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="isjavascript-1"><spanclass="tsd-kind-call-signature">isJavaScript</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#isjavascript-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">boolean</span></h4><p>true if this note is JavaScript (code or attachment)</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L298">src/becca/entities/bnote.ts:298</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isjson"><span>is<wbr/>Json</span><ahref="#isjson"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="isjson-1"><spanclass="tsd-kind-call-signature">isJson</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#isjson-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">boolean</span></h4><p>true if this note is of application/json content type</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><p>true if label exists (including inherited) and does not have "false" value.</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L488">src/becca/entities/bnote.ts:488</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="islaunchbarconfig"><span>is<wbr/>Launch<wbr/>Bar<wbr/>Config</span><ahref="#islaunchbarconfig"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="islaunchbarconfig-1"><spanclass="tsd-kind-call-signature">isLaunchBarConfig</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#islaunchbarconfig-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">boolean</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1550">src/becca/entities/bnote.ts:1550</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isoptions"><span>is<wbr/>Options</span><ahref="#isoptions"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="isoptions-1"><spanclass="tsd-kind-call-signature">isOptions</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#isoptions-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">boolean</span></h4><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1556">src/becca/entities/bnote.ts:1556</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="isroot"><span>is<wbr/>Root</span><ahref="#isroot"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="isroot-1"><spanclass="tsd-kind-call-signature">isRoot</span><spanclass="tsd-signature-symbol">()</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span><ahref="#isroot-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">boolean</span></h4><p>true if this note is the root of the note tree. Root note has "root" noteId</p>
</div></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L316">src/becca/entities/bnote.ts:316</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="markasdeleted"><span>mark<wbr/>As<wbr/>Deleted</span><ahref="#markasdeleted"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 tsd-is-inherited"><liclass="tsd-is-inherited"><divclass="tsd-signature tsd-anchor-link"id="markasdeleted-1"><spanclass="tsd-kind-call-signature">markAsDeleted</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">deleteId</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><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">void</span><ahref="#markasdeleted-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>Mark the entity as (soft) deleted. It will be completely erased later.</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/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1411">src/becca/entities/bnote.ts:1411</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><h3class="tsd-anchor-link"id="save"><span>save</span><ahref="#save"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 tsd-is-inherited"><liclass="tsd-is-inherited"><divclass="tsd-signature tsd-anchor-link"id="save-1"><spanclass="tsd-kind-call-signature">save</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">opts</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">this</span><ahref="#save-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>Saves entity - executes SQL, but doesn't commit the transaction on its own</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">opts</span>: <spanclass="tsd-signature-symbol">{}</span></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from <ahref="Backend_Script_API.AbstractBeccaEntity.html">AbstractBeccaEntity</a>.<ahref="Backend_Script_API.AbstractBeccaEntity.html#save">save</a></p><ul><li>Defined in <ahref="https://github.com/TriliumNext/Notes/blob/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/abstract_becca_entity.ts#L103">src/becca/entities/abstract_becca_entity.ts:103</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="saveattachment"><span>save<wbr/>Attachment</span><ahref="#saveattachment"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="saveattachment-1"><spanclass="tsd-kind-call-signature">saveAttachment</span><spanclass="tsd-signature-symbol">(</span><br/><spanclass="tsd-kind-parameter">__namedParameters</span><spanclass="tsd-signature-symbol">:</span><ahref="../interfaces/Backend_Script_API._internal_.AttachmentRow.html"class="tsd-signature-type tsd-kind-interface">AttachmentRow</a><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-kind-parameter">matchBy</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"title"</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"attachmentId"</span><spanclass="tsd-signature-symbol">,</span><br/><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">:</span><ahref="Backend_Script_API.BAttachment.html"class="tsd-signature-type tsd-kind-class">BAttachment</a><ahref="#saveattachment-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">__namedParameters</span>: <ahref="../interfaces/Backend_Script_API._internal_.AttachmentRow.html"class="tsd-signature-type tsd-kind-interface">AttachmentRow</a></span></li><li><span><spanclass="tsd-kind-parameter">matchBy</span>: <spanclass="tsd-signature-type">undefined</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"title"</span><spanclass="tsd-signature-symbol">|</span><spanclass="tsd-signature-type">"attachmentId"</span><spanclass="tsd-signature-symbol"> = "attachmentId"</span></span><divclass="tsd-comment tsd-typography"><p>choose by which property we detect if to update an existing attachment.
</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/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1381">src/becca/entities/bnote.ts:1381</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="setrelation"><span>set<wbr/>Relation</span><ahref="#setrelation"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="setrelation-1"><spanclass="tsd-kind-call-signature">setRelation</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">void</span><ahref="#setrelation-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's given relation's value or creates it if it doesn't exist</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">enabled</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>toggle On or Off</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/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1345">src/becca/entities/bnote.ts:1345</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="togglelabel"><span>toggle<wbr/>Label</span><ahref="#togglelabel"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="togglelabel-1"><spanclass="tsd-kind-call-signature">toggleLabel</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">enabled</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</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">void</span><ahref="#togglelabel-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 enabled, label is either set or removed.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">enabled</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>toggle On or Off</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/c8860ea25a290fb8ec7d32800aae7bcb3d1bd128/src/becca/entities/bnote.ts#L1360">src/becca/entities/bnote.ts:1360</a></li></ul></aside></div></li></ul></section><sectionclass="tsd-panel tsd-member"><h3class="tsd-anchor-link"id="togglerelation"><span>toggle<wbr/>Relation</span><ahref="#togglerelation"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="togglerelation-1"><spanclass="tsd-kind-call-signature">toggleRelation</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">enabled</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</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">void</span><ahref="#togglerelation-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 enabled, relation is either set or removed.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">enabled</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>toggle On or Off</p>
