gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-06-06 18:08:33 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs updated

Browse Source
This commit is contained in:
zadam 2023-01-03 13:54:27 +01:00
parent bff7434921
commit b80bf0ffb6
36 changed files with 807 additions and 799 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/backend_api/AbstractEntity.html → docs/backend_api/AbstractBeccaEntity.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: AbstractEntity</title> <title>JSDoc: Class: AbstractBeccaEntity</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: AbstractEntity</h1> <h1 class="page-title">Class: AbstractBeccaEntity</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>AbstractEntity<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>AbstractBeccaEntity<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Base class for all backend entities.</div> <div class="class-description">Base class for all backend entities.</div>
@ -45,7 +45,7 @@
<h4 class="name" id="AbstractEntity"><span class="type-signature"></span>new AbstractEntity<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="AbstractBeccaEntity"><span class="type-signature"></span>new AbstractBeccaEntity<span class="signature">()</span><span class="type-signature"></span></h4>
@ -93,7 +93,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line16">line 16</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line16">line 16</a>
</li></ul></dd> </li></ul></dd>
@ -183,7 +183,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line53">line 53</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -259,7 +259,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line62">line 62</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
</li></ul></dd> </li></ul></dd>
@ -343,7 +343,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line18">line 18</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
</li></ul></dd> </li></ul></dd>
@ -427,7 +427,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line30">line 30</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -511,7 +511,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line23">line 23</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -595,7 +595,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line74">line 74</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
</li></ul></dd> </li></ul></dd>
@ -679,7 +679,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line45">line 45</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -833,7 +833,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line128">line 128</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
</li></ul></dd> </li></ul></dd>
@ -921,7 +921,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line83">line 83</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -985,7 +985,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

80
docs/backend_api/Attribute.html → docs/backend_api/BAttribute.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: Attribute</title> <title>JSDoc: Class: BAttribute</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: Attribute</h1> <h1 class="page-title">Class: BAttribute</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>Attribute<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>BAttribute<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair) <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
and relation (representing named relationship between source and target note)</div> and relation (representing named relationship between source and target note)</div>
@ -46,7 +46,7 @@ and relation (representing named relationship between source and target note)</d
<h4 class="name" id="Attribute"><span class="type-signature"></span>new Attribute<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="BAttribute"><span class="type-signature"></span>new BAttribute<span class="signature">()</span><span class="type-signature"></span></h4>
@ -94,7 +94,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line16">line 16</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line16">line 16</a>
</li></ul></dd> </li></ul></dd>
@ -134,7 +134,7 @@ and relation (representing named relationship between source and target note)</d
<ul> <ul>
<li><a href="AbstractEntity.html">AbstractEntity</a></li> <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
</ul> </ul>
@ -205,7 +205,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line47">line 47</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line47">line 47</a>
</li></ul></dd> </li></ul></dd>
@ -245,7 +245,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#becca">AbstractEntity#becca</a> <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
</li></ul></dd> </li></ul></dd>
@ -268,7 +268,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line53">line 53</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -336,7 +336,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line59">line 59</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line59">line 59</a>
</li></ul></dd> </li></ul></dd>
@ -404,7 +404,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line53">line 53</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -472,7 +472,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line49">line 49</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line49">line 49</a>
</li></ul></dd> </li></ul></dd>
@ -540,7 +540,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line55">line 55</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line55">line 55</a>
</li></ul></dd> </li></ul></dd>
@ -608,7 +608,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line51">line 51</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line51">line 51</a>
</li></ul></dd> </li></ul></dd>
@ -676,7 +676,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line61">line 61</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line61">line 61</a>
</li></ul></dd> </li></ul></dd>
@ -744,7 +744,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line57">line 57</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line57">line 57</a>
</li></ul></dd> </li></ul></dd>
@ -802,7 +802,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a> <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
</li></ul></dd> </li></ul></dd>
@ -825,7 +825,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line62">line 62</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
</li></ul></dd> </li></ul></dd>
@ -891,7 +891,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a> <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
</li></ul></dd> </li></ul></dd>
@ -914,7 +914,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line18">line 18</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
</li></ul></dd> </li></ul></dd>
@ -980,7 +980,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a> <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
</li></ul></dd> </li></ul></dd>
@ -1003,7 +1003,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line30">line 30</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -1069,7 +1069,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a> <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
</li></ul></dd> </li></ul></dd>
@ -1092,7 +1092,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line23">line 23</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -1128,7 +1128,7 @@ and relation (representing named relationship between source and target note)</d
<h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -1176,7 +1176,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line129">line 129</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line129">line 129</a>
</li></ul></dd> </li></ul></dd>
@ -1212,7 +1212,7 @@ and relation (representing named relationship between source and target note)</d
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -1263,7 +1263,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a> <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
</li></ul></dd> </li></ul></dd>
@ -1286,7 +1286,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line74">line 74</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
</li></ul></dd> </li></ul></dd>
@ -1322,7 +1322,7 @@ and relation (representing named relationship between source and target note)</d
<h4 class="name" id="getTargetNote"><span class="type-signature"></span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getTargetNote"><span class="type-signature"></span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -1370,7 +1370,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line142">line 142</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line142">line 142</a>
</li></ul></dd> </li></ul></dd>
@ -1406,7 +1406,7 @@ and relation (representing named relationship between source and target note)</d
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -1457,7 +1457,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a> <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
</li></ul></dd> </li></ul></dd>
@ -1480,7 +1480,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line45">line 45</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -1564,7 +1564,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line157">line 157</a> <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line157">line 157</a>
</li></ul></dd> </li></ul></dd>
@ -1718,7 +1718,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a> <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
</li></ul></dd> </li></ul></dd>
@ -1741,7 +1741,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line128">line 128</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
</li></ul></dd> </li></ul></dd>
@ -1811,7 +1811,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#save">AbstractEntity#save</a> <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
</li></ul></dd> </li></ul></dd>
@ -1834,7 +1834,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line83">line 83</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -1898,7 +1898,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

72
docs/backend_api/Branch.html → docs/backend_api/BBranch.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: Branch</title> <title>JSDoc: Class: BBranch</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: Branch</h1> <h1 class="page-title">Class: BBranch</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>Branch<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>BBranch<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
parents. parents.
@ -49,7 +49,7 @@ Always check noteId instead.</div>
<h4 class="name" id="Branch"><span class="type-signature"></span>new Branch<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="BBranch"><span class="type-signature"></span>new BBranch<span class="signature">()</span><span class="type-signature"></span></h4>
@ -97,7 +97,7 @@ Always check noteId instead.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line20">line 20</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line20">line 20</a>
</li></ul></dd> </li></ul></dd>
@ -137,7 +137,7 @@ Always check noteId instead.</div>
<ul> <ul>
<li><a href="AbstractEntity.html">AbstractEntity</a></li> <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
</ul> </ul>
@ -180,7 +180,7 @@ Always check noteId instead.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#becca">AbstractEntity#becca</a> <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
</li></ul></dd> </li></ul></dd>
@ -203,7 +203,7 @@ Always check noteId instead.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line53">line 53</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -271,7 +271,7 @@ Always check noteId instead.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line51">line 51</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line51">line 51</a>
</li></ul></dd> </li></ul></dd>
@ -329,7 +329,7 @@ Always check noteId instead.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line97">line 97</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line97">line 97</a>
</li></ul></dd> </li></ul></dd>
@ -397,7 +397,7 @@ Always check noteId instead.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line61">line 61</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line61">line 61</a>
</li></ul></dd> </li></ul></dd>
@ -463,7 +463,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line133">line 133</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line133">line 133</a>
</li></ul></dd> </li></ul></dd>
@ -531,7 +531,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line53">line 53</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -599,7 +599,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line59">line 59</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line59">line 59</a>
</li></ul></dd> </li></ul></dd>
@ -657,7 +657,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line111">line 111</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line111">line 111</a>
</li></ul></dd> </li></ul></dd>
@ -725,7 +725,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line55">line 55</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line55">line 55</a>
</li></ul></dd> </li></ul></dd>
@ -793,7 +793,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line57">line 57</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line57">line 57</a>
</li></ul></dd> </li></ul></dd>
@ -861,7 +861,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line63">line 63</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line63">line 63</a>
</li></ul></dd> </li></ul></dd>
@ -919,7 +919,7 @@ of deletion should not act as a clone.
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a> <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
</li></ul></dd> </li></ul></dd>
@ -942,7 +942,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line62">line 62</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
</li></ul></dd> </li></ul></dd>
@ -1008,7 +1008,7 @@ of deletion should not act as a clone.
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a> <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
</li></ul></dd> </li></ul></dd>
@ -1031,7 +1031,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line18">line 18</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
</li></ul></dd> </li></ul></dd>
@ -1213,7 +1213,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line145">line 145</a> <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line145">line 145</a>
</li></ul></dd> </li></ul></dd>
@ -1301,7 +1301,7 @@ of deletion should not act as a clone.
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a> <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
</li></ul></dd> </li></ul></dd>
@ -1324,7 +1324,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line30">line 30</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -1390,7 +1390,7 @@ of deletion should not act as a clone.
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a> <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
</li></ul></dd> </li></ul></dd>
@ -1413,7 +1413,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line23">line 23</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -1479,7 +1479,7 @@ of deletion should not act as a clone.
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a> <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
</li></ul></dd> </li></ul></dd>
@ -1502,7 +1502,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line74">line 74</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
</li></ul></dd> </li></ul></dd>
@ -1568,7 +1568,7 @@ of deletion should not act as a clone.
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a> <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
</li></ul></dd> </li></ul></dd>
@ -1591,7 +1591,7 @@ of deletion should not act as a clone.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line45">line 45</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -1727,7 +1727,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a> <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
</li></ul></dd> </li></ul></dd>
@ -1750,7 +1750,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line128">line 128</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
</li></ul></dd> </li></ul></dd>
@ -1820,7 +1820,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#save">AbstractEntity#save</a> <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
</li></ul></dd> </li></ul></dd>
@ -1843,7 +1843,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line83">line 83</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -1907,7 +1907,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

62
docs/backend_api/EtapiToken.html → docs/backend_api/BEtapiToken.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: EtapiToken</title> <title>JSDoc: Class: BEtapiToken</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: EtapiToken</h1> <h1 class="page-title">Class: BEtapiToken</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>EtapiToken<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>BEtapiToken<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications. <div class="class-description">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
Used by: Used by:
@ -51,7 +51,7 @@ from tokenHash and token.</div>
<h4 class="name" id="EtapiToken"><span class="type-signature"></span>new EtapiToken<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="BEtapiToken"><span class="type-signature"></span>new BEtapiToken<span class="signature">()</span><span class="type-signature"></span></h4>
@ -99,7 +99,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line17">line 17</a> <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line17">line 17</a>
</li></ul></dd> </li></ul></dd>
@ -139,7 +139,7 @@ from tokenHash and token.</div>
<ul> <ul>
<li><a href="AbstractEntity.html">AbstractEntity</a></li> <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
</ul> </ul>
@ -182,7 +182,7 @@ from tokenHash and token.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#becca">AbstractEntity#becca</a> <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
</li></ul></dd> </li></ul></dd>
@ -205,7 +205,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line53">line 53</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -273,7 +273,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line35">line 35</a> <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line35">line 35</a>
</li></ul></dd> </li></ul></dd>
@ -341,7 +341,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line45">line 45</a> <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -409,7 +409,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line37">line 37</a> <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line37">line 37</a>
</li></ul></dd> </li></ul></dd>
@ -477,7 +477,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line39">line 39</a> <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line39">line 39</a>
</li></ul></dd> </li></ul></dd>
@ -545,7 +545,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line41">line 41</a> <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line41">line 41</a>
</li></ul></dd> </li></ul></dd>
@ -613,7 +613,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line43">line 43</a> <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line43">line 43</a>
</li></ul></dd> </li></ul></dd>
@ -671,7 +671,7 @@ from tokenHash and token.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a> <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
</li></ul></dd> </li></ul></dd>
@ -694,7 +694,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line62">line 62</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
</li></ul></dd> </li></ul></dd>
@ -760,7 +760,7 @@ from tokenHash and token.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a> <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
</li></ul></dd> </li></ul></dd>
@ -783,7 +783,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line18">line 18</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
</li></ul></dd> </li></ul></dd>
@ -849,7 +849,7 @@ from tokenHash and token.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a> <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
</li></ul></dd> </li></ul></dd>
@ -872,7 +872,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line30">line 30</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -938,7 +938,7 @@ from tokenHash and token.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a> <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
</li></ul></dd> </li></ul></dd>
@ -961,7 +961,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line23">line 23</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -1027,7 +1027,7 @@ from tokenHash and token.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a> <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
</li></ul></dd> </li></ul></dd>
@ -1050,7 +1050,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line74">line 74</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
</li></ul></dd> </li></ul></dd>
@ -1116,7 +1116,7 @@ from tokenHash and token.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a> <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
</li></ul></dd> </li></ul></dd>
@ -1139,7 +1139,7 @@ from tokenHash and token.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line45">line 45</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -1275,7 +1275,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a> <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
</li></ul></dd> </li></ul></dd>
@ -1298,7 +1298,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line128">line 128</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
</li></ul></dd> </li></ul></dd>
@ -1368,7 +1368,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#save">AbstractEntity#save</a> <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
</li></ul></dd> </li></ul></dd>
@ -1391,7 +1391,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line83">line 83</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -1455,7 +1455,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

314
docs/backend_api/Note.html → docs/backend_api/BNote.html
View File

File diff suppressed because it is too large Load Diff

80
docs/backend_api/NoteRevision.html → docs/backend_api/BNoteRevision.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: NoteRevision</title> <title>JSDoc: Class: BNoteRevision</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: NoteRevision</h1> <h1 class="page-title">Class: BNoteRevision</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>NoteRevision<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>BNoteRevision<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">NoteRevision represents snapshot of note's title and content at some point in the past. <div class="class-description">NoteRevision represents snapshot of note's title and content at some point in the past.
It's used for seamless note versioning.</div> It's used for seamless note versioning.</div>
@ -46,7 +46,7 @@ It's used for seamless note versioning.</div>
<h4 class="name" id="NoteRevision"><span class="type-signature"></span>new NoteRevision<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="BNoteRevision"><span class="type-signature"></span>new BNoteRevision<span class="signature">()</span><span class="type-signature"></span></h4>
@ -94,7 +94,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line17">line 17</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line17">line 17</a>
</li></ul></dd> </li></ul></dd>
@ -134,7 +134,7 @@ It's used for seamless note versioning.</div>
<ul> <ul>
<li><a href="AbstractEntity.html">AbstractEntity</a></li> <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
</ul> </ul>
@ -177,7 +177,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#becca">AbstractEntity#becca</a> <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
</li></ul></dd> </li></ul></dd>
@ -200,7 +200,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line53">line 53</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -268,7 +268,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line48">line 48</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line48">line 48</a>
</li></ul></dd> </li></ul></dd>
@ -336,7 +336,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line40">line 40</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line40">line 40</a>
</li></ul></dd> </li></ul></dd>
@ -404,7 +404,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line38">line 38</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line38">line 38</a>
</li></ul></dd> </li></ul></dd>
@ -472,7 +472,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line34">line 34</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line34">line 34</a>
</li></ul></dd> </li></ul></dd>
@ -540,7 +540,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line32">line 32</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line32">line 32</a>
</li></ul></dd> </li></ul></dd>
@ -608,7 +608,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line28">line 28</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line28">line 28</a>
</li></ul></dd> </li></ul></dd>
@ -676,7 +676,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line26">line 26</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line26">line 26</a>
</li></ul></dd> </li></ul></dd>
@ -744,7 +744,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line36">line 36</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line36">line 36</a>
</li></ul></dd> </li></ul></dd>
@ -812,7 +812,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line30">line 30</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -880,7 +880,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line44">line 44</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line44">line 44</a>
</li></ul></dd> </li></ul></dd>
@ -948,7 +948,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line42">line 42</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line42">line 42</a>
</li></ul></dd> </li></ul></dd>
@ -1016,7 +1016,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line46">line 46</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line46">line 46</a>
</li></ul></dd> </li></ul></dd>
@ -1074,7 +1074,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a> <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
</li></ul></dd> </li></ul></dd>
@ -1097,7 +1097,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line62">line 62</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
</li></ul></dd> </li></ul></dd>
@ -1163,7 +1163,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a> <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
</li></ul></dd> </li></ul></dd>
@ -1186,7 +1186,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line18">line 18</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
</li></ul></dd> </li></ul></dd>
@ -1252,7 +1252,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a> <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
</li></ul></dd> </li></ul></dd>
@ -1275,7 +1275,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line30">line 30</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -1341,7 +1341,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a> <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
</li></ul></dd> </li></ul></dd>
@ -1364,7 +1364,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line23">line 23</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -1448,7 +1448,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line76">line 76</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line76">line 76</a>
</li></ul></dd> </li></ul></dd>
@ -1550,7 +1550,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line140">line 140</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line140">line 140</a>
</li></ul></dd> </li></ul></dd>
@ -1634,7 +1634,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a> <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
</li></ul></dd> </li></ul></dd>
@ -1657,7 +1657,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line74">line 74</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
</li></ul></dd> </li></ul></dd>
@ -1723,7 +1723,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a> <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
</li></ul></dd> </li></ul></dd>
@ -1746,7 +1746,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line45">line 45</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -1830,7 +1830,7 @@ It's used for seamless note versioning.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line62">line 62</a> <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line62">line 62</a>
</li></ul></dd> </li></ul></dd>
@ -1988,7 +1988,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a> <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
</li></ul></dd> </li></ul></dd>
@ -2011,7 +2011,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line128">line 128</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
</li></ul></dd> </li></ul></dd>
@ -2081,7 +2081,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#save">AbstractEntity#save</a> <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
</li></ul></dd> </li></ul></dd>
@ -2104,7 +2104,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line83">line 83</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -2168,7 +2168,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

58
docs/backend_api/Option.html → docs/backend_api/BOption.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: Option</title> <title>JSDoc: Class: BOption</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: Option</h1> <h1 class="page-title">Class: BOption</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>Option<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>BOption<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Option represents name-value pair, either directly configurable by the user or some system property.</div> <div class="class-description">Option represents name-value pair, either directly configurable by the user or some system property.</div>
@ -45,7 +45,7 @@
<h4 class="name" id="Option"><span class="type-signature"></span>new Option<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="BOption"><span class="type-signature"></span>new BOption<span class="signature">()</span><span class="type-signature"></span></h4>
@ -93,7 +93,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line11">line 11</a> <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line11">line 11</a>
</li></ul></dd> </li></ul></dd>
@ -133,7 +133,7 @@
<ul> <ul>
<li><a href="AbstractEntity.html">AbstractEntity</a></li> <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
</ul> </ul>
@ -176,7 +176,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#becca">AbstractEntity#becca</a> <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
</li></ul></dd> </li></ul></dd>
@ -199,7 +199,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line53">line 53</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -267,7 +267,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line24">line 24</a> <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line24">line 24</a>
</li></ul></dd> </li></ul></dd>
@ -335,7 +335,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line20">line 20</a> <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line20">line 20</a>
</li></ul></dd> </li></ul></dd>
@ -403,7 +403,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line26">line 26</a> <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line26">line 26</a>
</li></ul></dd> </li></ul></dd>
@ -471,7 +471,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line22">line 22</a> <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line22">line 22</a>
</li></ul></dd> </li></ul></dd>
@ -529,7 +529,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a> <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
</li></ul></dd> </li></ul></dd>
@ -552,7 +552,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line62">line 62</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
</li></ul></dd> </li></ul></dd>
@ -618,7 +618,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a> <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
</li></ul></dd> </li></ul></dd>
@ -641,7 +641,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line18">line 18</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
</li></ul></dd> </li></ul></dd>
@ -707,7 +707,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a> <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
</li></ul></dd> </li></ul></dd>
@ -730,7 +730,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line30">line 30</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -796,7 +796,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a> <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
</li></ul></dd> </li></ul></dd>
@ -819,7 +819,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line23">line 23</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -885,7 +885,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a> <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
</li></ul></dd> </li></ul></dd>
@ -908,7 +908,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line74">line 74</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
</li></ul></dd> </li></ul></dd>
@ -974,7 +974,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a> <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
</li></ul></dd> </li></ul></dd>
@ -997,7 +997,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line45">line 45</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -1133,7 +1133,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a> <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
</li></ul></dd> </li></ul></dd>
@ -1156,7 +1156,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line128">line 128</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
</li></ul></dd> </li></ul></dd>
@ -1226,7 +1226,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#save">AbstractEntity#save</a> <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
</li></ul></dd> </li></ul></dd>
@ -1249,7 +1249,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line83">line 83</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -1313,7 +1313,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

56
docs/backend_api/RecentNote.html → docs/backend_api/BRecentNote.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: RecentNote</title> <title>JSDoc: Class: BRecentNote</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: RecentNote</h1> <h1 class="page-title">Class: BRecentNote</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>RecentNote<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>BRecentNote<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">RecentNote represents recently visited note.</div> <div class="class-description">RecentNote represents recently visited note.</div>
@ -45,7 +45,7 @@
<h4 class="name" id="RecentNote"><span class="type-signature"></span>new RecentNote<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="BRecentNote"><span class="type-signature"></span>new BRecentNote<span class="signature">()</span><span class="type-signature"></span></h4>
@ -93,7 +93,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line11">line 11</a> <a href="becca_entities_brecent_note.js.html">becca/entities/brecent_note.js</a>, <a href="becca_entities_brecent_note.js.html#line11">line 11</a>
</li></ul></dd> </li></ul></dd>
@ -133,7 +133,7 @@
<ul> <ul>
<li><a href="AbstractEntity.html">AbstractEntity</a></li> <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
</ul> </ul>
@ -176,7 +176,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#becca">AbstractEntity#becca</a> <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
</li></ul></dd> </li></ul></dd>
@ -199,7 +199,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line53">line 53</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
</li></ul></dd> </li></ul></dd>
@ -267,7 +267,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line19">line 19</a> <a href="becca_entities_brecent_note.js.html">becca/entities/brecent_note.js</a>, <a href="becca_entities_brecent_note.js.html#line19">line 19</a>
</li></ul></dd> </li></ul></dd>
@ -335,7 +335,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line21">line 21</a> <a href="becca_entities_brecent_note.js.html">becca/entities/brecent_note.js</a>, <a href="becca_entities_brecent_note.js.html#line21">line 21</a>
</li></ul></dd> </li></ul></dd>
@ -403,7 +403,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line23">line 23</a> <a href="becca_entities_brecent_note.js.html">becca/entities/brecent_note.js</a>, <a href="becca_entities_brecent_note.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -461,7 +461,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a> <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
</li></ul></dd> </li></ul></dd>
@ -484,7 +484,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line62">line 62</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
</li></ul></dd> </li></ul></dd>
@ -550,7 +550,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a> <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
</li></ul></dd> </li></ul></dd>
@ -573,7 +573,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line18">line 18</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
</li></ul></dd> </li></ul></dd>
@ -639,7 +639,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a> <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
</li></ul></dd> </li></ul></dd>
@ -662,7 +662,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line30">line 30</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
</li></ul></dd> </li></ul></dd>
@ -728,7 +728,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a> <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
</li></ul></dd> </li></ul></dd>
@ -751,7 +751,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line23">line 23</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -817,7 +817,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a> <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
</li></ul></dd> </li></ul></dd>
@ -840,7 +840,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line74">line 74</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
</li></ul></dd> </li></ul></dd>
@ -906,7 +906,7 @@
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a> <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
</li></ul></dd> </li></ul></dd>
@ -929,7 +929,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line45">line 45</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
</li></ul></dd> </li></ul></dd>
@ -1065,7 +1065,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a> <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
</li></ul></dd> </li></ul></dd>
@ -1088,7 +1088,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line128">line 128</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
</li></ul></dd> </li></ul></dd>
@ -1158,7 +1158,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-overrides">Overrides:</dt> <dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li> <dd class="tag-overrides"><ul class="dummy"><li>
<a href="AbstractEntity.html#save">AbstractEntity#save</a> <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
</li></ul></dd> </li></ul></dd>
@ -1181,7 +1181,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line83">line 83</a> <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
</li></ul></dd> </li></ul></dd>
@ -1245,7 +1245,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

98
docs/backend_api/BackendScriptApi.html
View File

@ -185,7 +185,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line579">line 579</a> <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line580">line 580</a>
</li></ul></dd> </li></ul></dd>
@ -356,7 +356,7 @@
<td class="type"> <td class="type">
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
@ -796,7 +796,7 @@
<td class="type"> <td class="type">
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
@ -2518,7 +2518,7 @@ JSON MIME type. See also createNewNote() for more options.
<h4 class="name" id="exportSubtreeToZipFile"><span class="type-signature"></span>exportSubtreeToZipFile<span class="signature">(noteId, format, zipFilePath)</span><span class="type-signature"></span></h4> <h4 class="name" id="exportSubtreeToZipFile"><span class="type-signature"></span>exportSubtreeToZipFile<span class="signature">(noteId, format, zipFilePath)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
@ -2661,7 +2661,7 @@ JSON MIME type. See also createNewNote() for more options.
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line572">line 572</a> <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line573">line 573</a>
</li></ul></dd> </li></ul></dd>
@ -2686,6 +2686,24 @@ JSON MIME type. See also createNewNote() for more options.
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
@ -2806,7 +2824,7 @@ JSON MIME type. See also createNewNote() for more options.
<h4 class="name" id="getAttribute"><span class="type-signature"></span>getAttribute<span class="signature">(attributeId)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>|null}</span></h4> <h4 class="name" id="getAttribute"><span class="type-signature"></span>getAttribute<span class="signature">(attributeId)</span><span class="type-signature"> &rarr; {Attribute|null}</span></h4>
@ -2939,7 +2957,7 @@ JSON MIME type. See also createNewNote() for more options.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Attribute.html">Attribute</a></span> <span class="param-type">Attribute</span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -2960,7 +2978,7 @@ JSON MIME type. See also createNewNote() for more options.
<h4 class="name" id="getBranch"><span class="type-signature"></span>getBranch<span class="signature">(branchId)</span><span class="type-signature"> &rarr; {<a href="Branch.html">Branch</a>|null}</span></h4> <h4 class="name" id="getBranch"><span class="type-signature"></span>getBranch<span class="signature">(branchId)</span><span class="type-signature"> &rarr; {Branch|null}</span></h4>
@ -3093,7 +3111,7 @@ JSON MIME type. See also createNewNote() for more options.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Branch.html">Branch</a></span> <span class="param-type">Branch</span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -3114,7 +3132,7 @@ JSON MIME type. See also createNewNote() for more options.
<h4 class="name" id="getDateNote"><span class="type-signature"></span>getDateNote<span class="signature">(date, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getDateNote"><span class="type-signature"></span>getDateNote<span class="signature">(date, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -3197,7 +3215,7 @@ JSON MIME type. See also createNewNote() for more options.
<td class="type"> <td class="type">
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
@ -3296,7 +3314,7 @@ JSON MIME type. See also createNewNote() for more options.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -3317,7 +3335,7 @@ JSON MIME type. See also createNewNote() for more options.
<h4 class="name" id="getDayNote"><span class="type-signature"></span>getDayNote<span class="signature">(date, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getDayNote"><span class="type-signature"></span>getDayNote<span class="signature">(date, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -3400,7 +3418,7 @@ JSON MIME type. See also createNewNote() for more options.
<td class="type"> <td class="type">
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
@ -3497,7 +3515,7 @@ JSON MIME type. See also createNewNote() for more options.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -3628,7 +3646,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getMonthNote"><span class="type-signature"></span>getMonthNote<span class="signature">(date, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getMonthNote"><span class="type-signature"></span>getMonthNote<span class="signature">(date, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -3711,7 +3729,7 @@ if some action needs to happen on only one specific instance.
<td class="type"> <td class="type">
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
@ -3808,7 +3826,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -3829,7 +3847,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">(noteId)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">(noteId)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -3962,7 +3980,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -3983,7 +4001,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getNoteWithLabel"><span class="type-signature"></span>getNoteWithLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getNoteWithLabel"><span class="type-signature"></span>getNoteWithLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -4163,7 +4181,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -4184,7 +4202,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getNotesWithLabel"><span class="type-signature"></span>getNotesWithLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Note.html">Note</a>>}</span></h4> <h4 class="name" id="getNotesWithLabel"><span class="type-signature"></span>getNotesWithLabel<span class="signature">(name, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BNote.html">BNote</a>>}</span></h4>
@ -4364,7 +4382,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Note.html">Note</a>></span> <span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
</dd> </dd>
@ -4382,7 +4400,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getRootCalendarNote"><span class="type-signature"></span>getRootCalendarNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getRootCalendarNote"><span class="type-signature"></span>getRootCalendarNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -4470,7 +4488,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -4491,7 +4509,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getTodayNote"><span class="type-signature"></span>getTodayNote<span class="signature">(rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getTodayNote"><span class="type-signature"></span>getTodayNote<span class="signature">(rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -4543,7 +4561,7 @@ if some action needs to happen on only one specific instance.
<td class="type"> <td class="type">
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
@ -4640,7 +4658,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -4661,7 +4679,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getWeekNote"><span class="type-signature"></span>getWeekNote<span class="signature">(date, options<span class="signature-attributes">opt</span>, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getWeekNote"><span class="type-signature"></span>getWeekNote<span class="signature">(date, options<span class="signature-attributes">opt</span>, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -4777,7 +4795,7 @@ if some action needs to happen on only one specific instance.
<td class="type"> <td class="type">
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
@ -4874,7 +4892,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -4895,7 +4913,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getYearNote"><span class="type-signature"></span>getYearNote<span class="signature">(year, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="getYearNote"><span class="type-signature"></span>getYearNote<span class="signature">(year, rootNote<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -4978,7 +4996,7 @@ if some action needs to happen on only one specific instance.
<td class="type"> <td class="type">
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
@ -5075,7 +5093,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -5473,7 +5491,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="searchForNote"><span class="type-signature"></span>searchForNote<span class="signature">(query, searchParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4> <h4 class="name" id="searchForNote"><span class="type-signature"></span>searchForNote<span class="signature">(query, searchParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
@ -5654,7 +5672,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Note.html">Note</a></span> <span class="param-type"><a href="BNote.html">BNote</a></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -5675,7 +5693,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="searchForNotes"><span class="type-signature"></span>searchForNotes<span class="signature">(query, searchParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Note.html">Note</a>>}</span></h4> <h4 class="name" id="searchForNotes"><span class="type-signature"></span>searchForNotes<span class="signature">(query, searchParams<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BNote.html">BNote</a>>}</span></h4>
@ -5856,7 +5874,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Note.html">Note</a>></span> <span class="param-type">Array.&lt;<a href="BNote.html">BNote</a>></span>
</dd> </dd>
@ -6929,7 +6947,7 @@ exists, then we'll use that transaction.
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

10
docs/backend_api/becca_entities_abstract_entity.js.html → docs/backend_api/becca_entities_abstract_becca_entity.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: becca/entities/abstract_entity.js</title> <title>JSDoc: Source: becca/entities/abstract_becca_entity.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: becca/entities/abstract_entity.js</h1> <h1 class="page-title">Source: becca/entities/abstract_becca_entity.js</h1>
@ -41,7 +41,7 @@ let becca = null;
/** /**
* Base class for all backend entities. * Base class for all backend entities.
*/ */
class AbstractEntity { class AbstractBeccaEntity {
/** @protected */ /** @protected */
beforeSaving() { beforeSaving() {
this.generateIdIfNecessary(); this.generateIdIfNecessary();
@ -195,7 +195,7 @@ class AbstractEntity {
} }
} }
module.exports = AbstractEntity; module.exports = AbstractBeccaEntity;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -206,7 +206,7 @@ module.exports = AbstractEntity;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

24
docs/backend_api/becca_entities_attribute.js.html → docs/backend_api/becca_entities_battribute.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: becca/entities/attribute.js</title> <title>JSDoc: Source: becca/entities/battribute.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: becca/entities/attribute.js</h1> <h1 class="page-title">Source: becca/entities/battribute.js</h1>
@ -28,8 +28,8 @@
<article> <article>
<pre class="prettyprint source linenums"><code>"use strict"; <pre class="prettyprint source linenums"><code>"use strict";
const Note = require('./note'); const BNote = require('./bnote');
const AbstractEntity = require("./abstract_entity"); const AbstractBeccaEntity = require("./abstract_becca_entity");
const sql = require("../../services/sql"); const sql = require("../../services/sql");
const dateUtils = require("../../services/date_utils"); const dateUtils = require("../../services/date_utils");
const promotedAttributeDefinitionParser = require("../../services/promoted_attribute_definition_parser"); const promotedAttributeDefinitionParser = require("../../services/promoted_attribute_definition_parser");
@ -39,9 +39,9 @@ const {sanitizeAttributeName} = require("../../services/sanitize_attribute_name"
* Attribute is an abstract concept which has two real uses - label (key - value pair) * Attribute is an abstract concept which has two real uses - label (key - value pair)
* and relation (representing named relationship between source and target note) * and relation (representing named relationship between source and target note)
* *
* @extends AbstractEntity * @extends AbstractBeccaEntity
*/ */
class Attribute extends AbstractEntity { class BAttribute extends AbstractBeccaEntity {
static get entityName() { return "attributes"; } static get entityName() { return "attributes"; }
static get primaryKeyName() { return "attributeId"; } static get primaryKeyName() { return "attributeId"; }
static get hashedProperties() { return ["attributeId", "noteId", "type", "name", "value", "isInheritable"]; } static get hashedProperties() { return ["attributeId", "noteId", "type", "name", "value", "isInheritable"]; }
@ -98,7 +98,7 @@ class Attribute extends AbstractEntity {
if (!(this.noteId in this.becca.notes)) { if (!(this.noteId in this.becca.notes)) {
// entities can come out of order in sync, create skeleton which will be filled later // entities can come out of order in sync, create skeleton which will be filled later
this.becca.addNote(this.noteId, new Note({noteId: this.noteId})); this.becca.addNote(this.noteId, new BNote({noteId: this.noteId}));
} }
this.becca.notes[this.noteId].ownedAttributes.push(this); this.becca.notes[this.noteId].ownedAttributes.push(this);
@ -152,7 +152,7 @@ class Attribute extends AbstractEntity {
} }
/** /**
* @returns {Note|null} * @returns {BNote|null}
*/ */
getNote() { getNote() {
const note = this.becca.getNote(this.noteId); const note = this.becca.getNote(this.noteId);
@ -165,7 +165,7 @@ class Attribute extends AbstractEntity {
} }
/** /**
* @returns {Note|null} * @returns {BNote|null}
*/ */
getTargetNote() { getTargetNote() {
if (this.type !== 'relation') { if (this.type !== 'relation') {
@ -245,7 +245,7 @@ class Attribute extends AbstractEntity {
} }
createClone(type, name, value, isInheritable) { createClone(type, name, value, isInheritable) {
return new Attribute({ return new BAttribute({
noteId: this.noteId, noteId: this.noteId,
type: type, type: type,
name: name, name: name,
@ -257,7 +257,7 @@ class Attribute extends AbstractEntity {
} }
} }
module.exports = Attribute; module.exports = BAttribute;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -268,7 +268,7 @@ module.exports = Attribute;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

26
docs/backend_api/becca_entities_branch.js.html → docs/backend_api/becca_entities_bbranch.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: becca/entities/branch.js</title> <title>JSDoc: Source: becca/entities/bbranch.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: becca/entities/branch.js</h1> <h1 class="page-title">Source: becca/entities/bbranch.js</h1>
@ -28,8 +28,8 @@
<article> <article>
<pre class="prettyprint source linenums"><code>"use strict"; <pre class="prettyprint source linenums"><code>"use strict";
const Note = require('./note'); const BNote = require('./bnote');
const AbstractEntity = require("./abstract_entity"); const AbstractBeccaEntity = require("./abstract_becca_entity");
const dateUtils = require("../../services/date_utils"); const dateUtils = require("../../services/date_utils");
const utils = require("../../services/utils"); const utils = require("../../services/utils");
const TaskContext = require("../../services/task_context"); const TaskContext = require("../../services/task_context");
@ -43,9 +43,9 @@ const log = require("../../services/log");
* Note that you should not rely on the branch's identity, since it can change easily with a note's move. * Note that you should not rely on the branch's identity, since it can change easily with a note's move.
* Always check noteId instead. * Always check noteId instead.
* *
* @extends AbstractEntity * @extends AbstractBeccaEntity
*/ */
class Branch extends AbstractEntity { class BBranch extends AbstractBeccaEntity {
static get entityName() { return "branches"; } static get entityName() { return "branches"; }
static get primaryKeyName() { return "branchId"; } static get primaryKeyName() { return "branchId"; }
// notePosition is not part of hash because it would produce a lot of updates in case of reordering // notePosition is not part of hash because it would produce a lot of updates in case of reordering
@ -121,11 +121,11 @@ class Branch extends AbstractEntity {
} }
} }
/** @returns {Note} */ /** @returns {BNote} */
get childNote() { get childNote() {
if (!(this.noteId in this.becca.notes)) { if (!(this.noteId in this.becca.notes)) {
// entities can come out of order in sync/import, create skeleton which will be filled later // entities can come out of order in sync/import, create skeleton which will be filled later
this.becca.addNote(this.noteId, new Note({noteId: this.noteId})); this.becca.addNote(this.noteId, new BNote({noteId: this.noteId}));
} }
return this.becca.notes[this.noteId]; return this.becca.notes[this.noteId];
@ -135,11 +135,11 @@ class Branch extends AbstractEntity {
return this.childNote; return this.childNote;
} }
/** @returns {Note|undefined} - root branch will have undefined parent, all other branches have to have a parent note */ /** @returns {BNote|undefined} - root branch will have undefined parent, all other branches have to have a parent note */
get parentNote() { get parentNote() {
if (!(this.parentNoteId in this.becca.notes) &amp;&amp; this.parentNoteId !== 'none') { if (!(this.parentNoteId in this.becca.notes) &amp;&amp; this.parentNoteId !== 'none') {
// entities can come out of order in sync/import, create skeleton which will be filled later // entities can come out of order in sync/import, create skeleton which will be filled later
this.becca.addNote(this.parentNoteId, new Note({noteId: this.parentNoteId})); this.becca.addNote(this.parentNoteId, new BNote({noteId: this.parentNoteId}));
} }
return this.becca.notes[this.parentNoteId]; return this.becca.notes[this.parentNoteId];
@ -291,7 +291,7 @@ class Branch extends AbstractEntity {
existingBranch.notePosition = notePosition; existingBranch.notePosition = notePosition;
return existingBranch; return existingBranch;
} else { } else {
return new Branch({ return new BBranch({
noteId: this.noteId, noteId: this.noteId,
parentNoteId: parentNoteId, parentNoteId: parentNoteId,
notePosition: notePosition, notePosition: notePosition,
@ -302,7 +302,7 @@ class Branch extends AbstractEntity {
} }
} }
module.exports = Branch; module.exports = BBranch;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -313,7 +313,7 @@ module.exports = Branch;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

14
docs/backend_api/becca_entities_etapi_token.js.html → docs/backend_api/becca_entities_betapi_token.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: becca/entities/etapi_token.js</title> <title>JSDoc: Source: becca/entities/betapi_token.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: becca/entities/etapi_token.js</h1> <h1 class="page-title">Source: becca/entities/betapi_token.js</h1>
@ -29,7 +29,7 @@
<pre class="prettyprint source linenums"><code>"use strict"; <pre class="prettyprint source linenums"><code>"use strict";
const dateUtils = require('../../services/date_utils'); const dateUtils = require('../../services/date_utils');
const AbstractEntity = require("./abstract_entity"); const AbstractBeccaEntity = require("./abstract_becca_entity");
/** /**
* EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications. * EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
@ -40,9 +40,9 @@ const AbstractEntity = require("./abstract_entity");
* The format user is presented with is "&lt;etapiTokenId>_&lt;tokenHash>". This is also called "authToken" to distinguish it * The format user is presented with is "&lt;etapiTokenId>_&lt;tokenHash>". This is also called "authToken" to distinguish it
* from tokenHash and token. * from tokenHash and token.
* *
* @extends AbstractEntity * @extends AbstractBeccaEntity
*/ */
class EtapiToken extends AbstractEntity { class BEtapiToken extends AbstractBeccaEntity {
static get entityName() { return "etapi_tokens"; } static get entityName() { return "etapi_tokens"; }
static get primaryKeyName() { return "etapiTokenId"; } static get primaryKeyName() { return "etapiTokenId"; }
static get hashedProperties() { return ["etapiTokenId", "name", "tokenHash", "utcDateCreated", "utcDateModified", "isDeleted"]; } static get hashedProperties() { return ["etapiTokenId", "name", "tokenHash", "utcDateCreated", "utcDateModified", "isDeleted"]; }
@ -103,7 +103,7 @@ class EtapiToken extends AbstractEntity {
} }
} }
module.exports = EtapiToken; module.exports = BEtapiToken;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -114,7 +114,7 @@ module.exports = EtapiToken;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

48
docs/backend_api/becca_entities_note.js.html → docs/backend_api/becca_entities_bnote.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: becca/entities/note.js</title> <title>JSDoc: Source: becca/entities/bnote.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: becca/entities/note.js</h1> <h1 class="page-title">Source: becca/entities/bnote.js</h1>
@ -34,8 +34,8 @@ const sql = require('../../services/sql');
const utils = require('../../services/utils'); const utils = require('../../services/utils');
const dateUtils = require('../../services/date_utils'); const dateUtils = require('../../services/date_utils');
const entityChangesService = require('../../services/entity_changes'); const entityChangesService = require('../../services/entity_changes');
const AbstractEntity = require("./abstract_entity"); const AbstractBeccaEntity = require("./abstract_becca_entity");
const NoteRevision = require("./note_revision"); const BNoteRevision = require("./bnote_revision");
const TaskContext = require("../../services/task_context"); const TaskContext = require("../../services/task_context");
const dayjs = require("dayjs"); const dayjs = require("dayjs");
const utc = require('dayjs/plugin/utc'); const utc = require('dayjs/plugin/utc');
@ -47,9 +47,9 @@ const RELATION = 'relation';
/** /**
* Trilium's main entity which can represent text note, image, code note, file attachment etc. * Trilium's main entity which can represent text note, image, code note, file attachment etc.
* *
* @extends AbstractEntity * @extends AbstractBeccaEntity
*/ */
class Note extends AbstractEntity { class BNote extends AbstractBeccaEntity {
static get entityName() { return "notes"; } static get entityName() { return "notes"; }
static get primaryKeyName() { return "noteId"; } static get primaryKeyName() { return "noteId"; }
static get hashedProperties() { return ["noteId", "title", "isProtected", "type", "mime"]; } static get hashedProperties() { return ["noteId", "title", "isProtected", "type", "mime"]; }
@ -120,10 +120,10 @@ class Note extends AbstractEntity {
/** @type {Branch[]} /** @type {Branch[]}
* @private */ * @private */
this.parentBranches = []; this.parentBranches = [];
/** @type {Note[]} /** @type {BNote[]}
* @private */ * @private */
this.parents = []; this.parents = [];
/** @type {Note[]} /** @type {BNote[]}
* @private*/ * @private*/
this.children = []; this.children = [];
/** @type {Attribute[]} /** @type {Attribute[]}
@ -143,7 +143,7 @@ class Note extends AbstractEntity {
this.becca.addNote(this.noteId, this); this.becca.addNote(this.noteId, this);
/** @type {Note[]|null} /** @type {BNote[]|null}
* @private */ * @private */
this.ancestorCache = null; this.ancestorCache = null;
@ -201,12 +201,12 @@ class Note extends AbstractEntity {
return this.parentBranches; return this.parentBranches;
} }
/** @returns {Note[]} */ /** @returns {BNote[]} */
getParentNotes() { getParentNotes() {
return this.parents; return this.parents;
} }
/** @returns {Note[]} */ /** @returns {BNote[]} */
getChildNotes() { getChildNotes() {
return this.children; return this.children;
} }
@ -860,7 +860,7 @@ class Note extends AbstractEntity {
return !!this.targetRelations.find(rel => rel.name === 'template'); return !!this.targetRelations.find(rel => rel.name === 'template');
} }
/** @returns {Note[]} */ /** @returns {BNote[]} */
getSubtreeNotesIncludingTemplated() { getSubtreeNotesIncludingTemplated() {
const set = new Set(); const set = new Set();
@ -891,7 +891,7 @@ class Note extends AbstractEntity {
return Array.from(set); return Array.from(set);
} }
/** @return {Note[]} */ /** @return {BNote[]} */
getSearchResultNotes() { getSearchResultNotes() {
if (this.type !== 'search') { if (this.type !== 'search') {
return []; return [];
@ -913,7 +913,7 @@ class Note extends AbstractEntity {
} }
/** /**
* @returns {{notes: Note[], relationships: Array.&lt;{parentNoteId: string, childNoteId: string}>}} * @returns {{notes: BNote[], relationships: Array.&lt;{parentNoteId: string, childNoteId: string}>}}
*/ */
getSubtree({includeArchived = true, includeHidden = false, resolveSearch = false} = {}) { getSubtree({includeArchived = true, includeHidden = false, resolveSearch = false} = {}) {
const noteSet = new Set(); const noteSet = new Set();
@ -1033,7 +1033,7 @@ class Note extends AbstractEntity {
return this.getAttributes().length; return this.getAttributes().length;
} }
/** @returns {Note[]} */ /** @returns {BNote[]} */
getAncestors() { getAncestors() {
if (!this.ancestorCache) { if (!this.ancestorCache) {
const noteIds = new Set(); const noteIds = new Set();
@ -1078,7 +1078,7 @@ class Note extends AbstractEntity {
return this.targetRelations; return this.targetRelations;
} }
/** @returns {Note[]} - returns only notes which are templated, does not include their subtrees /** @returns {BNote[]} - returns only notes which are templated, does not include their subtrees
* in effect returns notes which are influenced by note's non-inheritable attributes */ * in effect returns notes which are influenced by note's non-inheritable attributes */
getTemplatedNotes() { getTemplatedNotes() {
const arr = [this]; const arr = [this];
@ -1112,7 +1112,7 @@ class Note extends AbstractEntity {
getNoteRevisions() { getNoteRevisions() {
return sql.getRows("SELECT * FROM note_revisions WHERE noteId = ?", [this.noteId]) return sql.getRows("SELECT * FROM note_revisions WHERE noteId = ?", [this.noteId])
.map(row => new NoteRevision(row)); .map(row => new BNoteRevision(row));
} }
/** /**
@ -1165,9 +1165,9 @@ class Note extends AbstractEntity {
} }
} }
else { else {
const Attribute = require("./attribute"); const BAttribute = require("./battribute");
new Attribute({ new BAttribute({
noteId: this.noteId, noteId: this.noteId,
type: type, type: type,
name: name, name: name,
@ -1205,7 +1205,7 @@ class Note extends AbstractEntity {
* @return {Attribute} * @return {Attribute}
*/ */
addAttribute(type, name, value = "", isInheritable = false, position = 1000) { addAttribute(type, name, value = "", isInheritable = false, position = 1000) {
const Attribute = require("./attribute"); const BAttribute = require("./battribute");
return new Attribute({ return new Attribute({
noteId: this.noteId, noteId: this.noteId,
@ -1387,7 +1387,7 @@ class Note extends AbstractEntity {
} }
/** /**
* @return {NoteRevision|null} * @return {BNoteRevision|null}
*/ */
saveNoteRevision() { saveNoteRevision() {
const content = this.getContent(); const content = this.getContent();
@ -1398,7 +1398,7 @@ class Note extends AbstractEntity {
const contentMetadata = this.getContentMetadata(); const contentMetadata = this.getContentMetadata();
const noteRevision = new NoteRevision({ const noteRevision = new BNoteRevision({
noteId: this.noteId, noteId: this.noteId,
// title and text should be decrypted now // title and text should be decrypted now
title: this.title, title: this.title,
@ -1462,7 +1462,7 @@ class Note extends AbstractEntity {
} }
} }
module.exports = Note; module.exports = BNote;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -1473,7 +1473,7 @@ module.exports = Note;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

14
docs/backend_api/becca_entities_note_revision.js.html → docs/backend_api/becca_entities_bnote_revision.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: becca/entities/note_revision.js</title> <title>JSDoc: Source: becca/entities/bnote_revision.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: becca/entities/note_revision.js</h1> <h1 class="page-title">Source: becca/entities/bnote_revision.js</h1>
@ -34,15 +34,15 @@ const sql = require('../../services/sql');
const dateUtils = require('../../services/date_utils'); const dateUtils = require('../../services/date_utils');
const becca = require('../becca'); const becca = require('../becca');
const entityChangesService = require('../../services/entity_changes'); const entityChangesService = require('../../services/entity_changes');
const AbstractEntity = require("./abstract_entity"); const AbstractBeccaEntity = require("./abstract_becca_entity");
/** /**
* NoteRevision represents snapshot of note's title and content at some point in the past. * NoteRevision represents snapshot of note's title and content at some point in the past.
* It's used for seamless note versioning. * It's used for seamless note versioning.
* *
* @extends AbstractEntity * @extends AbstractBeccaEntity
*/ */
class NoteRevision extends AbstractEntity { class BNoteRevision extends AbstractBeccaEntity {
static get entityName() { return "note_revisions"; } static get entityName() { return "note_revisions"; }
static get primaryKeyName() { return "noteRevisionId"; } static get primaryKeyName() { return "noteRevisionId"; }
static get hashedProperties() { return ["noteRevisionId", "noteId", "title", "isProtected", "dateLastEdited", "dateCreated", "utcDateLastEdited", "utcDateCreated", "utcDateModified"]; } static get hashedProperties() { return ["noteRevisionId", "noteId", "title", "isProtected", "dateLastEdited", "dateCreated", "utcDateLastEdited", "utcDateCreated", "utcDateModified"]; }
@ -218,7 +218,7 @@ class NoteRevision extends AbstractEntity {
} }
} }
module.exports = NoteRevision; module.exports = BNoteRevision;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -229,7 +229,7 @@ module.exports = NoteRevision;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

14
docs/backend_api/becca_entities_option.js.html → docs/backend_api/becca_entities_boption.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: becca/entities/option.js</title> <title>JSDoc: Source: becca/entities/boption.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: becca/entities/option.js</h1> <h1 class="page-title">Source: becca/entities/boption.js</h1>
@ -29,14 +29,14 @@
<pre class="prettyprint source linenums"><code>"use strict"; <pre class="prettyprint source linenums"><code>"use strict";
const dateUtils = require('../../services/date_utils'); const dateUtils = require('../../services/date_utils');
const AbstractEntity = require("./abstract_entity"); const AbstractBeccaEntity = require("./abstract_becca_entity");
/** /**
* Option represents name-value pair, either directly configurable by the user or some system property. * Option represents name-value pair, either directly configurable by the user or some system property.
* *
* @extends AbstractEntity * @extends AbstractBeccaEntity
*/ */
class Option extends AbstractEntity { class BOption extends AbstractBeccaEntity {
static get entityName() { return "options"; } static get entityName() { return "options"; }
static get primaryKeyName() { return "name"; } static get primaryKeyName() { return "name"; }
static get hashedProperties() { return ["name", "value"]; } static get hashedProperties() { return ["name", "value"]; }
@ -72,7 +72,7 @@ class Option extends AbstractEntity {
} }
} }
module.exports = Option; module.exports = BOption;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -83,7 +83,7 @@ module.exports = Option;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

14
docs/backend_api/becca_entities_recent_note.js.html → docs/backend_api/becca_entities_brecent_note.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: becca/entities/recent_note.js</title> <title>JSDoc: Source: becca/entities/brecent_note.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: becca/entities/recent_note.js</h1> <h1 class="page-title">Source: becca/entities/brecent_note.js</h1>
@ -29,14 +29,14 @@
<pre class="prettyprint source linenums"><code>"use strict"; <pre class="prettyprint source linenums"><code>"use strict";
const dateUtils = require('../../services/date_utils'); const dateUtils = require('../../services/date_utils');
const AbstractEntity = require("./abstract_entity"); const AbstractBeccaEntity = require("./abstract_becca_entity");
/** /**
* RecentNote represents recently visited note. * RecentNote represents recently visited note.
* *
* @extends AbstractEntity * @extends AbstractBeccaEntity
*/ */
class RecentNote extends AbstractEntity { class BRecentNote extends AbstractBeccaEntity {
static get entityName() { return "recent_notes"; } static get entityName() { return "recent_notes"; }
static get primaryKeyName() { return "noteId"; } static get primaryKeyName() { return "noteId"; }
@ -60,7 +60,7 @@ class RecentNote extends AbstractEntity {
} }
} }
module.exports = RecentNote; module.exports = BRecentNote;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -71,7 +71,7 @@ module.exports = RecentNote;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

2
docs/backend_api/global.html
View File

@ -1711,7 +1711,7 @@
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

2
docs/backend_api/index.html
View File

@ -50,7 +50,7 @@
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

2
docs/backend_api/module-sql.html
View File

@ -1294,7 +1294,7 @@
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

53
docs/backend_api/services_backend_script_api.js.html
View File

@ -55,9 +55,9 @@ const exportService = require("./export/zip");
* @hideconstructor * @hideconstructor
*/ */
function BackendScriptApi(currentNote, apiParams) { function BackendScriptApi(currentNote, apiParams) {
/** @property {Note} note where script started executing */ /** @property {BNote} note where script started executing */
this.startNote = apiParams.startNote; this.startNote = apiParams.startNote;
/** @property {Note} note where script is currently executing. Don't mix this up with concept of active note */ /** @property {BNote} note where script is currently executing. Don't mix this up with concept of active note */
this.currentNote = currentNote; this.currentNote = currentNote;
/** @property {Entity} entity whose event triggered this executions */ /** @property {Entity} entity whose event triggered this executions */
this.originEntity = apiParams.originEntity; this.originEntity = apiParams.originEntity;
@ -89,7 +89,7 @@ function BackendScriptApi(currentNote, apiParams) {
/** /**
* @method * @method
* @param {string} noteId * @param {string} noteId
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.getNote = noteId => becca.getNote(noteId); this.getNote = noteId => becca.getNote(noteId);
@ -114,7 +114,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method * @method
* @param {string} query * @param {string} query
* @param {Object} [searchParams] * @param {Object} [searchParams]
* @returns {Note[]} * @returns {BNote[]}
*/ */
this.searchForNotes = (query, searchParams = {}) => { this.searchForNotes = (query, searchParams = {}) => {
if (searchParams.includeArchivedNotes === undefined) { if (searchParams.includeArchivedNotes === undefined) {
@ -138,7 +138,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method * @method
* @param {string} query * @param {string} query
* @param {Object} [searchParams] * @param {Object} [searchParams]
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.searchForNote = (query, searchParams = {}) => { this.searchForNote = (query, searchParams = {}) => {
const notes = this.searchForNotes(query, searchParams); const notes = this.searchForNotes(query, searchParams);
@ -152,7 +152,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method * @method
* @param {string} name - attribute name * @param {string} name - attribute name
* @param {string} [value] - attribute value * @param {string} [value] - attribute value
* @returns {Note[]} * @returns {BNote[]}
*/ */
this.getNotesWithLabel = attributeService.getNotesWithLabel; this.getNotesWithLabel = attributeService.getNotesWithLabel;
@ -162,7 +162,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method * @method
* @param {string} name - attribute name * @param {string} name - attribute name
* @param {string} [value] - attribute value * @param {string} [value] - attribute value
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.getNoteWithLabel = attributeService.getNoteWithLabel; this.getNoteWithLabel = attributeService.getNoteWithLabel;
@ -212,7 +212,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @param {string} parentNoteId * @param {string} parentNoteId
* @param {string} title * @param {string} title
* @param {string} content * @param {string} content
* @return {{note: Note, branch: Branch}} - object having "note" and "branch" keys representing respective objects * @return {{note: BNote, branch: Branch}} - object having "note" and "branch" keys representing respective objects
*/ */
this.createTextNote = (parentNoteId, title, content = '') => noteService.createNewNote({ this.createTextNote = (parentNoteId, title, content = '') => noteService.createNewNote({
parentNoteId, parentNoteId,
@ -228,7 +228,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @param {string} parentNoteId * @param {string} parentNoteId
* @param {string} title * @param {string} title
* @param {object} content * @param {object} content
* @return {{note: Note, branch: Branch}} object having "note" and "branch" keys representing respective objects * @return {{note: BNote, branch: Branch}} object having "note" and "branch" keys representing respective objects
*/ */
this.createDataNote = (parentNoteId, title, content = {}) => noteService.createNewNote({ this.createDataNote = (parentNoteId, title, content = {}) => noteService.createNewNote({
parentNoteId, parentNoteId,
@ -255,7 +255,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method * @method
* *
* @param {CreateNewNoteParams} [params] * @param {CreateNewNoteParams} [params]
* @returns {{note: Note, branch: Branch}} object contains newly created entities note and branch * @returns {{note: BNote, branch: Branch}} object contains newly created entities note and branch
*/ */
this.createNewNote = noteService.createNewNote; this.createNewNote = noteService.createNewNote;
@ -283,7 +283,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @param {string} title * @param {string} title
* @param {string} [content=""] * @param {string} [content=""]
* @param {CreateNoteExtraOptions} [extraOptions={}] * @param {CreateNoteExtraOptions} [extraOptions={}]
* @returns {{note: Note, branch: Branch}} object contains newly created entities note and branch * @returns {{note: BNote, branch: Branch}} object contains newly created entities note and branch
*/ */
this.createNote = (parentNoteId, title, content = "", extraOptions= {}) => { this.createNote = (parentNoteId, title, content = "", extraOptions= {}) => {
extraOptions.parentNoteId = parentNoteId; extraOptions.parentNoteId = parentNoteId;
@ -354,7 +354,7 @@ function BackendScriptApi(currentNote, apiParams) {
* Returns root note of the calendar. * Returns root note of the calendar.
* *
* @method * @method
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.getRootCalendarNote = dateNoteService.getRootCalendarNote; this.getRootCalendarNote = dateNoteService.getRootCalendarNote;
@ -363,8 +363,8 @@ function BackendScriptApi(currentNote, apiParams) {
* *
* @method * @method
* @param {string} date in YYYY-MM-DD format * @param {string} date in YYYY-MM-DD format
* @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
* @returns {Note|null} * @returns {BNote|null}
* @deprecated use getDayNote instead * @deprecated use getDayNote instead
*/ */
this.getDateNote = dateNoteService.getDayNote; this.getDateNote = dateNoteService.getDayNote;
@ -374,8 +374,8 @@ function BackendScriptApi(currentNote, apiParams) {
* *
* @method * @method
* @param {string} date in YYYY-MM-DD format * @param {string} date in YYYY-MM-DD format
* @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.getDayNote = dateNoteService.getDayNote; this.getDayNote = dateNoteService.getDayNote;
@ -383,8 +383,8 @@ function BackendScriptApi(currentNote, apiParams) {
* Returns today's day note. If such note doesn't exist, it is created. * Returns today's day note. If such note doesn't exist, it is created.
* *
* @method * @method
* @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.getTodayNote = dateNoteService.getTodayNote; this.getTodayNote = dateNoteService.getTodayNote;
@ -394,8 +394,8 @@ function BackendScriptApi(currentNote, apiParams) {
* @method * @method
* @param {string} date in YYYY-MM-DD format * @param {string} date in YYYY-MM-DD format
* @param {object} [options] - "startOfTheWeek" - either "monday" (default) or "sunday" * @param {object} [options] - "startOfTheWeek" - either "monday" (default) or "sunday"
* @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.getWeekNote = dateNoteService.getWeekNote; this.getWeekNote = dateNoteService.getWeekNote;
@ -404,8 +404,8 @@ function BackendScriptApi(currentNote, apiParams) {
* *
* @method * @method
* @param {string} date in YYYY-MM format * @param {string} date in YYYY-MM format
* @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.getMonthNote = dateNoteService.getMonthNote; this.getMonthNote = dateNoteService.getMonthNote;
@ -414,8 +414,8 @@ function BackendScriptApi(currentNote, apiParams) {
* *
* @method * @method
* @param {string} year in YYYY format * @param {string} year in YYYY format
* @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
* @returns {Note|null} * @returns {BNote|null}
*/ */
this.getYearNote = dateNoteService.getYearNote; this.getYearNote = dateNoteService.getYearNote;
@ -596,8 +596,9 @@ function BackendScriptApi(currentNote, apiParams) {
* @param {string} noteId * @param {string} noteId
* @param {string} format - either 'html' or 'markdown' * @param {string} format - either 'html' or 'markdown'
* @param {string} zipFilePath * @param {string} zipFilePath
* @returns {Promise}
*/ */
this.exportSubtreeToZipFile = (noteId, format, zipFilePath) => exportService.exportToZipFile(noteId, format, zipFilePath); this.exportSubtreeToZipFile = async (noteId, format, zipFilePath) => await exportService.exportToZipFile(noteId, format, zipFilePath);
/** /**
* This object contains "at your risk" and "no BC guarantees" objects for advanced use cases. * This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.
@ -620,7 +621,7 @@ module.exports = BackendScriptApi;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

2
docs/backend_api/services_sql.js.html
View File

@ -404,7 +404,7 @@ module.exports = {
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav> </nav>
<br class="clear"> <br class="clear">

38
docs/frontend_api/Attribute.html → docs/frontend_api/FAttribute.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: Attribute</title> <title>JSDoc: Class: FAttribute</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: Attribute</h1> <h1 class="page-title">Class: FAttribute</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>Attribute<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>FAttribute<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair) <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
and relation (representing named relationship between source and target note)</div> and relation (representing named relationship between source and target note)</div>
@ -46,7 +46,7 @@ and relation (representing named relationship between source and target note)</d
<h4 class="name" id="Attribute"><span class="type-signature"></span>new Attribute<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="FAttribute"><span class="type-signature"></span>new FAttribute<span class="signature">()</span><span class="type-signature"></span></h4>
@ -94,7 +94,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line7">line 7</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line7">line 7</a>
</li></ul></dd> </li></ul></dd>
@ -194,7 +194,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line16">line 16</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line16">line 16</a>
</li></ul></dd> </li></ul></dd>
@ -262,7 +262,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line28">line 28</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line28">line 28</a>
</li></ul></dd> </li></ul></dd>
@ -330,7 +330,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line22">line 22</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line22">line 22</a>
</li></ul></dd> </li></ul></dd>
@ -398,7 +398,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line18">line 18</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line18">line 18</a>
</li></ul></dd> </li></ul></dd>
@ -466,7 +466,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line26">line 26</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line26">line 26</a>
</li></ul></dd> </li></ul></dd>
@ -534,7 +534,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line20">line 20</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line20">line 20</a>
</li></ul></dd> </li></ul></dd>
@ -602,7 +602,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line24">line 24</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line24">line 24</a>
</li></ul></dd> </li></ul></dd>
@ -630,7 +630,7 @@ and relation (representing named relationship between source and target note)</d
<h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4> <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
@ -678,7 +678,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line32">line 32</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line32">line 32</a>
</li></ul></dd> </li></ul></dd>
@ -714,7 +714,7 @@ and relation (representing named relationship between source and target note)</d
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="NoteShort.html">NoteShort</a></span> <span class="param-type"><a href="FNote.html">FNote</a></span>
</dd> </dd>
@ -732,7 +732,7 @@ and relation (representing named relationship between source and target note)</d
<h4 class="name" id="getTargetNote"><span class="type-signature">(async) </span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getTargetNote"><span class="type-signature">(async) </span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -780,7 +780,7 @@ and relation (representing named relationship between source and target note)</d
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line37">line 37</a> <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line37">line 37</a>
</li></ul></dd> </li></ul></dd>
@ -816,7 +816,7 @@ and relation (representing named relationship between source and target note)</d
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -844,7 +844,7 @@ and relation (representing named relationship between source and target note)</d
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

46
docs/frontend_api/Branch.html → docs/frontend_api/FBranch.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: Branch</title> <title>JSDoc: Class: FBranch</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: Branch</h1> <h1 class="page-title">Class: FBranch</h1>
@ -28,7 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>Branch<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>FBranch<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
parents.</div> parents.</div>
@ -46,7 +46,7 @@ parents.</div>
<h4 class="name" id="Branch"><span class="type-signature"></span>new Branch<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="FBranch"><span class="type-signature"></span>new FBranch<span class="signature">()</span><span class="type-signature"></span></h4>
@ -94,7 +94,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line5">line 5</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line5">line 5</a>
</li></ul></dd> </li></ul></dd>
@ -198,7 +198,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line17">line 17</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line17">line 17</a>
</li></ul></dd> </li></ul></dd>
@ -266,7 +266,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line29">line 29</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line29">line 29</a>
</li></ul></dd> </li></ul></dd>
@ -334,7 +334,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line27">line 27</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line27">line 27</a>
</li></ul></dd> </li></ul></dd>
@ -402,7 +402,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line19">line 19</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line19">line 19</a>
</li></ul></dd> </li></ul></dd>
@ -470,7 +470,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line23">line 23</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line23">line 23</a>
</li></ul></dd> </li></ul></dd>
@ -538,7 +538,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line21">line 21</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line21">line 21</a>
</li></ul></dd> </li></ul></dd>
@ -606,7 +606,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line25">line 25</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line25">line 25</a>
</li></ul></dd> </li></ul></dd>
@ -634,7 +634,7 @@ parents.</div>
<h4 class="name" id="getNote"><span class="type-signature">(async) </span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4> <h4 class="name" id="getNote"><span class="type-signature">(async) </span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
@ -682,7 +682,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line33">line 33</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line33">line 33</a>
</li></ul></dd> </li></ul></dd>
@ -718,7 +718,7 @@ parents.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="NoteShort.html">NoteShort</a></span> <span class="param-type"><a href="FNote.html">FNote</a></span>
</dd> </dd>
@ -736,7 +736,7 @@ parents.</div>
<h4 class="name" id="getNoteFromCache"><span class="type-signature"></span>getNoteFromCache<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4> <h4 class="name" id="getNoteFromCache"><span class="type-signature"></span>getNoteFromCache<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
@ -784,7 +784,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line38">line 38</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line38">line 38</a>
</li></ul></dd> </li></ul></dd>
@ -820,7 +820,7 @@ parents.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="NoteShort.html">NoteShort</a></span> <span class="param-type"><a href="FNote.html">FNote</a></span>
</dd> </dd>
@ -838,7 +838,7 @@ parents.</div>
<h4 class="name" id="getParentNote"><span class="type-signature">(async) </span>getParentNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4> <h4 class="name" id="getParentNote"><span class="type-signature">(async) </span>getParentNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
@ -886,7 +886,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line43">line 43</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line43">line 43</a>
</li></ul></dd> </li></ul></dd>
@ -922,7 +922,7 @@ parents.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="NoteShort.html">NoteShort</a></span> <span class="param-type"><a href="FNote.html">FNote</a></span>
</dd> </dd>
@ -988,7 +988,7 @@ parents.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line48">line 48</a> <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line48">line 48</a>
</li></ul></dd> </li></ul></dd>
@ -1056,7 +1056,7 @@ parents.</div>
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

222
docs/frontend_api/NoteShort.html → docs/frontend_api/FNote.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: NoteShort</title> <title>JSDoc: Class: FNote</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: NoteShort</h1> <h1 class="page-title">Class: FNote</h1>
@ -28,11 +28,7 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>NoteShort<span class="signature">(froca, row)</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>FNote<span class="signature">(froca, row)</span><span class="type-signature"></span></h2>
<div class="class-description">FIXME: since there's no "full note" anymore we can rename this to Note
This note's representation is used in note tree and is kept in Froca.</div>
</header> </header>
@ -43,11 +39,9 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h2>Constructor</h2>
<h4 class="name" id="FNote"><span class="type-signature"></span>new FNote<span class="signature">(froca, row)</span><span class="type-signature"></span></h4>
<h4 class="name" id="NoteShort"><span class="type-signature"></span>new NoteShort<span class="signature">(froca, row)</span><span class="type-signature"></span></h4>
@ -167,7 +161,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line34">line 34</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line34">line 34</a>
</li></ul></dd> </li></ul></dd>
@ -267,7 +261,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line43">line 43</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line38">line 38</a>
</li></ul></dd> </li></ul></dd>
@ -335,7 +329,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line57">line 57</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line52">line 52</a>
</li></ul></dd> </li></ul></dd>
@ -403,7 +397,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line51">line 51</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line46">line 46</a>
</li></ul></dd> </li></ul></dd>
@ -471,7 +465,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line68">line 68</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line63">line 63</a>
</li></ul></dd> </li></ul></dd>
@ -543,7 +537,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line78">line 78</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line73">line 73</a>
</li></ul></dd> </li></ul></dd>
@ -611,7 +605,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line64">line 64</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line59">line 59</a>
</li></ul></dd> </li></ul></dd>
@ -679,7 +673,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line54">line 54</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line49">line 49</a>
</li></ul></dd> </li></ul></dd>
@ -747,7 +741,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line49">line 49</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line44">line 44</a>
</li></ul></dd> </li></ul></dd>
@ -815,7 +809,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line46">line 46</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line41">line 41</a>
</li></ul></dd> </li></ul></dd>
@ -883,7 +877,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line66">line 66</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line61">line 61</a>
</li></ul></dd> </li></ul></dd>
@ -955,7 +949,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line73">line 73</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line68">line 68</a>
</li></ul></dd> </li></ul></dd>
@ -983,7 +977,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getAttribute"><span class="type-signature"></span>getAttribute<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4> <h4 class="name" id="getAttribute"><span class="type-signature"></span>getAttribute<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {<a href="FAttribute.html">FAttribute</a>}</span></h4>
@ -1103,7 +1097,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line531">line 531</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line526">line 526</a>
</li></ul></dd> </li></ul></dd>
@ -1143,7 +1137,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Attribute.html">Attribute</a></span> <span class="param-type"><a href="FAttribute.html">FAttribute</a></span>
</dd> </dd>
@ -1281,7 +1275,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line553">line 553</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line548">line 548</a>
</li></ul></dd> </li></ul></dd>
@ -1339,7 +1333,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getAttributes"><span class="type-signature"></span>getAttributes<span class="signature">(type<span class="signature-attributes">opt</span>, name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4> <h4 class="name" id="getAttributes"><span class="type-signature"></span>getAttributes<span class="signature">(type<span class="signature-attributes">opt</span>, name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FAttribute.html">FAttribute</a>>}</span></h4>
@ -1481,7 +1475,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line243">line 243</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line238">line 238</a>
</li></ul></dd> </li></ul></dd>
@ -1521,7 +1515,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span> <span class="param-type">Array.&lt;<a href="FAttribute.html">FAttribute</a>></span>
</dd> </dd>
@ -1589,7 +1583,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line151">line 151</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line146">line 146</a>
</li></ul></dd> </li></ul></dd>
@ -1643,7 +1637,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getBranches"><span class="type-signature"></span>getBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Branch.html">Branch</a>>}</span></h4> <h4 class="name" id="getBranches"><span class="type-signature"></span>getBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FBranch.html">FBranch</a>>}</span></h4>
@ -1693,7 +1687,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line168">line 168</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line163">line 163</a>
</li></ul></dd> </li></ul></dd>
@ -1729,7 +1723,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Branch.html">Branch</a>></span> <span class="param-type">Array.&lt;<a href="FBranch.html">FBranch</a>></span>
</dd> </dd>
@ -1747,7 +1741,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getChildBranches"><span class="type-signature"></span>getChildBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Branch.html">Branch</a>>}</span></h4> <h4 class="name" id="getChildBranches"><span class="type-signature"></span>getChildBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FBranch.html">FBranch</a>>}</span></h4>
@ -1795,7 +1789,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line178">line 178</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line173">line 173</a>
</li></ul></dd> </li></ul></dd>
@ -1831,7 +1825,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Branch.html">Branch</a>></span> <span class="param-type">Array.&lt;<a href="FBranch.html">FBranch</a>></span>
</dd> </dd>
@ -1897,7 +1891,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line216">line 216</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line211">line 211</a>
</li></ul></dd> </li></ul></dd>
@ -1951,7 +1945,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getChildNotes"><span class="type-signature">(async) </span>getChildNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>>}</span></h4> <h4 class="name" id="getChildNotes"><span class="type-signature">(async) </span>getChildNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="FNote.html">FNote</a>>>}</span></h4>
@ -1999,7 +1993,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line221">line 221</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line216">line 216</a>
</li></ul></dd> </li></ul></dd>
@ -2035,7 +2029,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>></span> <span class="param-type">Promise.&lt;Array.&lt;<a href="FNote.html">FNote</a>>></span>
</dd> </dd>
@ -2053,7 +2047,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getLabel"><span class="type-signature"></span>getLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4> <h4 class="name" id="getLabel"><span class="type-signature"></span>getLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="FAttribute.html">FAttribute</a>}</span></h4>
@ -2150,7 +2144,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line593">line 593</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line588">line 588</a>
</li></ul></dd> </li></ul></dd>
@ -2190,7 +2184,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Attribute.html">Attribute</a></span> <span class="param-type"><a href="FAttribute.html">FAttribute</a></span>
</dd> </dd>
@ -2305,7 +2299,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line617">line 617</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line612">line 612</a>
</li></ul></dd> </li></ul></dd>
@ -2363,7 +2357,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getLabels"><span class="type-signature"></span>getLabels<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4> <h4 class="name" id="getLabels"><span class="type-signature"></span>getLabels<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FAttribute.html">FAttribute</a>>}</span></h4>
@ -2472,7 +2466,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line412">line 412</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line407">line 407</a>
</li></ul></dd> </li></ul></dd>
@ -2512,7 +2506,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span> <span class="param-type">Array.&lt;<a href="FAttribute.html">FAttribute</a>></span>
</dd> </dd>
@ -2530,7 +2524,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getNoteComplement"><span class="type-signature">(async) </span>getNoteComplement<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteComplement.html">NoteComplement</a>>}</span></h4> <h4 class="name" id="getNoteComplement"><span class="type-signature">(async) </span>getNoteComplement<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNoteComplement.html">FNoteComplement</a>>}</span></h4>
@ -2582,7 +2576,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line748">line 748</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line743">line 743</a>
</li></ul></dd> </li></ul></dd>
@ -2618,7 +2612,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteComplement.html">NoteComplement</a>></span> <span class="param-type">Promise.&lt;<a href="FNoteComplement.html">FNoteComplement</a>></span>
</dd> </dd>
@ -2636,7 +2630,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getOwnedAttribute"><span class="type-signature"></span>getOwnedAttribute<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4> <h4 class="name" id="getOwnedAttribute"><span class="type-signature"></span>getOwnedAttribute<span class="signature">(type, name)</span><span class="type-signature"> &rarr; {<a href="FAttribute.html">FAttribute</a>}</span></h4>
@ -2756,7 +2750,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line520">line 520</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line515">line 515</a>
</li></ul></dd> </li></ul></dd>
@ -2796,7 +2790,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Attribute.html">Attribute</a></span> <span class="param-type"><a href="FAttribute.html">FAttribute</a></span>
</dd> </dd>
@ -2934,7 +2928,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line542">line 542</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line537">line 537</a>
</li></ul></dd> </li></ul></dd>
@ -2992,7 +2986,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getOwnedAttributes"><span class="type-signature"></span>getOwnedAttributes<span class="signature">(type<span class="signature-attributes">opt</span>, name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4> <h4 class="name" id="getOwnedAttributes"><span class="type-signature"></span>getOwnedAttributes<span class="signature">(type<span class="signature-attributes">opt</span>, name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FAttribute.html">FAttribute</a>>}</span></h4>
@ -3134,7 +3128,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line230">line 230</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line225">line 225</a>
</li></ul></dd> </li></ul></dd>
@ -3174,7 +3168,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span> <span class="param-type">Array.&lt;<a href="FAttribute.html">FAttribute</a>></span>
</dd> </dd>
@ -3192,7 +3186,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getOwnedLabel"><span class="type-signature"></span>getOwnedLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4> <h4 class="name" id="getOwnedLabel"><span class="type-signature"></span>getOwnedLabel<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="FAttribute.html">FAttribute</a>}</span></h4>
@ -3289,7 +3283,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line587">line 587</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line582">line 582</a>
</li></ul></dd> </li></ul></dd>
@ -3329,7 +3323,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Attribute.html">Attribute</a></span> <span class="param-type"><a href="FAttribute.html">FAttribute</a></span>
</dd> </dd>
@ -3444,7 +3438,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line611">line 611</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line606">line 606</a>
</li></ul></dd> </li></ul></dd>
@ -3502,7 +3496,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getOwnedLabels"><span class="type-signature"></span>getOwnedLabels<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4> <h4 class="name" id="getOwnedLabels"><span class="type-signature"></span>getOwnedLabels<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FAttribute.html">FAttribute</a>>}</span></h4>
@ -3611,7 +3605,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line404">line 404</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line399">line 399</a>
</li></ul></dd> </li></ul></dd>
@ -3651,7 +3645,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span> <span class="param-type">Array.&lt;<a href="FAttribute.html">FAttribute</a>></span>
</dd> </dd>
@ -3669,7 +3663,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getOwnedRelation"><span class="type-signature"></span>getOwnedRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4> <h4 class="name" id="getOwnedRelation"><span class="type-signature"></span>getOwnedRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="FAttribute.html">FAttribute</a>}</span></h4>
@ -3766,7 +3760,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line599">line 599</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line594">line 594</a>
</li></ul></dd> </li></ul></dd>
@ -3806,7 +3800,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Attribute.html">Attribute</a></span> <span class="param-type"><a href="FAttribute.html">FAttribute</a></span>
</dd> </dd>
@ -3921,7 +3915,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line623">line 623</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line618">line 618</a>
</li></ul></dd> </li></ul></dd>
@ -3979,7 +3973,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getOwnedRelations"><span class="type-signature"></span>getOwnedRelations<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4> <h4 class="name" id="getOwnedRelations"><span class="type-signature"></span>getOwnedRelations<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FAttribute.html">FAttribute</a>>}</span></h4>
@ -4088,7 +4082,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line485">line 485</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line480">line 480</a>
</li></ul></dd> </li></ul></dd>
@ -4128,7 +4122,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span> <span class="param-type">Array.&lt;<a href="FAttribute.html">FAttribute</a>></span>
</dd> </dd>
@ -4194,7 +4188,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line143">line 143</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line138">line 138</a>
</li></ul></dd> </li></ul></dd>
@ -4248,7 +4242,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getParentBranches"><span class="type-signature"></span>getParentBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Branch.html">Branch</a>>}</span></h4> <h4 class="name" id="getParentBranches"><span class="type-signature"></span>getParentBranches<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FBranch.html">FBranch</a>>}</span></h4>
@ -4296,7 +4290,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line158">line 158</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line153">line 153</a>
</li></ul></dd> </li></ul></dd>
@ -4332,7 +4326,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Branch.html">Branch</a>></span> <span class="param-type">Array.&lt;<a href="FBranch.html">FBranch</a>></span>
</dd> </dd>
@ -4398,7 +4392,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line186">line 186</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line181">line 181</a>
</li></ul></dd> </li></ul></dd>
@ -4452,7 +4446,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getParentNotes"><span class="type-signature"></span>getParentNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getParentNotes"><span class="type-signature"></span>getParentNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -4500,7 +4494,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line191">line 191</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line186">line 186</a>
</li></ul></dd> </li></ul></dd>
@ -4536,7 +4530,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Array.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -4554,7 +4548,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getRelation"><span class="type-signature"></span>getRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="Attribute.html">Attribute</a>}</span></h4> <h4 class="name" id="getRelation"><span class="type-signature"></span>getRelation<span class="signature">(name)</span><span class="type-signature"> &rarr; {<a href="FAttribute.html">FAttribute</a>}</span></h4>
@ -4651,7 +4645,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line605">line 605</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line600">line 600</a>
</li></ul></dd> </li></ul></dd>
@ -4691,7 +4685,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="Attribute.html">Attribute</a></span> <span class="param-type"><a href="FAttribute.html">FAttribute</a></span>
</dd> </dd>
@ -4709,7 +4703,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getRelationTarget"><span class="type-signature">(async) </span>getRelationTarget<span class="signature">(name)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>|null}</span></h4> <h4 class="name" id="getRelationTarget"><span class="type-signature">(async) </span>getRelationTarget<span class="signature">(name)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>|null}</span></h4>
@ -4806,7 +4800,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line635">line 635</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line630">line 630</a>
</li></ul></dd> </li></ul></dd>
@ -4846,7 +4840,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
| |
<span class="param-type">null</span> <span class="param-type">null</span>
@ -4867,7 +4861,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getRelationTargets"><span class="type-signature">(async) </span>getRelationTargets<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>>}</span></h4> <h4 class="name" id="getRelationTargets"><span class="type-signature">(async) </span>getRelationTargets<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="FNote.html">FNote</a>>>}</span></h4>
@ -4976,7 +4970,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line645">line 645</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line640">line 640</a>
</li></ul></dd> </li></ul></dd>
@ -5012,7 +5006,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>></span> <span class="param-type">Promise.&lt;Array.&lt;<a href="FNote.html">FNote</a>>></span>
</dd> </dd>
@ -5127,7 +5121,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line629">line 629</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line624">line 624</a>
</li></ul></dd> </li></ul></dd>
@ -5185,7 +5179,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getRelations"><span class="type-signature"></span>getRelations<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4> <h4 class="name" id="getRelations"><span class="type-signature"></span>getRelations<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FAttribute.html">FAttribute</a>>}</span></h4>
@ -5294,7 +5288,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line493">line 493</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line488">line 488</a>
</li></ul></dd> </li></ul></dd>
@ -5334,7 +5328,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span> <span class="param-type">Array.&lt;<a href="FAttribute.html">FAttribute</a>></span>
</dd> </dd>
@ -5400,7 +5394,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line792">line 792</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line787">line 787</a>
</li></ul></dd> </li></ul></dd>
@ -5461,7 +5455,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getTargetRelationSourceNotes"><span class="type-signature">(async) </span>getTargetRelationSourceNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getTargetRelationSourceNotes"><span class="type-signature">(async) </span>getTargetRelationSourceNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -5513,7 +5507,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line737">line 737</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line732">line 732</a>
</li></ul></dd> </li></ul></dd>
@ -5549,7 +5543,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Array.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -5567,7 +5561,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getTargetRelations"><span class="type-signature"></span>getTargetRelations<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Attribute.html">Attribute</a>>}</span></h4> <h4 class="name" id="getTargetRelations"><span class="type-signature"></span>getTargetRelations<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FAttribute.html">FAttribute</a>>}</span></h4>
@ -5619,7 +5613,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line727">line 727</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line722">line 722</a>
</li></ul></dd> </li></ul></dd>
@ -5655,7 +5649,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="Attribute.html">Attribute</a>></span> <span class="param-type">Array.&lt;<a href="FAttribute.html">FAttribute</a>></span>
</dd> </dd>
@ -5673,7 +5667,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<h4 class="name" id="getTemplateNotes"><span class="type-signature"></span>getTemplateNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getTemplateNotes"><span class="type-signature"></span>getTemplateNotes<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -5721,7 +5715,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line659">line 659</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line654">line 654</a>
</li></ul></dd> </li></ul></dd>
@ -5757,7 +5751,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</dt> </dt>
<dd> <dd>
<span class="param-type">Array.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Array.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -5895,7 +5889,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line502">line 502</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line497">line 497</a>
</li></ul></dd> </li></ul></dd>
@ -6001,7 +5995,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line173">line 173</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line168">line 168</a>
</li></ul></dd> </li></ul></dd>
@ -6152,7 +6146,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line569">line 569</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line564">line 564</a>
</li></ul></dd> </li></ul></dd>
@ -6330,7 +6324,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line511">line 511</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line506">line 506</a>
</li></ul></dd> </li></ul></dd>
@ -6485,7 +6479,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line563">line 563</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line558">line 558</a>
</li></ul></dd> </li></ul></dd>
@ -6640,7 +6634,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line575">line 575</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line570">line 570</a>
</li></ul></dd> </li></ul></dd>
@ -6795,7 +6789,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line581">line 581</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line576">line 576</a>
</li></ul></dd> </li></ul></dd>
@ -6903,7 +6897,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line720">line 720</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line715">line 715</a>
</li></ul></dd> </li></ul></dd>
@ -6987,7 +6981,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line787">line 787</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line782">line 782</a>
</li></ul></dd> </li></ul></dd>
@ -7093,7 +7087,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line779">line 779</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line774">line 774</a>
</li></ul></dd> </li></ul></dd>
@ -7199,7 +7193,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_short.js.html">entities/note_short.js</a>, <a href="entities_note_short.js.html#line116">line 116</a> <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line111">line 111</a>
</li></ul></dd> </li></ul></dd>
@ -7263,7 +7257,7 @@ This note's representation is used in note tree and is kept in Froca.</div>
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

32
docs/frontend_api/NoteComplement.html → docs/frontend_api/FNoteComplement.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Class: NoteComplement</title> <title>JSDoc: Class: FNoteComplement</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Class: NoteComplement</h1> <h1 class="page-title">Class: FNoteComplement</h1>
@ -28,9 +28,9 @@
<header> <header>
<h2><span class="attribs"><span class="type-signature"></span></span>NoteComplement<span class="signature">()</span><span class="type-signature"></span></h2> <h2><span class="attribs"><span class="type-signature"></span></span>FNoteComplement<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Complements the NoteShort with the main note content and other extra attributes</div> <div class="class-description">Complements the FNote with the main note content and other extra attributes</div>
</header> </header>
@ -45,7 +45,7 @@
<h4 class="name" id="NoteComplement"><span class="type-signature"></span>new NoteComplement<span class="signature">()</span><span class="type-signature"></span></h4> <h4 class="name" id="FNoteComplement"><span class="type-signature"></span>new FNoteComplement<span class="signature">()</span><span class="type-signature"></span></h4>
@ -93,7 +93,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line4">line 4</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line4">line 4</a>
</li></ul></dd> </li></ul></dd>
@ -193,7 +193,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line33">line 33</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line33">line 33</a>
</li></ul></dd> </li></ul></dd>
@ -261,7 +261,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line36">line 36</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line36">line 36</a>
</li></ul></dd> </li></ul></dd>
@ -333,7 +333,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line13">line 13</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line13">line 13</a>
</li></ul></dd> </li></ul></dd>
@ -401,7 +401,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line16">line 16</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line16">line 16</a>
</li></ul></dd> </li></ul></dd>
@ -469,7 +469,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line19">line 19</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line19">line 19</a>
</li></ul></dd> </li></ul></dd>
@ -537,7 +537,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line22">line 22</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line22">line 22</a>
</li></ul></dd> </li></ul></dd>
@ -605,7 +605,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line7">line 7</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line7">line 7</a>
</li></ul></dd> </li></ul></dd>
@ -673,7 +673,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line25">line 25</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line25">line 25</a>
</li></ul></dd> </li></ul></dd>
@ -741,7 +741,7 @@
<dt class="tag-source">Source:</dt> <dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li> <dd class="tag-source"><ul class="dummy"><li>
<a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line28">line 28</a> <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line28">line 28</a>
</li></ul></dd> </li></ul></dd>
@ -775,7 +775,7 @@
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

50
docs/frontend_api/FrontendScriptApi.html
View File

@ -2789,7 +2789,7 @@
<h4 class="name" id="getActiveContextNote"><span class="type-signature"></span>getActiveContextNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4> <h4 class="name" id="getActiveContextNote"><span class="type-signature"></span>getActiveContextNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
@ -2877,7 +2877,7 @@
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="NoteShort.html">NoteShort</a></span> <span class="param-type"><a href="FNote.html">FNote</a></span>
</dd> </dd>
@ -3218,7 +3218,7 @@ implementation of actual widget type.
<h4 class="name" id="getActiveTabNote"><span class="type-signature"></span>getActiveTabNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4> <h4 class="name" id="getActiveTabNote"><span class="type-signature"></span>getActiveTabNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
@ -3308,7 +3308,7 @@ implementation of actual widget type.
</dt> </dt>
<dd> <dd>
<span class="param-type"><a href="NoteShort.html">NoteShort</a></span> <span class="param-type"><a href="FNote.html">FNote</a></span>
</dd> </dd>
@ -3735,7 +3735,7 @@ implementation of actual widget type.
<h4 class="name" id="getDateNote"><span class="type-signature"></span>getDateNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getDateNote"><span class="type-signature"></span>getDateNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -3874,7 +3874,7 @@ implementation of actual widget type.
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -3892,7 +3892,7 @@ implementation of actual widget type.
<h4 class="name" id="getDayNote"><span class="type-signature"></span>getDayNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getDayNote"><span class="type-signature"></span>getDayNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -4029,7 +4029,7 @@ implementation of actual widget type.
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -4154,7 +4154,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getMonthNote"><span class="type-signature"></span>getMonthNote<span class="signature">(month)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getMonthNote"><span class="type-signature"></span>getMonthNote<span class="signature">(month)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -4291,7 +4291,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -4309,7 +4309,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">(noteId)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">(noteId)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -4447,7 +4447,7 @@ if some action needs to happen on only one specific instance.
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -4465,7 +4465,7 @@ if some action needs to happen on only one specific instance.
<h4 class="name" id="getNotes"><span class="type-signature"></span>getNotes<span class="signature">(noteIds, silentNotFoundError<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>>}</span></h4> <h4 class="name" id="getNotes"><span class="type-signature"></span>getNotes<span class="signature">(noteIds, silentNotFoundError<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="FNote.html">FNote</a>>>}</span></h4>
@ -4648,7 +4648,7 @@ otherwise (by e.g. createNoteLink())
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>></span> <span class="param-type">Promise.&lt;Array.&lt;<a href="FNote.html">FNote</a>>></span>
</dd> </dd>
@ -4666,7 +4666,7 @@ otherwise (by e.g. createNoteLink())
<h4 class="name" id="getTodayNote"><span class="type-signature"></span>getTodayNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getTodayNote"><span class="type-signature"></span>getTodayNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -4754,7 +4754,7 @@ otherwise (by e.g. createNoteLink())
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -4772,7 +4772,7 @@ otherwise (by e.g. createNoteLink())
<h4 class="name" id="getWeekNote"><span class="type-signature"></span>getWeekNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getWeekNote"><span class="type-signature"></span>getWeekNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -4909,7 +4909,7 @@ otherwise (by e.g. createNoteLink())
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -4927,7 +4927,7 @@ otherwise (by e.g. createNoteLink())
<h4 class="name" id="getYearNote"><span class="type-signature"></span>getYearNote<span class="signature">(year)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4> <h4 class="name" id="getYearNote"><span class="type-signature"></span>getYearNote<span class="signature">(year)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
@ -5064,7 +5064,7 @@ otherwise (by e.g. createNoteLink())
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span> <span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
</dd> </dd>
@ -6906,7 +6906,7 @@ Internally this serializes the anonymous function into string and sends it to ba
<h4 class="name" id="searchForNote"><span class="type-signature"></span>searchForNote<span class="signature">(searchString)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="NoteShort.html">NoteShort</a>|null)>}</span></h4> <h4 class="name" id="searchForNote"><span class="type-signature"></span>searchForNote<span class="signature">(searchString)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="FNote.html">FNote</a>|null)>}</span></h4>
@ -7044,7 +7044,7 @@ Internally this serializes the anonymous function into string and sends it to ba
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;(<a href="NoteShort.html">NoteShort</a>|null)></span> <span class="param-type">Promise.&lt;(<a href="FNote.html">FNote</a>|null)></span>
</dd> </dd>
@ -7062,7 +7062,7 @@ Internally this serializes the anonymous function into string and sends it to ba
<h4 class="name" id="searchForNotes"><span class="type-signature"></span>searchForNotes<span class="signature">(searchString)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>>}</span></h4> <h4 class="name" id="searchForNotes"><span class="type-signature"></span>searchForNotes<span class="signature">(searchString)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="FNote.html">FNote</a>>>}</span></h4>
@ -7200,7 +7200,7 @@ Internally this serializes the anonymous function into string and sends it to ba
</dt> </dt>
<dd> <dd>
<span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>></span> <span class="param-type">Promise.&lt;Array.&lt;<a href="FNote.html">FNote</a>>></span>
</dd> </dd>
@ -8202,7 +8202,7 @@ Typical use case is when new note has been created, we should wait until it is s
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

18
docs/frontend_api/entities_attribute.js.html → docs/frontend_api/entities_fattribute.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: entities/attribute.js</title> <title>JSDoc: Source: entities/fattribute.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: entities/attribute.js</h1> <h1 class="page-title">Source: entities/fattribute.js</h1>
@ -32,7 +32,7 @@
* Attribute is an abstract concept which has two real uses - label (key - value pair) * Attribute is an abstract concept which has two real uses - label (key - value pair)
* and relation (representing named relationship between source and target note) * and relation (representing named relationship between source and target note)
*/ */
class Attribute { class FAttribute {
constructor(froca, row) { constructor(froca, row) {
this.froca = froca; this.froca = froca;
@ -56,12 +56,12 @@ class Attribute {
this.isInheritable = !!row.isInheritable; this.isInheritable = !!row.isInheritable;
} }
/** @returns {NoteShort} */ /** @returns {FNote} */
getNote() { getNote() {
return this.froca.notes[this.noteId]; return this.froca.notes[this.noteId];
} }
/** @returns {Promise&lt;NoteShort>} */ /** @returns {Promise&lt;FNote>} */
async getTargetNote() { async getTargetNote() {
const targetNoteId = this.targetNoteId; const targetNoteId = this.targetNoteId;
@ -70,7 +70,7 @@ class Attribute {
get targetNoteId() { // alias get targetNoteId() { // alias
if (this.type !== 'relation') { if (this.type !== 'relation') {
throw new Error(`Attribute ${this.attributeId} is not a relation`); throw new Error(`FAttribute ${this.attributeId} is not a relation`);
} }
return this.value; return this.value;
@ -81,7 +81,7 @@ class Attribute {
} }
get toString() { get toString() {
return `Attribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`; return `FAttribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`;
} }
isDefinition() { isDefinition() {
@ -104,7 +104,7 @@ class Attribute {
} }
} }
export default Attribute; export default FAttribute;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -115,7 +115,7 @@ export default Attribute;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

18
docs/frontend_api/entities_branch.js.html → docs/frontend_api/entities_fbranch.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: entities/branch.js</title> <title>JSDoc: Source: entities/fbranch.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: entities/branch.js</h1> <h1 class="page-title">Source: entities/fbranch.js</h1>
@ -30,7 +30,7 @@
* Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple * Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
* parents. * parents.
*/ */
class Branch { class FBranch {
constructor(froca, row) { constructor(froca, row) {
this.froca = froca; this.froca = froca;
@ -57,17 +57,17 @@ class Branch {
this.fromSearchNote = !!row.fromSearchNote; this.fromSearchNote = !!row.fromSearchNote;
} }
/** @returns {NoteShort} */ /** @returns {FNote} */
async getNote() { async getNote() {
return this.froca.getNote(this.noteId); return this.froca.getNote(this.noteId);
} }
/** @returns {NoteShort} */ /** @returns {FNote} */
getNoteFromCache() { getNoteFromCache() {
return this.froca.getNoteFromCache(this.noteId); return this.froca.getNoteFromCache(this.noteId);
} }
/** @returns {NoteShort} */ /** @returns {FNote} */
async getParentNote() { async getParentNote() {
return this.froca.getNote(this.parentNoteId); return this.froca.getNote(this.parentNoteId);
} }
@ -78,7 +78,7 @@ class Branch {
} }
get toString() { get toString() {
return `Branch(branchId=${this.branchId})`; return `FBranch(branchId=${this.branchId})`;
} }
get pojo() { get pojo() {
@ -88,7 +88,7 @@ class Branch {
} }
} }
export default Branch; export default FBranch;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -99,7 +99,7 @@ export default Branch;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

61
docs/frontend_api/entities_note_short.js.html → docs/frontend_api/entities_fnote.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: entities/note_short.js</title> <title>JSDoc: Source: entities/fnote.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: entities/note_short.js</h1> <h1 class="page-title">Source: entities/fnote.js</h1>
@ -54,12 +54,7 @@ const NOTE_TYPE_ICONS = {
"contentWidget": "bx bxs-widget" "contentWidget": "bx bxs-widget"
}; };
/** class FNote {
* FIXME: since there's no "full note" anymore we can rename this to Note
*
* This note's representation is used in note tree and is kept in Froca.
*/
class NoteShort {
/** /**
* @param {Froca} froca * @param {Froca} froca
* @param {Object.&lt;string, Object>} row * @param {Object.&lt;string, Object>} row
@ -181,7 +176,7 @@ class NoteShort {
} }
/** /**
* @returns {Branch[]} * @returns {FBranch[]}
*/ */
getParentBranches() { getParentBranches() {
const branchIds = Object.values(this.parentToBranch); const branchIds = Object.values(this.parentToBranch);
@ -190,7 +185,7 @@ class NoteShort {
} }
/** /**
* @returns {Branch[]} * @returns {FBranch[]}
* @deprecated use getParentBranches() instead * @deprecated use getParentBranches() instead
*/ */
getBranches() { getBranches() {
@ -202,7 +197,7 @@ class NoteShort {
return this.children.length > 0; return this.children.length > 0;
} }
/** @returns {Branch[]} */ /** @returns {FBranch[]} */
getChildBranches() { getChildBranches() {
// don't use Object.values() to guarantee order // don't use Object.values() to guarantee order
const branchIds = this.children.map(childNoteId => this.childToBranch[childNoteId]); const branchIds = this.children.map(childNoteId => this.childToBranch[childNoteId]);
@ -215,7 +210,7 @@ class NoteShort {
return this.parents; return this.parents;
} }
/** @returns {NoteShort[]} */ /** @returns {FNote[]} */
getParentNotes() { getParentNotes() {
return this.froca.getNotesFromCache(this.parents); return this.froca.getNotesFromCache(this.parents);
} }
@ -245,7 +240,7 @@ class NoteShort {
return this.children; return this.children;
} }
/** @returns {Promise&lt;NoteShort[]>} */ /** @returns {Promise&lt;FNote[]>} */
async getChildNotes() { async getChildNotes() {
return await this.froca.getNotes(this.children); return await this.froca.getNotes(this.children);
} }
@ -253,7 +248,7 @@ class NoteShort {
/** /**
* @param {string} [type] - (optional) attribute type to filter * @param {string} [type] - (optional) attribute type to filter
* @param {string} [name] - (optional) attribute name to filter * @param {string} [name] - (optional) attribute name to filter
* @returns {Attribute[]} all note's attributes, including inherited ones * @returns {FAttribute[]} all note's attributes, including inherited ones
*/ */
getOwnedAttributes(type, name) { getOwnedAttributes(type, name) {
const attrs = this.attributes const attrs = this.attributes
@ -266,7 +261,7 @@ class NoteShort {
/** /**
* @param {string} [type] - (optional) attribute type to filter * @param {string} [type] - (optional) attribute type to filter
* @param {string} [name] - (optional) attribute name to filter * @param {string} [name] - (optional) attribute name to filter
* @returns {Attribute[]} all note's attributes, including inherited ones * @returns {FAttribute[]} all note's attributes, including inherited ones
*/ */
getAttributes(type, name) { getAttributes(type, name) {
return this.__filterAttrs(this.__getCachedAttributes([]), type, name); return this.__filterAttrs(this.__getCachedAttributes([]), type, name);
@ -427,7 +422,7 @@ class NoteShort {
/** /**
* @param {string} [name] - label name to filter * @param {string} [name] - label name to filter
* @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones * @returns {FAttribute[]} all note's labels (attributes with type label), including inherited ones
*/ */
getOwnedLabels(name) { getOwnedLabels(name) {
return this.getOwnedAttributes(LABEL, name); return this.getOwnedAttributes(LABEL, name);
@ -435,7 +430,7 @@ class NoteShort {
/** /**
* @param {string} [name] - label name to filter * @param {string} [name] - label name to filter
* @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones * @returns {FAttribute[]} all note's labels (attributes with type label), including inherited ones
*/ */
getLabels(name) { getLabels(name) {
return this.getAttributes(LABEL, name); return this.getAttributes(LABEL, name);
@ -508,7 +503,7 @@ class NoteShort {
/** /**
* @param {string} [name] - relation name to filter * @param {string} [name] - relation name to filter
* @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones * @returns {FAttribute[]} all note's relations (attributes with type relation), including inherited ones
*/ */
getOwnedRelations(name) { getOwnedRelations(name) {
return this.getOwnedAttributes(RELATION, name); return this.getOwnedAttributes(RELATION, name);
@ -516,7 +511,7 @@ class NoteShort {
/** /**
* @param {string} [name] - relation name to filter * @param {string} [name] - relation name to filter
* @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones * @returns {FAttribute[]} all note's relations (attributes with type relation), including inherited ones
*/ */
getRelations(name) { getRelations(name) {
return this.getAttributes(RELATION, name); return this.getAttributes(RELATION, name);
@ -543,7 +538,7 @@ class NoteShort {
/** /**
* @param {string} type - attribute type (label, relation, etc.) * @param {string} type - attribute type (label, relation, etc.)
* @param {string} name - attribute name * @param {string} name - attribute name
* @returns {Attribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note. * @returns {FAttribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
*/ */
getOwnedAttribute(type, name) { getOwnedAttribute(type, name) {
const attributes = this.getOwnedAttributes(type, name); const attributes = this.getOwnedAttributes(type, name);
@ -554,7 +549,7 @@ class NoteShort {
/** /**
* @param {string} type - attribute type (label, relation, etc.) * @param {string} type - attribute type (label, relation, etc.)
* @param {string} name - attribute name * @param {string} name - attribute name
* @returns {Attribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note. * @returns {FAttribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
*/ */
getAttribute(type, name) { getAttribute(type, name) {
const attributes = this.getAttributes(type, name); const attributes = this.getAttributes(type, name);
@ -610,25 +605,25 @@ class NoteShort {
/** /**
* @param {string} name - label name * @param {string} name - label name
* @returns {Attribute} label if it exists, null otherwise * @returns {FAttribute} label if it exists, null otherwise
*/ */
getOwnedLabel(name) { return this.getOwnedAttribute(LABEL, name); } getOwnedLabel(name) { return this.getOwnedAttribute(LABEL, name); }
/** /**
* @param {string} name - label name * @param {string} name - label name
* @returns {Attribute} label if it exists, null otherwise * @returns {FAttribute} label if it exists, null otherwise
*/ */
getLabel(name) { return this.getAttribute(LABEL, name); } getLabel(name) { return this.getAttribute(LABEL, name); }
/** /**
* @param {string} name - relation name * @param {string} name - relation name
* @returns {Attribute} relation if it exists, null otherwise * @returns {FAttribute} relation if it exists, null otherwise
*/ */
getOwnedRelation(name) { return this.getOwnedAttribute(RELATION, name); } getOwnedRelation(name) { return this.getOwnedAttribute(RELATION, name); }
/** /**
* @param {string} name - relation name * @param {string} name - relation name
* @returns {Attribute} relation if it exists, null otherwise * @returns {FAttribute} relation if it exists, null otherwise
*/ */
getRelation(name) { return this.getAttribute(RELATION, name); } getRelation(name) { return this.getAttribute(RELATION, name); }
@ -658,7 +653,7 @@ class NoteShort {
/** /**
* @param {string} name * @param {string} name
* @returns {Promise&lt;NoteShort>|null} target note of the relation or null (if target is empty or note was not found) * @returns {Promise&lt;FNote>|null} target note of the relation or null (if target is empty or note was not found)
*/ */
async getRelationTarget(name) { async getRelationTarget(name) {
const targets = await this.getRelationTargets(name); const targets = await this.getRelationTargets(name);
@ -668,7 +663,7 @@ class NoteShort {
/** /**
* @param {string} [name] - relation name to filter * @param {string} [name] - relation name to filter
* @returns {Promise&lt;NoteShort[]>} * @returns {Promise&lt;FNote[]>}
*/ */
async getRelationTargets(name) { async getRelationTargets(name) {
const relations = this.getRelations(name); const relations = this.getRelations(name);
@ -682,7 +677,7 @@ class NoteShort {
} }
/** /**
* @returns {NoteShort[]} * @returns {FNote[]}
*/ */
getTemplateNotes() { getTemplateNotes() {
const relations = this.getRelations('template'); const relations = this.getRelations('template');
@ -750,7 +745,7 @@ class NoteShort {
/** /**
* Get relations which target this note * Get relations which target this note
* *
* @returns {Attribute[]} * @returns {FAttribute[]}
*/ */
getTargetRelations() { getTargetRelations() {
return this.targetRelations return this.targetRelations
@ -760,7 +755,7 @@ class NoteShort {
/** /**
* Get relations which target this note * Get relations which target this note
* *
* @returns {NoteShort[]} * @returns {FNote[]}
*/ */
async getTargetRelationSourceNotes() { async getTargetRelationSourceNotes() {
const targetRelations = this.getTargetRelations(); const targetRelations = this.getTargetRelations();
@ -771,7 +766,7 @@ class NoteShort {
/** /**
* Return note complement which is most importantly note's content * Return note complement which is most importantly note's content
* *
* @return {Promise&lt;NoteComplement>} * @return {Promise&lt;FNoteComplement>}
*/ */
async getNoteComplement() { async getNoteComplement() {
return await this.froca.getNoteComplement(this.noteId); return await this.froca.getNoteComplement(this.noteId);
@ -885,7 +880,7 @@ class NoteShort {
} }
} }
export default NoteShort; export default FNote;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -896,7 +891,7 @@ export default NoteShort;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

12
docs/frontend_api/entities_note_complement.js.html → docs/frontend_api/entities_fnote_complement.js.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>JSDoc: Source: entities/note_complement.js</title> <title>JSDoc: Source: entities/fnote_complement.js</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>
@ -17,7 +17,7 @@
<div id="main"> <div id="main">
<h1 class="page-title">Source: entities/note_complement.js</h1> <h1 class="page-title">Source: entities/fnote_complement.js</h1>
@ -27,9 +27,9 @@
<section> <section>
<article> <article>
<pre class="prettyprint source linenums"><code>/** <pre class="prettyprint source linenums"><code>/**
* Complements the NoteShort with the main note content and other extra attributes * Complements the FNote with the main note content and other extra attributes
*/ */
class NoteComplement { class FNoteComplement {
constructor(row) { constructor(row) {
/** @type {string} */ /** @type {string} */
this.noteId = row.noteId; this.noteId = row.noteId;
@ -65,7 +65,7 @@ class NoteComplement {
} }
} }
export default NoteComplement; export default FNoteComplement;
</code></pre> </code></pre>
</article> </article>
</section> </section>
@ -76,7 +76,7 @@ export default NoteComplement;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

2
docs/frontend_api/global.html
View File

@ -457,7 +457,7 @@
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

2
docs/frontend_api/index.html
View File

@ -50,7 +50,7 @@
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

2
docs/frontend_api/module.exports.html
View File

@ -155,7 +155,7 @@
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

26
docs/frontend_api/services_frontend_script_api.js.html
View File

@ -236,7 +236,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* *
* @method * @method
* @param {string} searchString * @param {string} searchString
* @returns {Promise&lt;NoteShort[]>} * @returns {Promise&lt;FNote[]>}
*/ */
this.searchForNotes = async searchString => { this.searchForNotes = async searchString => {
return await searchService.searchForNotes(searchString); return await searchService.searchForNotes(searchString);
@ -248,7 +248,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* *
* @method * @method
* @param {string} searchString * @param {string} searchString
* @returns {Promise&lt;NoteShort|null>} * @returns {Promise&lt;FNote|null>}
*/ */
this.searchForNote = async searchString => { this.searchForNote = async searchString => {
const notes = await this.searchForNotes(searchString); const notes = await this.searchForNotes(searchString);
@ -260,7 +260,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* Returns note by given noteId. If note is missing from cache, it's loaded. * Returns note by given noteId. If note is missing from cache, it's loaded.
** **
* @param {string} noteId * @param {string} noteId
* @return {Promise&lt;NoteShort>} * @return {Promise&lt;FNote>}
*/ */
this.getNote = async noteId => await froca.getNote(noteId); this.getNote = async noteId => await froca.getNote(noteId);
@ -272,7 +272,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* *
* @param {string[]} noteIds * @param {string[]} noteIds
* @param {boolean} [silentNotFoundError] - don't report error if the note is not found * @param {boolean} [silentNotFoundError] - don't report error if the note is not found
* @return {Promise&lt;NoteShort[]>} * @return {Promise&lt;FNote[]>}
*/ */
this.getNotes = async (noteIds, silentNotFoundError = false) => await froca.getNotes(noteIds, silentNotFoundError); this.getNotes = async (noteIds, silentNotFoundError = false) => await froca.getNotes(noteIds, silentNotFoundError);
@ -383,7 +383,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
/** /**
* @method * @method
* @deprecated use getActiveContextNote() instead * @deprecated use getActiveContextNote() instead
* @returns {NoteShort} active note (loaded into right pane) * @returns {FNote} active note (loaded into right pane)
*/ */
this.getActiveTabNote = () => { this.getActiveTabNote = () => {
console.warn("api.getActiveTabNote() is deprecated, use getActiveContextNote() instead."); console.warn("api.getActiveTabNote() is deprecated, use getActiveContextNote() instead.");
@ -393,7 +393,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
/** /**
* @method * @method
* @returns {NoteShort} active note (loaded into right pane) * @returns {FNote} active note (loaded into right pane)
*/ */
this.getActiveContextNote = () => appContext.tabManager.getActiveContextNote(); this.getActiveContextNote = () => appContext.tabManager.getActiveContextNote();
@ -499,7 +499,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* Returns date-note for today. If it doesn't exist, it is automatically created. * Returns date-note for today. If it doesn't exist, it is automatically created.
* *
* @method * @method
* @return {Promise&lt;NoteShort>} * @return {Promise&lt;FNote>}
*/ */
this.getTodayNote = dateNotesService.getTodayNote; this.getTodayNote = dateNotesService.getTodayNote;
@ -508,7 +508,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* *
* @method * @method
* @param {string} date - e.g. "2019-04-29" * @param {string} date - e.g. "2019-04-29"
* @return {Promise&lt;NoteShort>} * @return {Promise&lt;FNote>}
* @deprecated use getDayNote instead * @deprecated use getDayNote instead
*/ */
this.getDateNote = dateNotesService.getDayNote; this.getDateNote = dateNotesService.getDayNote;
@ -518,7 +518,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* *
* @method * @method
* @param {string} date - e.g. "2019-04-29" * @param {string} date - e.g. "2019-04-29"
* @return {Promise&lt;NoteShort>} * @return {Promise&lt;FNote>}
*/ */
this.getDayNote = dateNotesService.getDayNote; this.getDayNote = dateNotesService.getDayNote;
@ -527,7 +527,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* *
* @method * @method
* @param {string} date - e.g. "2019-04-29" * @param {string} date - e.g. "2019-04-29"
* @return {Promise&lt;NoteShort>} * @return {Promise&lt;FNote>}
*/ */
this.getWeekNote = dateNotesService.getWeekNote; this.getWeekNote = dateNotesService.getWeekNote;
@ -536,7 +536,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* *
* @method * @method
* @param {string} month - e.g. "2019-04" * @param {string} month - e.g. "2019-04"
* @return {Promise&lt;NoteShort>} * @return {Promise&lt;FNote>}
*/ */
this.getMonthNote = dateNotesService.getMonthNote; this.getMonthNote = dateNotesService.getMonthNote;
@ -545,7 +545,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* *
* @method * @method
* @param {string} year - e.g. "2019" * @param {string} year - e.g. "2019"
* @return {Promise&lt;NoteShort>} * @return {Promise&lt;FNote>}
*/ */
this.getYearNote = dateNotesService.getYearNote; this.getYearNote = dateNotesService.getYearNote;
@ -639,7 +639,7 @@ export default FrontendScriptApi;
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">

2
docs/frontend_api/widgets_collapsible_widget.js.html
View File

@ -74,7 +74,7 @@ export default class CollapsibleWidget extends NoteContextAwareWidget {
</div> </div>
<nav> <nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
</nav> </nav>
<br class="clear"> <br class="clear">