BRevision.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: BRevision</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: BRevision</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>BRevision<span class="signature">()</span><span class="type-signature"></span></h2>
  20. <div class="class-description">Revision represents a snapshot of note's title and content at some point in the past.
  21. It's used for seamless note versioning.</div>
  22. </header>
  23. <article>
  24. <div class="container-overview">
  25. <h2>Constructor</h2>
  26. <h4 class="name" id="BRevision"><span class="type-signature"></span>new BRevision<span class="signature">()</span><span class="type-signature"></span></h4>
  27. <dl class="details">
  28. <dt class="tag-source">Source:</dt>
  29. <dd class="tag-source"><ul class="dummy"><li>
  30. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line17">line 17</a>
  31. </li></ul></dd>
  32. </dl>
  33. </div>
  34. <h3 class="subsection-title">Extends</h3>
  35. <ul>
  36. <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
  37. </ul>
  38. <h3 class="subsection-title">Members</h3>
  39. <h4 class="name" id="becca"><span class="type-signature">(protected) </span>becca<span class="type-signature"></span></h4>
  40. <dl class="details">
  41. <dt class="tag-overrides">Overrides:</dt>
  42. <dd class="tag-overrides"><ul class="dummy"><li>
  43. <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
  44. </li></ul></dd>
  45. <dt class="tag-source">Source:</dt>
  46. <dd class="tag-source"><ul class="dummy"><li>
  47. <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>
  48. </li></ul></dd>
  49. </dl>
  50. <h4 class="name" id="blobId"><span class="type-signature"></span>blobId<span class="type-signature"> :string</span></h4>
  51. <h5>Type:</h5>
  52. <ul>
  53. <li>
  54. <span class="param-type">string</span>
  55. </li>
  56. </ul>
  57. <dl class="details">
  58. <dt class="tag-source">Source:</dt>
  59. <dd class="tag-source"><ul class="dummy"><li>
  60. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line39">line 39</a>
  61. </li></ul></dd>
  62. </dl>
  63. <h4 class="name" id="contentLength"><span class="type-signature"></span>contentLength<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
  64. <h5>Type:</h5>
  65. <ul>
  66. <li>
  67. <span class="param-type"><a href="global.html#int">int</a></span>
  68. </li>
  69. </ul>
  70. <dl class="details">
  71. <dt class="tag-source">Source:</dt>
  72. <dd class="tag-source"><ul class="dummy"><li>
  73. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line51">line 51</a>
  74. </li></ul></dd>
  75. </dl>
  76. <h4 class="name" id="dateCreated"><span class="type-signature"></span>dateCreated<span class="type-signature"> :string</span></h4>
  77. <h5>Type:</h5>
  78. <ul>
  79. <li>
  80. <span class="param-type">string</span>
  81. </li>
  82. </ul>
  83. <dl class="details">
  84. <dt class="tag-source">Source:</dt>
  85. <dd class="tag-source"><ul class="dummy"><li>
  86. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line43">line 43</a>
  87. </li></ul></dd>
  88. </dl>
  89. <h4 class="name" id="dateLastEdited"><span class="type-signature"></span>dateLastEdited<span class="type-signature"> :string</span></h4>
  90. <h5>Type:</h5>
  91. <ul>
  92. <li>
  93. <span class="param-type">string</span>
  94. </li>
  95. </ul>
  96. <dl class="details">
  97. <dt class="tag-source">Source:</dt>
  98. <dd class="tag-source"><ul class="dummy"><li>
  99. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line41">line 41</a>
  100. </li></ul></dd>
  101. </dl>
  102. <h4 class="name" id="isProtected"><span class="type-signature"></span>isProtected<span class="type-signature"> :boolean</span></h4>
  103. <h5>Type:</h5>
  104. <ul>
  105. <li>
  106. <span class="param-type">boolean</span>
  107. </li>
  108. </ul>
  109. <dl class="details">
  110. <dt class="tag-source">Source:</dt>
  111. <dd class="tag-source"><ul class="dummy"><li>
  112. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line35">line 35</a>
  113. </li></ul></dd>
  114. </dl>
  115. <h4 class="name" id="mime"><span class="type-signature"></span>mime<span class="type-signature"> :string</span></h4>
  116. <h5>Type:</h5>
  117. <ul>
  118. <li>
  119. <span class="param-type">string</span>
  120. </li>
  121. </ul>
  122. <dl class="details">
  123. <dt class="tag-source">Source:</dt>
  124. <dd class="tag-source"><ul class="dummy"><li>
  125. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line33">line 33</a>
  126. </li></ul></dd>
  127. </dl>
  128. <h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
  129. <h5>Type:</h5>
  130. <ul>
  131. <li>
  132. <span class="param-type">string</span>
  133. </li>
  134. </ul>
  135. <dl class="details">
  136. <dt class="tag-source">Source:</dt>
  137. <dd class="tag-source"><ul class="dummy"><li>
  138. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line29">line 29</a>
  139. </li></ul></dd>
  140. </dl>
  141. <h4 class="name" id="revisionId"><span class="type-signature"></span>revisionId<span class="type-signature"> :string</span></h4>
  142. <h5>Type:</h5>
  143. <ul>
  144. <li>
  145. <span class="param-type">string</span>
  146. </li>
  147. </ul>
  148. <dl class="details">
  149. <dt class="tag-source">Source:</dt>
  150. <dd class="tag-source"><ul class="dummy"><li>
  151. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line27">line 27</a>
  152. </li></ul></dd>
  153. </dl>
  154. <h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"> :string</span></h4>
  155. <h5>Type:</h5>
  156. <ul>
  157. <li>
  158. <span class="param-type">string</span>
  159. </li>
  160. </ul>
  161. <dl class="details">
  162. <dt class="tag-source">Source:</dt>
  163. <dd class="tag-source"><ul class="dummy"><li>
  164. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line37">line 37</a>
  165. </li></ul></dd>
  166. </dl>
  167. <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
  168. <h5>Type:</h5>
  169. <ul>
  170. <li>
  171. <span class="param-type">string</span>
  172. </li>
  173. </ul>
  174. <dl class="details">
  175. <dt class="tag-source">Source:</dt>
  176. <dd class="tag-source"><ul class="dummy"><li>
  177. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line31">line 31</a>
  178. </li></ul></dd>
  179. </dl>
  180. <h4 class="name" id="utcDateCreated"><span class="type-signature"></span>utcDateCreated<span class="type-signature"> :string</span></h4>
  181. <h5>Type:</h5>
  182. <ul>
  183. <li>
  184. <span class="param-type">string</span>
  185. </li>
  186. </ul>
  187. <dl class="details">
  188. <dt class="tag-source">Source:</dt>
  189. <dd class="tag-source"><ul class="dummy"><li>
  190. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line47">line 47</a>
  191. </li></ul></dd>
  192. </dl>
  193. <h4 class="name" id="utcDateLastEdited"><span class="type-signature"></span>utcDateLastEdited<span class="type-signature"> :string</span></h4>
  194. <h5>Type:</h5>
  195. <ul>
  196. <li>
  197. <span class="param-type">string</span>
  198. </li>
  199. </ul>
  200. <dl class="details">
  201. <dt class="tag-source">Source:</dt>
  202. <dd class="tag-source"><ul class="dummy"><li>
  203. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line45">line 45</a>
  204. </li></ul></dd>
  205. </dl>
  206. <h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
  207. <h5>Type:</h5>
  208. <ul>
  209. <li>
  210. <span class="param-type">string</span>
  211. </li>
  212. </ul>
  213. <dl class="details">
  214. <dt class="tag-source">Source:</dt>
  215. <dd class="tag-source"><ul class="dummy"><li>
  216. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line49">line 49</a>
  217. </li></ul></dd>
  218. </dl>
  219. <h3 class="subsection-title">Methods</h3>
  220. <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>
  221. <dl class="details">
  222. <dt class="tag-overrides">Overrides:</dt>
  223. <dd class="tag-overrides"><ul class="dummy"><li>
  224. <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</a>
  225. </li></ul></dd>
  226. <dt class="tag-source">Source:</dt>
  227. <dd class="tag-source"><ul class="dummy"><li>
  228. <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>
  229. </li></ul></dd>
  230. </dl>
  231. <h5>Returns:</h5>
  232. <dl>
  233. <dt>
  234. Type
  235. </dt>
  236. <dd>
  237. <span class="param-type">string</span>
  238. |
  239. <span class="param-type">Buffer</span>
  240. </dd>
  241. </dl>
  242. <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<span class="signature">()</span><span class="type-signature"></span></h4>
  243. <dl class="details">
  244. <dt class="tag-overrides">Overrides:</dt>
  245. <dd class="tag-overrides"><ul class="dummy"><li>
  246. <a href="AbstractBeccaEntity.html#_setContent">AbstractBeccaEntity#_setContent</a>
  247. </li></ul></dd>
  248. <dt class="tag-source">Source:</dt>
  249. <dd class="tag-source"><ul class="dummy"><li>
  250. <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>
  251. </li></ul></dd>
  252. </dl>
  253. <h4 class="name" id="beforeSaving"><span class="type-signature">(protected) </span>beforeSaving<span class="signature">()</span><span class="type-signature"></span></h4>
  254. <dl class="details">
  255. <dt class="tag-overrides">Overrides:</dt>
  256. <dd class="tag-overrides"><ul class="dummy"><li>
  257. <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
  258. </li></ul></dd>
  259. <dt class="tag-source">Source:</dt>
  260. <dd class="tag-source"><ul class="dummy"><li>
  261. <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>
  262. </li></ul></dd>
  263. </dl>
  264. <h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  265. <dl class="details">
  266. <dt class="tag-overrides">Overrides:</dt>
  267. <dd class="tag-overrides"><ul class="dummy"><li>
  268. <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
  269. </li></ul></dd>
  270. <dt class="tag-source">Source:</dt>
  271. <dd class="tag-source"><ul class="dummy"><li>
  272. <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>
  273. </li></ul></dd>
  274. </dl>
  275. <h5>Returns:</h5>
  276. <dl>
  277. <dt>
  278. Type
  279. </dt>
  280. <dd>
  281. <span class="param-type">string</span>
  282. </dd>
  283. </dl>
  284. <h4 class="name" id="getAttachmentById"><span class="type-signature"></span>getAttachmentById<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BAttachment.html">BAttachment</a>|null}</span></h4>
  285. <dl class="details">
  286. <dt class="tag-source">Source:</dt>
  287. <dd class="tag-source"><ul class="dummy"><li>
  288. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line132">line 132</a>
  289. </li></ul></dd>
  290. </dl>
  291. <h5>Returns:</h5>
  292. <dl>
  293. <dt>
  294. Type
  295. </dt>
  296. <dd>
  297. <span class="param-type"><a href="BAttachment.html">BAttachment</a></span>
  298. |
  299. <span class="param-type">null</span>
  300. </dd>
  301. </dl>
  302. <h4 class="name" id="getAttachmentByTitle"><span class="type-signature"></span>getAttachmentByTitle<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BAttachment.html">BAttachment</a>}</span></h4>
  303. <dl class="details">
  304. <dt class="tag-source">Source:</dt>
  305. <dd class="tag-source"><ul class="dummy"><li>
  306. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line159">line 159</a>
  307. </li></ul></dd>
  308. </dl>
  309. <h5>Returns:</h5>
  310. <dl>
  311. <dt>
  312. Type
  313. </dt>
  314. <dd>
  315. <span class="param-type"><a href="BAttachment.html">BAttachment</a></span>
  316. </dd>
  317. </dl>
  318. <h4 class="name" id="getAttachments"><span class="type-signature"></span>getAttachments<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BAttachment.html">BAttachment</a>>}</span></h4>
  319. <dl class="details">
  320. <dt class="tag-source">Source:</dt>
  321. <dd class="tag-source"><ul class="dummy"><li>
  322. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line122">line 122</a>
  323. </li></ul></dd>
  324. </dl>
  325. <h5>Returns:</h5>
  326. <dl>
  327. <dt>
  328. Type
  329. </dt>
  330. <dd>
  331. <span class="param-type">Array.&lt;<a href="BAttachment.html">BAttachment</a>></span>
  332. </dd>
  333. </dl>
  334. <h4 class="name" id="getAttachmentsByRole"><span class="type-signature"></span>getAttachmentsByRole<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BAttachment.html">BAttachment</a>>}</span></h4>
  335. <dl class="details">
  336. <dt class="tag-source">Source:</dt>
  337. <dd class="tag-source"><ul class="dummy"><li>
  338. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line147">line 147</a>
  339. </li></ul></dd>
  340. </dl>
  341. <h5>Returns:</h5>
  342. <dl>
  343. <dt>
  344. Type
  345. </dt>
  346. <dd>
  347. <span class="param-type">Array.&lt;<a href="BAttachment.html">BAttachment</a>></span>
  348. </dd>
  349. </dl>
  350. <h4 class="name" id="getContent"><span class="type-signature"></span>getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
  351. <dl class="details">
  352. <dt class="tag-source">Source:</dt>
  353. <dd class="tag-source"><ul class="dummy"><li>
  354. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line85">line 85</a>
  355. </li></ul></dd>
  356. </dl>
  357. <h5>Returns:</h5>
  358. <dl>
  359. <dt>
  360. Type
  361. </dt>
  362. <dd>
  363. <span class="param-type">string</span>
  364. |
  365. <span class="param-type">Buffer</span>
  366. </dd>
  367. </dl>
  368. <h4 class="name" id="getJsonContent"><span class="type-signature"></span>getJsonContent<span class="signature">()</span><span class="type-signature"> &rarr; {*}</span></h4>
  369. <dl class="details">
  370. <dt class="tag-source">Source:</dt>
  371. <dd class="tag-source"><ul class="dummy"><li>
  372. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line92">line 92</a>
  373. </li></ul></dd>
  374. </dl>
  375. <h5>Throws:</h5>
  376. <div class="param-desc">
  377. Error in case of invalid JSON
  378. </div>
  379. <h5>Returns:</h5>
  380. <dl>
  381. <dt>
  382. Type
  383. </dt>
  384. <dd>
  385. <span class="param-type">*</span>
  386. </dd>
  387. </dl>
  388. <h4 class="name" id="getJsonContentSafely"><span class="type-signature"></span>getJsonContentSafely<span class="signature">()</span><span class="type-signature"> &rarr; {*|null}</span></h4>
  389. <dl class="details">
  390. <dt class="tag-source">Source:</dt>
  391. <dd class="tag-source"><ul class="dummy"><li>
  392. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line103">line 103</a>
  393. </li></ul></dd>
  394. </dl>
  395. <h5>Returns:</h5>
  396. <div class="param-desc">
  397. valid object or null if the content cannot be parsed as JSON
  398. </div>
  399. <dl>
  400. <dt>
  401. Type
  402. </dt>
  403. <dd>
  404. <span class="param-type">*</span>
  405. |
  406. <span class="param-type">null</span>
  407. </dd>
  408. </dl>
  409. <h4 class="name" id="getPojo"><span class="type-signature">(abstract, protected) </span>getPojo<span class="signature">()</span><span class="type-signature"></span></h4>
  410. <dl class="details">
  411. <dt class="tag-overrides">Overrides:</dt>
  412. <dd class="tag-overrides"><ul class="dummy"><li>
  413. <a href="AbstractBeccaEntity.html#getPojo">AbstractBeccaEntity#getPojo</a>
  414. </li></ul></dd>
  415. <dt class="tag-source">Source:</dt>
  416. <dd class="tag-source"><ul class="dummy"><li>
  417. <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>
  418. </li></ul></dd>
  419. </dl>
  420. <h4 class="name" id="getPojoToSave"><span class="type-signature">(protected) </span>getPojoToSave<span class="signature">()</span><span class="type-signature"></span></h4>
  421. <dl class="details">
  422. <dt class="tag-overrides">Overrides:</dt>
  423. <dd class="tag-overrides"><ul class="dummy"><li>
  424. <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
  425. </li></ul></dd>
  426. <dt class="tag-source">Source:</dt>
  427. <dd class="tag-source"><ul class="dummy"><li>
  428. <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>
  429. </li></ul></dd>
  430. </dl>
  431. <h4 class="name" id="getUtcDateChanged"><span class="type-signature">(protected) </span>getUtcDateChanged<span class="signature">()</span><span class="type-signature"></span></h4>
  432. <dl class="details">
  433. <dt class="tag-overrides">Overrides:</dt>
  434. <dd class="tag-overrides"><ul class="dummy"><li>
  435. <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
  436. </li></ul></dd>
  437. <dt class="tag-source">Source:</dt>
  438. <dd class="tag-source"><ul class="dummy"><li>
  439. <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>
  440. </li></ul></dd>
  441. </dl>
  442. <h4 class="name" id="hasStringContent"><span class="type-signature"></span>hasStringContent<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  443. <dl class="details">
  444. <dt class="tag-source">Source:</dt>
  445. <dd class="tag-source"><ul class="dummy"><li>
  446. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line65">line 65</a>
  447. </li></ul></dd>
  448. </dl>
  449. <h5>Returns:</h5>
  450. <div class="param-desc">
  451. true if the note has string content (not binary)
  452. </div>
  453. <dl>
  454. <dt>
  455. Type
  456. </dt>
  457. <dd>
  458. <span class="param-type">boolean</span>
  459. </dd>
  460. </dl>
  461. <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>
  462. <div class="description">
  463. Mark the entity as (soft) deleted. It will be completely erased later.
  464. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
  465. </div>
  466. <h5>Parameters:</h5>
  467. <table class="params">
  468. <thead>
  469. <tr>
  470. <th>Name</th>
  471. <th>Type</th>
  472. <th>Attributes</th>
  473. <th>Default</th>
  474. <th class="last">Description</th>
  475. </tr>
  476. </thead>
  477. <tbody>
  478. <tr>
  479. <td class="name"><code>deleteId</code></td>
  480. <td class="type">
  481. </td>
  482. <td class="attributes">
  483. &lt;optional><br>
  484. </td>
  485. <td class="default">
  486. null
  487. </td>
  488. <td class="description last"></td>
  489. </tr>
  490. </tbody>
  491. </table>
  492. <dl class="details">
  493. <dt class="tag-overrides">Overrides:</dt>
  494. <dd class="tag-overrides"><ul class="dummy"><li>
  495. <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
  496. </li></ul></dd>
  497. <dt class="tag-source">Source:</dt>
  498. <dd class="tag-source"><ul class="dummy"><li>
  499. <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>
  500. </li></ul></dd>
  501. </dl>
  502. <h4 class="name" id="putEntityChange"><span class="type-signature">(protected) </span>putEntityChange<span class="signature">()</span><span class="type-signature"></span></h4>
  503. <dl class="details">
  504. <dt class="tag-overrides">Overrides:</dt>
  505. <dd class="tag-overrides"><ul class="dummy"><li>
  506. <a href="AbstractBeccaEntity.html#putEntityChange">AbstractBeccaEntity#putEntityChange</a>
  507. </li></ul></dd>
  508. <dt class="tag-source">Source:</dt>
  509. <dd class="tag-source"><ul class="dummy"><li>
  510. <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>
  511. </li></ul></dd>
  512. </dl>
  513. <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
  514. <div class="description">
  515. Saves entity - executes SQL, but doesn't commit the transaction on its own
  516. </div>
  517. <dl class="details">
  518. <dt class="tag-overrides">Overrides:</dt>
  519. <dd class="tag-overrides"><ul class="dummy"><li>
  520. <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
  521. </li></ul></dd>
  522. <dt class="tag-source">Source:</dt>
  523. <dd class="tag-source"><ul class="dummy"><li>
  524. <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>
  525. </li></ul></dd>
  526. </dl>
  527. <h5>Returns:</h5>
  528. <dl>
  529. <dt>
  530. Type
  531. </dt>
  532. <dd>
  533. <span class="param-type">this</span>
  534. </dd>
  535. </dl>
  536. <h4 class="name" id="setContent"><span class="type-signature"></span>setContent<span class="signature">(content, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  537. <h5>Parameters:</h5>
  538. <table class="params">
  539. <thead>
  540. <tr>
  541. <th>Name</th>
  542. <th>Type</th>
  543. <th>Attributes</th>
  544. <th class="last">Description</th>
  545. </tr>
  546. </thead>
  547. <tbody>
  548. <tr>
  549. <td class="name"><code>content</code></td>
  550. <td class="type">
  551. </td>
  552. <td class="attributes">
  553. </td>
  554. <td class="description last"></td>
  555. </tr>
  556. <tr>
  557. <td class="name"><code>opts</code></td>
  558. <td class="type">
  559. <span class="param-type">object</span>
  560. </td>
  561. <td class="attributes">
  562. &lt;optional><br>
  563. </td>
  564. <td class="description last">
  565. <h6>Properties</h6>
  566. <table class="params">
  567. <thead>
  568. <tr>
  569. <th>Name</th>
  570. <th>Type</th>
  571. <th>Attributes</th>
  572. <th>Default</th>
  573. <th class="last">Description</th>
  574. </tr>
  575. </thead>
  576. <tbody>
  577. <tr>
  578. <td class="name"><code>forceSave</code></td>
  579. <td class="type">
  580. <span class="param-type">object</span>
  581. </td>
  582. <td class="attributes">
  583. &lt;optional><br>
  584. </td>
  585. <td class="default">
  586. false
  587. </td>
  588. <td class="description last">will also save this BRevision entity</td>
  589. </tr>
  590. </tbody>
  591. </table>
  592. </td>
  593. </tr>
  594. </tbody>
  595. </table>
  596. <dl class="details">
  597. <dt class="tag-source">Source:</dt>
  598. <dd class="tag-source"><ul class="dummy"><li>
  599. <a href="becca_entities_brevision.js.html">becca/entities/brevision.js</a>, <a href="becca_entities_brevision.js.html#line117">line 117</a>
  600. </li></ul></dd>
  601. </dl>
  602. </article>
  603. </section>
  604. </div>
  605. <nav>
  606. <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>
  607. </nav>
  608. <br class="clear">
  609. <footer>
  610. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
  611. </footer>
  612. <script> prettyPrint(); </script>
  613. <script src="scripts/linenumber.js"> </script>
  614. </body>
  615. </html>