BAttachment.html 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: BAttachment</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: BAttachment</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>BAttachment<span class="signature">()</span><span class="type-signature"></span></h2>
  20. <div class="class-description">Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for
  21. larger amounts of data and generally not accessible to the user.</div>
  22. </header>
  23. <article>
  24. <div class="container-overview">
  25. <h2>Constructor</h2>
  26. <h4 class="name" id="BAttachment"><span class="type-signature"></span>new BAttachment<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_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line20">line 20</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="attachmentId"><span class="type-signature"></span>attachmentId<span class="type-signature"> :string</span></h4>
  40. <h5>Type:</h5>
  41. <ul>
  42. <li>
  43. <span class="param-type">string</span>
  44. </li>
  45. </ul>
  46. <dl class="details">
  47. <dt class="tag-source">Source:</dt>
  48. <dd class="tag-source"><ul class="dummy"><li>
  49. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line39">line 39</a>
  50. </li></ul></dd>
  51. </dl>
  52. <h4 class="name" id="becca"><span class="type-signature">(protected) </span>becca<span class="type-signature"></span></h4>
  53. <dl class="details">
  54. <dt class="tag-overrides">Overrides:</dt>
  55. <dd class="tag-overrides"><ul class="dummy"><li>
  56. <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
  57. </li></ul></dd>
  58. <dt class="tag-source">Source:</dt>
  59. <dd class="tag-source"><ul class="dummy"><li>
  60. <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>
  61. </li></ul></dd>
  62. </dl>
  63. <h4 class="name" id="blobId"><span class="type-signature"></span>blobId<span class="type-signature"> :string</span></h4>
  64. <h5>Type:</h5>
  65. <ul>
  66. <li>
  67. <span class="param-type">string</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_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line54">line 54</a>
  74. </li></ul></dd>
  75. </dl>
  76. <h4 class="name" id="contentLength"><span class="type-signature"></span>contentLength<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
  77. <div class="description">
  78. optionally added to the entity
  79. </div>
  80. <h5>Type:</h5>
  81. <ul>
  82. <li>
  83. <span class="param-type"><a href="global.html#int">int</a></span>
  84. </li>
  85. </ul>
  86. <dl class="details">
  87. <dt class="tag-source">Source:</dt>
  88. <dd class="tag-source"><ul class="dummy"><li>
  89. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line68">line 68</a>
  90. </li></ul></dd>
  91. </dl>
  92. <h4 class="name" id="dateModified"><span class="type-signature"></span>dateModified<span class="type-signature"> :string</span></h4>
  93. <h5>Type:</h5>
  94. <ul>
  95. <li>
  96. <span class="param-type">string</span>
  97. </li>
  98. </ul>
  99. <dl class="details">
  100. <dt class="tag-source">Source:</dt>
  101. <dd class="tag-source"><ul class="dummy"><li>
  102. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line58">line 58</a>
  103. </li></ul></dd>
  104. </dl>
  105. <h4 class="name" id="isProtected"><span class="type-signature"></span>isProtected<span class="type-signature"> :boolean</span></h4>
  106. <h5>Type:</h5>
  107. <ul>
  108. <li>
  109. <span class="param-type">boolean</span>
  110. </li>
  111. </ul>
  112. <dl class="details">
  113. <dt class="tag-source">Source:</dt>
  114. <dd class="tag-source"><ul class="dummy"><li>
  115. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line56">line 56</a>
  116. </li></ul></dd>
  117. </dl>
  118. <h4 class="name" id="mime"><span class="type-signature"></span>mime<span class="type-signature"> :string</span></h4>
  119. <h5>Type:</h5>
  120. <ul>
  121. <li>
  122. <span class="param-type">string</span>
  123. </li>
  124. </ul>
  125. <dl class="details">
  126. <dt class="tag-source">Source:</dt>
  127. <dd class="tag-source"><ul class="dummy"><li>
  128. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line48">line 48</a>
  129. </li></ul></dd>
  130. </dl>
  131. <h4 class="name" id="ownerId"><span class="type-signature"></span>ownerId<span class="type-signature"> :string</span></h4>
  132. <div class="description">
  133. either noteId or revisionId to which this attachment belongs
  134. </div>
  135. <h5>Type:</h5>
  136. <ul>
  137. <li>
  138. <span class="param-type">string</span>
  139. </li>
  140. </ul>
  141. <dl class="details">
  142. <dt class="tag-source">Source:</dt>
  143. <dd class="tag-source"><ul class="dummy"><li>
  144. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line44">line 44</a>
  145. </li></ul></dd>
  146. </dl>
  147. <h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :<a href="global.html#int">int</a></span></h4>
  148. <h5>Type:</h5>
  149. <ul>
  150. <li>
  151. <span class="param-type"><a href="global.html#int">int</a></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_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line52">line 52</a>
  158. </li></ul></dd>
  159. </dl>
  160. <h4 class="name" id="role"><span class="type-signature"></span>role<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_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line46">line 46</a>
  171. </li></ul></dd>
  172. </dl>
  173. <h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"> :string</span></h4>
  174. <h5>Type:</h5>
  175. <ul>
  176. <li>
  177. <span class="param-type">string</span>
  178. </li>
  179. </ul>
  180. <dl class="details">
  181. <dt class="tag-source">Source:</dt>
  182. <dd class="tag-source"><ul class="dummy"><li>
  183. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line50">line 50</a>
  184. </li></ul></dd>
  185. </dl>
  186. <h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
  187. <h5>Type:</h5>
  188. <ul>
  189. <li>
  190. <span class="param-type">string</span>
  191. </li>
  192. </ul>
  193. <dl class="details">
  194. <dt class="tag-source">Source:</dt>
  195. <dd class="tag-source"><ul class="dummy"><li>
  196. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line60">line 60</a>
  197. </li></ul></dd>
  198. </dl>
  199. <h4 class="name" id="utcDateScheduledForErasureSince"><span class="type-signature"></span>utcDateScheduledForErasureSince<span class="type-signature"> :string</span></h4>
  200. <h5>Type:</h5>
  201. <ul>
  202. <li>
  203. <span class="param-type">string</span>
  204. </li>
  205. </ul>
  206. <dl class="details">
  207. <dt class="tag-source">Source:</dt>
  208. <dd class="tag-source"><ul class="dummy"><li>
  209. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line62">line 62</a>
  210. </li></ul></dd>
  211. </dl>
  212. <h3 class="subsection-title">Methods</h3>
  213. <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>
  214. <dl class="details">
  215. <dt class="tag-overrides">Overrides:</dt>
  216. <dd class="tag-overrides"><ul class="dummy"><li>
  217. <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</a>
  218. </li></ul></dd>
  219. <dt class="tag-source">Source:</dt>
  220. <dd class="tag-source"><ul class="dummy"><li>
  221. <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>
  222. </li></ul></dd>
  223. </dl>
  224. <h5>Returns:</h5>
  225. <dl>
  226. <dt>
  227. Type
  228. </dt>
  229. <dd>
  230. <span class="param-type">string</span>
  231. |
  232. <span class="param-type">Buffer</span>
  233. </dd>
  234. </dl>
  235. <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<span class="signature">()</span><span class="type-signature"></span></h4>
  236. <dl class="details">
  237. <dt class="tag-overrides">Overrides:</dt>
  238. <dd class="tag-overrides"><ul class="dummy"><li>
  239. <a href="AbstractBeccaEntity.html#_setContent">AbstractBeccaEntity#_setContent</a>
  240. </li></ul></dd>
  241. <dt class="tag-source">Source:</dt>
  242. <dd class="tag-source"><ul class="dummy"><li>
  243. <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>
  244. </li></ul></dd>
  245. </dl>
  246. <h4 class="name" id="beforeSaving"><span class="type-signature">(protected) </span>beforeSaving<span class="signature">()</span><span class="type-signature"></span></h4>
  247. <dl class="details">
  248. <dt class="tag-overrides">Overrides:</dt>
  249. <dd class="tag-overrides"><ul class="dummy"><li>
  250. <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
  251. </li></ul></dd>
  252. <dt class="tag-source">Source:</dt>
  253. <dd class="tag-source"><ul class="dummy"><li>
  254. <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>
  255. </li></ul></dd>
  256. </dl>
  257. <h4 class="name" id="convertToNote"><span class="type-signature"></span>convertToNote<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
  258. <dl class="details">
  259. <dt class="tag-source">Source:</dt>
  260. <dd class="tag-source"><ul class="dummy"><li>
  261. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line138">line 138</a>
  262. </li></ul></dd>
  263. </dl>
  264. <h5>Returns:</h5>
  265. <dl>
  266. <dt>
  267. Type
  268. </dt>
  269. <dd>
  270. <span class="param-type">Object</span>
  271. </dd>
  272. </dl>
  273. <h4 class="name" id="copy"><span class="type-signature"></span>copy<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BAttachment.html">BAttachment</a>}</span></h4>
  274. <dl class="details">
  275. <dt class="tag-source">Source:</dt>
  276. <dd class="tag-source"><ul class="dummy"><li>
  277. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line74">line 74</a>
  278. </li></ul></dd>
  279. </dl>
  280. <h5>Returns:</h5>
  281. <dl>
  282. <dt>
  283. Type
  284. </dt>
  285. <dd>
  286. <span class="param-type"><a href="BAttachment.html">BAttachment</a></span>
  287. </dd>
  288. </dl>
  289. <h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  290. <dl class="details">
  291. <dt class="tag-overrides">Overrides:</dt>
  292. <dd class="tag-overrides"><ul class="dummy"><li>
  293. <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
  294. </li></ul></dd>
  295. <dt class="tag-source">Source:</dt>
  296. <dd class="tag-source"><ul class="dummy"><li>
  297. <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>
  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">string</span>
  307. </dd>
  308. </dl>
  309. <h4 class="name" id="getContent"><span class="type-signature"></span>getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
  310. <dl class="details">
  311. <dt class="tag-source">Source:</dt>
  312. <dd class="tag-source"><ul class="dummy"><li>
  313. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line123">line 123</a>
  314. </li></ul></dd>
  315. </dl>
  316. <h5>Returns:</h5>
  317. <dl>
  318. <dt>
  319. Type
  320. </dt>
  321. <dd>
  322. <span class="param-type">string</span>
  323. |
  324. <span class="param-type">Buffer</span>
  325. </dd>
  326. </dl>
  327. <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>
  328. <dl class="details">
  329. <dt class="tag-source">Source:</dt>
  330. <dd class="tag-source"><ul class="dummy"><li>
  331. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line86">line 86</a>
  332. </li></ul></dd>
  333. </dl>
  334. <h5>Returns:</h5>
  335. <dl>
  336. <dt>
  337. Type
  338. </dt>
  339. <dd>
  340. <span class="param-type"><a href="BNote.html">BNote</a></span>
  341. </dd>
  342. </dl>
  343. <h4 class="name" id="getPojo"><span class="type-signature">(abstract, protected) </span>getPojo<span class="signature">()</span><span class="type-signature"></span></h4>
  344. <dl class="details">
  345. <dt class="tag-overrides">Overrides:</dt>
  346. <dd class="tag-overrides"><ul class="dummy"><li>
  347. <a href="AbstractBeccaEntity.html#getPojo">AbstractBeccaEntity#getPojo</a>
  348. </li></ul></dd>
  349. <dt class="tag-source">Source:</dt>
  350. <dd class="tag-source"><ul class="dummy"><li>
  351. <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>
  352. </li></ul></dd>
  353. </dl>
  354. <h4 class="name" id="getPojoToSave"><span class="type-signature">(protected) </span>getPojoToSave<span class="signature">()</span><span class="type-signature"></span></h4>
  355. <dl class="details">
  356. <dt class="tag-overrides">Overrides:</dt>
  357. <dd class="tag-overrides"><ul class="dummy"><li>
  358. <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
  359. </li></ul></dd>
  360. <dt class="tag-source">Source:</dt>
  361. <dd class="tag-source"><ul class="dummy"><li>
  362. <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>
  363. </li></ul></dd>
  364. </dl>
  365. <h4 class="name" id="getUtcDateChanged"><span class="type-signature">(protected) </span>getUtcDateChanged<span class="signature">()</span><span class="type-signature"></span></h4>
  366. <dl class="details">
  367. <dt class="tag-overrides">Overrides:</dt>
  368. <dd class="tag-overrides"><ul class="dummy"><li>
  369. <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
  370. </li></ul></dd>
  371. <dt class="tag-source">Source:</dt>
  372. <dd class="tag-source"><ul class="dummy"><li>
  373. <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>
  374. </li></ul></dd>
  375. </dl>
  376. <h4 class="name" id="hasStringContent"><span class="type-signature"></span>hasStringContent<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  377. <dl class="details">
  378. <dt class="tag-source">Source:</dt>
  379. <dd class="tag-source"><ul class="dummy"><li>
  380. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line91">line 91</a>
  381. </li></ul></dd>
  382. </dl>
  383. <h5>Returns:</h5>
  384. <div class="param-desc">
  385. true if the note has string content (not binary)
  386. </div>
  387. <dl>
  388. <dt>
  389. Type
  390. </dt>
  391. <dd>
  392. <span class="param-type">boolean</span>
  393. </dd>
  394. </dl>
  395. <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>
  396. <div class="description">
  397. Mark the entity as (soft) deleted. It will be completely erased later.
  398. This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
  399. </div>
  400. <h5>Parameters:</h5>
  401. <table class="params">
  402. <thead>
  403. <tr>
  404. <th>Name</th>
  405. <th>Type</th>
  406. <th>Attributes</th>
  407. <th>Default</th>
  408. <th class="last">Description</th>
  409. </tr>
  410. </thead>
  411. <tbody>
  412. <tr>
  413. <td class="name"><code>deleteId</code></td>
  414. <td class="type">
  415. </td>
  416. <td class="attributes">
  417. &lt;optional><br>
  418. </td>
  419. <td class="default">
  420. null
  421. </td>
  422. <td class="description last"></td>
  423. </tr>
  424. </tbody>
  425. </table>
  426. <dl class="details">
  427. <dt class="tag-overrides">Overrides:</dt>
  428. <dd class="tag-overrides"><ul class="dummy"><li>
  429. <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
  430. </li></ul></dd>
  431. <dt class="tag-source">Source:</dt>
  432. <dd class="tag-source"><ul class="dummy"><li>
  433. <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>
  434. </li></ul></dd>
  435. </dl>
  436. <h4 class="name" id="putEntityChange"><span class="type-signature">(protected) </span>putEntityChange<span class="signature">()</span><span class="type-signature"></span></h4>
  437. <dl class="details">
  438. <dt class="tag-overrides">Overrides:</dt>
  439. <dd class="tag-overrides"><ul class="dummy"><li>
  440. <a href="AbstractBeccaEntity.html#putEntityChange">AbstractBeccaEntity#putEntityChange</a>
  441. </li></ul></dd>
  442. <dt class="tag-source">Source:</dt>
  443. <dd class="tag-source"><ul class="dummy"><li>
  444. <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>
  445. </li></ul></dd>
  446. </dl>
  447. <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
  448. <div class="description">
  449. Saves entity - executes SQL, but doesn't commit the transaction on its own
  450. </div>
  451. <dl class="details">
  452. <dt class="tag-overrides">Overrides:</dt>
  453. <dd class="tag-overrides"><ul class="dummy"><li>
  454. <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
  455. </li></ul></dd>
  456. <dt class="tag-source">Source:</dt>
  457. <dd class="tag-source"><ul class="dummy"><li>
  458. <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>
  459. </li></ul></dd>
  460. </dl>
  461. <h5>Returns:</h5>
  462. <dl>
  463. <dt>
  464. Type
  465. </dt>
  466. <dd>
  467. <span class="param-type">this</span>
  468. </dd>
  469. </dl>
  470. <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>
  471. <h5>Parameters:</h5>
  472. <table class="params">
  473. <thead>
  474. <tr>
  475. <th>Name</th>
  476. <th>Type</th>
  477. <th>Attributes</th>
  478. <th class="last">Description</th>
  479. </tr>
  480. </thead>
  481. <tbody>
  482. <tr>
  483. <td class="name"><code>content</code></td>
  484. <td class="type">
  485. </td>
  486. <td class="attributes">
  487. </td>
  488. <td class="description last"></td>
  489. </tr>
  490. <tr>
  491. <td class="name"><code>opts</code></td>
  492. <td class="type">
  493. <span class="param-type">object</span>
  494. </td>
  495. <td class="attributes">
  496. &lt;optional><br>
  497. </td>
  498. <td class="description last">
  499. <h6>Properties</h6>
  500. <table class="params">
  501. <thead>
  502. <tr>
  503. <th>Name</th>
  504. <th>Type</th>
  505. <th>Attributes</th>
  506. <th>Default</th>
  507. <th class="last">Description</th>
  508. </tr>
  509. </thead>
  510. <tbody>
  511. <tr>
  512. <td class="name"><code>forceSave</code></td>
  513. <td class="type">
  514. <span class="param-type">object</span>
  515. </td>
  516. <td class="attributes">
  517. &lt;optional><br>
  518. </td>
  519. <td class="default">
  520. false
  521. </td>
  522. <td class="description last">will also save this BAttachment entity</td>
  523. </tr>
  524. <tr>
  525. <td class="name"><code>forceFrontendReload</code></td>
  526. <td class="type">
  527. <span class="param-type">object</span>
  528. </td>
  529. <td class="attributes">
  530. &lt;optional><br>
  531. </td>
  532. <td class="default">
  533. false
  534. </td>
  535. <td class="description last">override frontend heuristics on when to reload, instruct to reload</td>
  536. </tr>
  537. </tbody>
  538. </table>
  539. </td>
  540. </tr>
  541. </tbody>
  542. </table>
  543. <dl class="details">
  544. <dt class="tag-source">Source:</dt>
  545. <dd class="tag-source"><ul class="dummy"><li>
  546. <a href="becca_entities_battachment.js.html">becca/entities/battachment.js</a>, <a href="becca_entities_battachment.js.html#line133">line 133</a>
  547. </li></ul></dd>
  548. </dl>
  549. </article>
  550. </section>
  551. </div>
  552. <nav>
  553. <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>
  554. </nav>
  555. <br class="clear">
  556. <footer>
  557. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
  558. </footer>
  559. <script> prettyPrint(); </script>
  560. <script src="scripts/linenumber.js"> </script>
  561. </body>
  562. </html>