BBranch.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: BBranch</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: BBranch</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>BBranch<span class="signature">()</span><span class="type-signature"></span></h2>
  20. <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
  21. parents.
  22. Note that you should not rely on the branch's identity, since it can change easily with a note's move.
  23. Always check noteId instead.</div>
  24. </header>
  25. <article>
  26. <div class="container-overview">
  27. <h2>Constructor</h2>
  28. <h4 class="name" id="BBranch"><span class="type-signature"></span>new BBranch<span class="signature">()</span><span class="type-signature"></span></h4>
  29. <dl class="details">
  30. <dt class="tag-source">Source:</dt>
  31. <dd class="tag-source"><ul class="dummy"><li>
  32. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line20">line 20</a>
  33. </li></ul></dd>
  34. </dl>
  35. </div>
  36. <h3 class="subsection-title">Extends</h3>
  37. <ul>
  38. <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
  39. </ul>
  40. <h3 class="subsection-title">Members</h3>
  41. <h4 class="name" id="becca"><span class="type-signature">(protected) </span>becca<span class="type-signature"></span></h4>
  42. <dl class="details">
  43. <dt class="tag-overrides">Overrides:</dt>
  44. <dd class="tag-overrides"><ul class="dummy"><li>
  45. <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
  46. </li></ul></dd>
  47. <dt class="tag-source">Source:</dt>
  48. <dd class="tag-source"><ul class="dummy"><li>
  49. <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#line35">line 35</a>
  50. </li></ul></dd>
  51. </dl>
  52. <h4 class="name" id="branchId"><span class="type-signature"></span>branchId<span class="type-signature"> :string</span></h4>
  53. <h5>Type:</h5>
  54. <ul>
  55. <li>
  56. <span class="param-type">string</span>
  57. </li>
  58. </ul>
  59. <dl class="details">
  60. <dt class="tag-source">Source:</dt>
  61. <dd class="tag-source"><ul class="dummy"><li>
  62. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line51">line 51</a>
  63. </li></ul></dd>
  64. </dl>
  65. <h4 class="name" id="childNote"><span class="type-signature"></span>childNote<span class="type-signature"></span></h4>
  66. <dl class="details">
  67. <dt class="tag-source">Source:</dt>
  68. <dd class="tag-source"><ul class="dummy"><li>
  69. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line97">line 97</a>
  70. </li></ul></dd>
  71. </dl>
  72. <h4 class="name" id="isExpanded"><span class="type-signature"></span>isExpanded<span class="type-signature"> :boolean</span></h4>
  73. <h5>Type:</h5>
  74. <ul>
  75. <li>
  76. <span class="param-type">boolean</span>
  77. </li>
  78. </ul>
  79. <dl class="details">
  80. <dt class="tag-source">Source:</dt>
  81. <dd class="tag-source"><ul class="dummy"><li>
  82. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line61">line 61</a>
  83. </li></ul></dd>
  84. </dl>
  85. <h4 class="name" id="isWeak"><span class="type-signature"></span>isWeak<span class="type-signature"></span></h4>
  86. <div class="description">
  87. Branch is weak when its existence should not hinder deletion of its note.
  88. As a result, note with only weak branches should be immediately deleted.
  89. An example is shared or bookmarked clones - they are created automatically and exist for technical reasons,
  90. not as user-intended actions. From user perspective, they don't count as real clones and for the purpose
  91. of deletion should not act as a clone.
  92. </div>
  93. <dl class="details">
  94. <dt class="tag-source">Source:</dt>
  95. <dd class="tag-source"><ul class="dummy"><li>
  96. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line134">line 134</a>
  97. </li></ul></dd>
  98. </dl>
  99. <h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
  100. <h5>Type:</h5>
  101. <ul>
  102. <li>
  103. <span class="param-type">string</span>
  104. </li>
  105. </ul>
  106. <dl class="details">
  107. <dt class="tag-source">Source:</dt>
  108. <dd class="tag-source"><ul class="dummy"><li>
  109. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line53">line 53</a>
  110. </li></ul></dd>
  111. </dl>
  112. <h4 class="name" id="notePosition"><span class="type-signature"></span>notePosition<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
  113. <h5>Type:</h5>
  114. <ul>
  115. <li>
  116. <span class="param-type"><a href="global.html#int">int</a></span>
  117. </li>
  118. </ul>
  119. <dl class="details">
  120. <dt class="tag-source">Source:</dt>
  121. <dd class="tag-source"><ul class="dummy"><li>
  122. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line59">line 59</a>
  123. </li></ul></dd>
  124. </dl>
  125. <h4 class="name" id="parentNote"><span class="type-signature"></span>parentNote<span class="type-signature"></span></h4>
  126. <dl class="details">
  127. <dt class="tag-source">Source:</dt>
  128. <dd class="tag-source"><ul class="dummy"><li>
  129. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line112">line 112</a>
  130. </li></ul></dd>
  131. </dl>
  132. <h4 class="name" id="parentNoteId"><span class="type-signature"></span>parentNoteId<span class="type-signature"> :string</span></h4>
  133. <h5>Type:</h5>
  134. <ul>
  135. <li>
  136. <span class="param-type">string</span>
  137. </li>
  138. </ul>
  139. <dl class="details">
  140. <dt class="tag-source">Source:</dt>
  141. <dd class="tag-source"><ul class="dummy"><li>
  142. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line55">line 55</a>
  143. </li></ul></dd>
  144. </dl>
  145. <h4 class="name" id="prefix"><span class="type-signature"></span>prefix<span class="type-signature"> :string|null</span></h4>
  146. <h5>Type:</h5>
  147. <ul>
  148. <li>
  149. <span class="param-type">string</span>
  150. |
  151. <span class="param-type">null</span>
  152. </li>
  153. </ul>
  154. <dl class="details">
  155. <dt class="tag-source">Source:</dt>
  156. <dd class="tag-source"><ul class="dummy"><li>
  157. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line57">line 57</a>
  158. </li></ul></dd>
  159. </dl>
  160. <h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
  161. <h5>Type:</h5>
  162. <ul>
  163. <li>
  164. <span class="param-type">string</span>
  165. </li>
  166. </ul>
  167. <dl class="details">
  168. <dt class="tag-source">Source:</dt>
  169. <dd class="tag-source"><ul class="dummy"><li>
  170. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line63">line 63</a>
  171. </li></ul></dd>
  172. </dl>
  173. <h3 class="subsection-title">Methods</h3>
  174. <h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
  175. <dl class="details">
  176. <dt class="tag-overrides">Overrides:</dt>
  177. <dd class="tag-overrides"><ul class="dummy"><li>
  178. <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</a>
  179. </li></ul></dd>
  180. <dt class="tag-source">Source:</dt>
  181. <dd class="tag-source"><ul class="dummy"><li>
  182. <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#line250">line 250</a>
  183. </li></ul></dd>
  184. </dl>
  185. <h5>Returns:</h5>
  186. <dl>
  187. <dt>
  188. Type
  189. </dt>
  190. <dd>
  191. <span class="param-type">string</span>
  192. |
  193. <span class="param-type">Buffer</span>
  194. </dd>
  195. </dl>
  196. <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<span class="signature">()</span><span class="type-signature"></span></h4>
  197. <dl class="details">
  198. <dt class="tag-overrides">Overrides:</dt>
  199. <dd class="tag-overrides"><ul class="dummy"><li>
  200. <a href="AbstractBeccaEntity.html#_setContent">AbstractBeccaEntity#_setContent</a>
  201. </li></ul></dd>
  202. <dt class="tag-source">Source:</dt>
  203. <dd class="tag-source"><ul class="dummy"><li>
  204. <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>
  205. </li></ul></dd>
  206. </dl>
  207. <h4 class="name" id="beforeSaving"><span class="type-signature">(protected) </span>beforeSaving<span class="signature">()</span><span class="type-signature"></span></h4>
  208. <dl class="details">
  209. <dt class="tag-overrides">Overrides:</dt>
  210. <dd class="tag-overrides"><ul class="dummy"><li>
  211. <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
  212. </li></ul></dd>
  213. <dt class="tag-source">Source:</dt>
  214. <dd class="tag-source"><ul class="dummy"><li>
  215. <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#line20">line 20</a>
  216. </li></ul></dd>
  217. </dl>
  218. <h4 class="name" id="deleteBranch"><span class="type-signature"></span>deleteBranch<span class="signature">(deleteId<span class="signature-attributes">opt</span>, taskContext<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  219. <div class="description">
  220. Delete a branch. If this is a last note's branch, delete the note as well.
  221. </div>
  222. <h5>Parameters:</h5>
  223. <table class="params">
  224. <thead>
  225. <tr>
  226. <th>Name</th>
  227. <th>Type</th>
  228. <th>Attributes</th>
  229. <th class="last">Description</th>
  230. </tr>
  231. </thead>
  232. <tbody>
  233. <tr>
  234. <td class="name"><code>deleteId</code></td>
  235. <td class="type">
  236. <span class="param-type">string</span>
  237. </td>
  238. <td class="attributes">
  239. &lt;optional><br>
  240. </td>
  241. <td class="description last">optional delete identified</td>
  242. </tr>
  243. <tr>
  244. <td class="name"><code>taskContext</code></td>
  245. <td class="type">
  246. <span class="param-type">TaskContext</span>
  247. </td>
  248. <td class="attributes">
  249. &lt;optional><br>
  250. </td>
  251. <td class="description last"></td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <dl class="details">
  256. <dt class="tag-source">Source:</dt>
  257. <dd class="tag-source"><ul class="dummy"><li>
  258. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line146">line 146</a>
  259. </li></ul></dd>
  260. </dl>
  261. <h5>Returns:</h5>
  262. <div class="param-desc">
  263. - true if note has been deleted, false otherwise
  264. </div>
  265. <dl>
  266. <dt>
  267. Type
  268. </dt>
  269. <dd>
  270. <span class="param-type">boolean</span>
  271. </dd>
  272. </dl>
  273. <h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  274. <dl class="details">
  275. <dt class="tag-overrides">Overrides:</dt>
  276. <dd class="tag-overrides"><ul class="dummy"><li>
  277. <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
  278. </li></ul></dd>
  279. <dt class="tag-source">Source:</dt>
  280. <dd class="tag-source"><ul class="dummy"><li>
  281. <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#line59">line 59</a>
  282. </li></ul></dd>
  283. </dl>
  284. <h5>Returns:</h5>
  285. <dl>
  286. <dt>
  287. Type
  288. </dt>
  289. <dd>
  290. <span class="param-type">string</span>
  291. </dd>
  292. </dl>
  293. <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>}</span></h4>
  294. <dl class="details">
  295. <dt class="tag-source">Source:</dt>
  296. <dd class="tag-source"><ul class="dummy"><li>
  297. <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line107">line 107</a>
  298. </li></ul></dd>
  299. </dl>
  300. <h5>Returns:</h5>
  301. <dl>
  302. <dt>
  303. Type
  304. </dt>
  305. <dd>
  306. <span class="param-type"><a href="BNote.html">BNote</a></span>
  307. </dd>
  308. </dl>
  309. <h4 class="name" id="getPojo"><span class="type-signature">(abstract, protected) </span>getPojo<span class="signature">()</span><span class="type-signature"></span></h4>
  310. <dl class="details">
  311. <dt class="tag-overrides">Overrides:</dt>
  312. <dd class="tag-overrides"><ul class="dummy"><li>
  313. <a href="AbstractBeccaEntity.html#getPojo">AbstractBeccaEntity#getPojo</a>
  314. </li></ul></dd>
  315. <dt class="tag-source">Source:</dt>
  316. <dd class="tag-source"><ul class="dummy"><li>
  317. <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#line82">line 82</a>
  318. </li></ul></dd>
  319. </dl>
  320. <h4 class="name" id="getPojoToSave"><span class="type-signature">(protected) </span>getPojoToSave<span class="signature">()</span><span class="type-signature"></span></h4>
  321. <dl class="details">
  322. <dt class="tag-overrides">Overrides:</dt>
  323. <dd class="tag-overrides"><ul class="dummy"><li>
  324. <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
  325. </li></ul></dd>
  326. <dt class="tag-source">Source:</dt>
  327. <dd class="tag-source"><ul class="dummy"><li>
  328. <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>
  329. </li></ul></dd>
  330. </dl>
  331. <h4 class="name" id="getUtcDateChanged"><span class="type-signature">(protected) </span>getUtcDateChanged<span class="signature">()</span><span class="type-signature"></span></h4>
  332. <dl class="details">
  333. <dt class="tag-overrides">Overrides:</dt>
  334. <dd class="tag-overrides"><ul class="dummy"><li>
  335. <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
  336. </li></ul></dd>
  337. <dt class="tag-source">Source:</dt>
  338. <dd class="tag-source"><ul class="dummy"><li>
  339. <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#line27">line 27</a>
  340. </li></ul></dd>
  341. </dl>
  342. <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDeleted<span class="signature">(deleteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  343. <div class="description">
  344. Mark the entity as (soft) deleted. It will be completely erased later.
  345. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
  346. </div>
  347. <h5>Parameters:</h5>
  348. <table class="params">
  349. <thead>
  350. <tr>
  351. <th>Name</th>
  352. <th>Type</th>
  353. <th>Attributes</th>
  354. <th>Default</th>
  355. <th class="last">Description</th>
  356. </tr>
  357. </thead>
  358. <tbody>
  359. <tr>
  360. <td class="name"><code>deleteId</code></td>
  361. <td class="type">
  362. </td>
  363. <td class="attributes">
  364. &lt;optional><br>
  365. </td>
  366. <td class="default">
  367. null
  368. </td>
  369. <td class="description last"></td>
  370. </tr>
  371. </tbody>
  372. </table>
  373. <dl class="details">
  374. <dt class="tag-overrides">Overrides:</dt>
  375. <dd class="tag-overrides"><ul class="dummy"><li>
  376. <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
  377. </li></ul></dd>
  378. <dt class="tag-source">Source:</dt>
  379. <dd class="tag-source"><ul class="dummy"><li>
  380. <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#line267">line 267</a>
  381. </li></ul></dd>
  382. </dl>
  383. <h4 class="name" id="putEntityChange"><span class="type-signature">(protected) </span>putEntityChange<span class="signature">()</span><span class="type-signature"></span></h4>
  384. <dl class="details">
  385. <dt class="tag-overrides">Overrides:</dt>
  386. <dd class="tag-overrides"><ul class="dummy"><li>
  387. <a href="AbstractBeccaEntity.html#putEntityChange">AbstractBeccaEntity#putEntityChange</a>
  388. </li></ul></dd>
  389. <dt class="tag-source">Source:</dt>
  390. <dd class="tag-source"><ul class="dummy"><li>
  391. <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#line44">line 44</a>
  392. </li></ul></dd>
  393. </dl>
  394. <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
  395. <div class="description">
  396. Saves entity - executes SQL, but doesn't commit the transaction on its own
  397. </div>
  398. <dl class="details">
  399. <dt class="tag-overrides">Overrides:</dt>
  400. <dd class="tag-overrides"><ul class="dummy"><li>
  401. <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
  402. </li></ul></dd>
  403. <dt class="tag-source">Source:</dt>
  404. <dd class="tag-source"><ul class="dummy"><li>
  405. <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#line91">line 91</a>
  406. </li></ul></dd>
  407. </dl>
  408. <h5>Returns:</h5>
  409. <dl>
  410. <dt>
  411. Type
  412. </dt>
  413. <dd>
  414. <span class="param-type">this</span>
  415. </dd>
  416. </dl>
  417. </article>
  418. </section>
  419. </div>
  420. <nav>
  421. <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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li></ul>
  422. </nav>
  423. <br class="clear">
  424. <footer>
  425. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
  426. </footer>
  427. <script> prettyPrint(); </script>
  428. <script src="scripts/linenumber.js"> </script>
  429. </body>
  430. </html>