BRecentNote.html 16 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: BRecentNote</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: BRecentNote</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>BRecentNote<span class="signature">()</span><span class="type-signature"></span></h2>
  20. <div class="class-description">RecentNote represents recently visited note.</div>
  21. </header>
  22. <article>
  23. <div class="container-overview">
  24. <h2>Constructor</h2>
  25. <h4 class="name" id="BRecentNote"><span class="type-signature"></span>new BRecentNote<span class="signature">()</span><span class="type-signature"></span></h4>
  26. <dl class="details">
  27. <dt class="tag-source">Source:</dt>
  28. <dd class="tag-source"><ul class="dummy"><li>
  29. <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>
  30. </li></ul></dd>
  31. </dl>
  32. </div>
  33. <h3 class="subsection-title">Extends</h3>
  34. <ul>
  35. <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
  36. </ul>
  37. <h3 class="subsection-title">Members</h3>
  38. <h4 class="name" id="becca"><span class="type-signature">(protected) </span>becca<span class="type-signature"></span></h4>
  39. <dl class="details">
  40. <dt class="tag-overrides">Overrides:</dt>
  41. <dd class="tag-overrides"><ul class="dummy"><li>
  42. <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
  43. </li></ul></dd>
  44. <dt class="tag-source">Source:</dt>
  45. <dd class="tag-source"><ul class="dummy"><li>
  46. <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>
  47. </li></ul></dd>
  48. </dl>
  49. <h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
  50. <h5>Type:</h5>
  51. <ul>
  52. <li>
  53. <span class="param-type">string</span>
  54. </li>
  55. </ul>
  56. <dl class="details">
  57. <dt class="tag-source">Source:</dt>
  58. <dd class="tag-source"><ul class="dummy"><li>
  59. <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>
  60. </li></ul></dd>
  61. </dl>
  62. <h4 class="name" id="notePath"><span class="type-signature"></span>notePath<span class="type-signature"> :string</span></h4>
  63. <h5>Type:</h5>
  64. <ul>
  65. <li>
  66. <span class="param-type">string</span>
  67. </li>
  68. </ul>
  69. <dl class="details">
  70. <dt class="tag-source">Source:</dt>
  71. <dd class="tag-source"><ul class="dummy"><li>
  72. <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>
  73. </li></ul></dd>
  74. </dl>
  75. <h4 class="name" id="utcDateCreated"><span class="type-signature"></span>utcDateCreated<span class="type-signature"> :string</span></h4>
  76. <h5>Type:</h5>
  77. <ul>
  78. <li>
  79. <span class="param-type">string</span>
  80. </li>
  81. </ul>
  82. <dl class="details">
  83. <dt class="tag-source">Source:</dt>
  84. <dd class="tag-source"><ul class="dummy"><li>
  85. <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>
  86. </li></ul></dd>
  87. </dl>
  88. <h3 class="subsection-title">Methods</h3>
  89. <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>
  90. <dl class="details">
  91. <dt class="tag-overrides">Overrides:</dt>
  92. <dd class="tag-overrides"><ul class="dummy"><li>
  93. <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</a>
  94. </li></ul></dd>
  95. <dt class="tag-source">Source:</dt>
  96. <dd class="tag-source"><ul class="dummy"><li>
  97. <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>
  98. </li></ul></dd>
  99. </dl>
  100. <h5>Returns:</h5>
  101. <dl>
  102. <dt>
  103. Type
  104. </dt>
  105. <dd>
  106. <span class="param-type">string</span>
  107. |
  108. <span class="param-type">Buffer</span>
  109. </dd>
  110. </dl>
  111. <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<span class="signature">()</span><span class="type-signature"></span></h4>
  112. <dl class="details">
  113. <dt class="tag-overrides">Overrides:</dt>
  114. <dd class="tag-overrides"><ul class="dummy"><li>
  115. <a href="AbstractBeccaEntity.html#_setContent">AbstractBeccaEntity#_setContent</a>
  116. </li></ul></dd>
  117. <dt class="tag-source">Source:</dt>
  118. <dd class="tag-source"><ul class="dummy"><li>
  119. <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>
  120. </li></ul></dd>
  121. </dl>
  122. <h4 class="name" id="beforeSaving"><span class="type-signature">(protected) </span>beforeSaving<span class="signature">()</span><span class="type-signature"></span></h4>
  123. <dl class="details">
  124. <dt class="tag-overrides">Overrides:</dt>
  125. <dd class="tag-overrides"><ul class="dummy"><li>
  126. <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
  127. </li></ul></dd>
  128. <dt class="tag-source">Source:</dt>
  129. <dd class="tag-source"><ul class="dummy"><li>
  130. <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>
  131. </li></ul></dd>
  132. </dl>
  133. <h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  134. <dl class="details">
  135. <dt class="tag-overrides">Overrides:</dt>
  136. <dd class="tag-overrides"><ul class="dummy"><li>
  137. <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
  138. </li></ul></dd>
  139. <dt class="tag-source">Source:</dt>
  140. <dd class="tag-source"><ul class="dummy"><li>
  141. <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>
  142. </li></ul></dd>
  143. </dl>
  144. <h5>Returns:</h5>
  145. <dl>
  146. <dt>
  147. Type
  148. </dt>
  149. <dd>
  150. <span class="param-type">string</span>
  151. </dd>
  152. </dl>
  153. <h4 class="name" id="getPojo"><span class="type-signature">(abstract, protected) </span>getPojo<span class="signature">()</span><span class="type-signature"></span></h4>
  154. <dl class="details">
  155. <dt class="tag-overrides">Overrides:</dt>
  156. <dd class="tag-overrides"><ul class="dummy"><li>
  157. <a href="AbstractBeccaEntity.html#getPojo">AbstractBeccaEntity#getPojo</a>
  158. </li></ul></dd>
  159. <dt class="tag-source">Source:</dt>
  160. <dd class="tag-source"><ul class="dummy"><li>
  161. <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>
  162. </li></ul></dd>
  163. </dl>
  164. <h4 class="name" id="getPojoToSave"><span class="type-signature">(protected) </span>getPojoToSave<span class="signature">()</span><span class="type-signature"></span></h4>
  165. <dl class="details">
  166. <dt class="tag-overrides">Overrides:</dt>
  167. <dd class="tag-overrides"><ul class="dummy"><li>
  168. <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
  169. </li></ul></dd>
  170. <dt class="tag-source">Source:</dt>
  171. <dd class="tag-source"><ul class="dummy"><li>
  172. <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>
  173. </li></ul></dd>
  174. </dl>
  175. <h4 class="name" id="getUtcDateChanged"><span class="type-signature">(protected) </span>getUtcDateChanged<span class="signature">()</span><span class="type-signature"></span></h4>
  176. <dl class="details">
  177. <dt class="tag-overrides">Overrides:</dt>
  178. <dd class="tag-overrides"><ul class="dummy"><li>
  179. <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
  180. </li></ul></dd>
  181. <dt class="tag-source">Source:</dt>
  182. <dd class="tag-source"><ul class="dummy"><li>
  183. <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>
  184. </li></ul></dd>
  185. </dl>
  186. <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>
  187. <div class="description">
  188. Mark the entity as (soft) deleted. It will be completely erased later.
  189. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
  190. </div>
  191. <h5>Parameters:</h5>
  192. <table class="params">
  193. <thead>
  194. <tr>
  195. <th>Name</th>
  196. <th>Type</th>
  197. <th>Attributes</th>
  198. <th>Default</th>
  199. <th class="last">Description</th>
  200. </tr>
  201. </thead>
  202. <tbody>
  203. <tr>
  204. <td class="name"><code>deleteId</code></td>
  205. <td class="type">
  206. </td>
  207. <td class="attributes">
  208. &lt;optional><br>
  209. </td>
  210. <td class="default">
  211. null
  212. </td>
  213. <td class="description last"></td>
  214. </tr>
  215. </tbody>
  216. </table>
  217. <dl class="details">
  218. <dt class="tag-overrides">Overrides:</dt>
  219. <dd class="tag-overrides"><ul class="dummy"><li>
  220. <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
  221. </li></ul></dd>
  222. <dt class="tag-source">Source:</dt>
  223. <dd class="tag-source"><ul class="dummy"><li>
  224. <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>
  225. </li></ul></dd>
  226. </dl>
  227. <h4 class="name" id="putEntityChange"><span class="type-signature">(protected) </span>putEntityChange<span class="signature">()</span><span class="type-signature"></span></h4>
  228. <dl class="details">
  229. <dt class="tag-overrides">Overrides:</dt>
  230. <dd class="tag-overrides"><ul class="dummy"><li>
  231. <a href="AbstractBeccaEntity.html#putEntityChange">AbstractBeccaEntity#putEntityChange</a>
  232. </li></ul></dd>
  233. <dt class="tag-source">Source:</dt>
  234. <dd class="tag-source"><ul class="dummy"><li>
  235. <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>
  236. </li></ul></dd>
  237. </dl>
  238. <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
  239. <div class="description">
  240. Saves entity - executes SQL, but doesn't commit the transaction on its own
  241. </div>
  242. <dl class="details">
  243. <dt class="tag-overrides">Overrides:</dt>
  244. <dd class="tag-overrides"><ul class="dummy"><li>
  245. <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
  246. </li></ul></dd>
  247. <dt class="tag-source">Source:</dt>
  248. <dd class="tag-source"><ul class="dummy"><li>
  249. <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>
  250. </li></ul></dd>
  251. </dl>
  252. <h5>Returns:</h5>
  253. <dl>
  254. <dt>
  255. Type
  256. </dt>
  257. <dd>
  258. <span class="param-type">this</span>
  259. </dd>
  260. </dl>
  261. </article>
  262. </section>
  263. </div>
  264. <nav>
  265. <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>
  266. </nav>
  267. <br class="clear">
  268. <footer>
  269. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
  270. </footer>
  271. <script> prettyPrint(); </script>
  272. <script src="scripts/linenumber.js"> </script>
  273. </body>
  274. </html>