Attribute.html 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Attribute</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: Attribute</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>Attribute<span class="signature">()</span><span class="type-signature"></span></h2>
  20. <div class="class-description">Attribute is key value pair owned by a note.</div>
  21. </header>
  22. <article>
  23. <div class="container-overview">
  24. <h2>Constructor</h2>
  25. <h4 class="name" id="Attribute"><span class="type-signature"></span>new Attribute<span class="signature">()</span><span class="type-signature"></span></h4>
  26. <h5 class="subsection-title">Properties:</h5>
  27. <table class="props">
  28. <thead>
  29. <tr>
  30. <th>Name</th>
  31. <th>Type</th>
  32. <th class="last">Description</th>
  33. </tr>
  34. </thead>
  35. <tbody>
  36. <tr>
  37. <td class="name"><code>attributeId</code></td>
  38. <td class="type">
  39. <span class="param-type">string</span>
  40. </td>
  41. <td class="description last"></td>
  42. </tr>
  43. <tr>
  44. <td class="name"><code>noteId</code></td>
  45. <td class="type">
  46. <span class="param-type">string</span>
  47. </td>
  48. <td class="description last"></td>
  49. </tr>
  50. <tr>
  51. <td class="name"><code>type</code></td>
  52. <td class="type">
  53. <span class="param-type">string</span>
  54. </td>
  55. <td class="description last"></td>
  56. </tr>
  57. <tr>
  58. <td class="name"><code>name</code></td>
  59. <td class="type">
  60. <span class="param-type">string</span>
  61. </td>
  62. <td class="description last"></td>
  63. </tr>
  64. <tr>
  65. <td class="name"><code>value</code></td>
  66. <td class="type">
  67. <span class="param-type">string</span>
  68. </td>
  69. <td class="description last"></td>
  70. </tr>
  71. <tr>
  72. <td class="name"><code>position</code></td>
  73. <td class="type">
  74. <span class="param-type">int</span>
  75. </td>
  76. <td class="description last"></td>
  77. </tr>
  78. <tr>
  79. <td class="name"><code>isInheritable</code></td>
  80. <td class="type">
  81. <span class="param-type">boolean</span>
  82. </td>
  83. <td class="description last"></td>
  84. </tr>
  85. <tr>
  86. <td class="name"><code>isDeleted</code></td>
  87. <td class="type">
  88. <span class="param-type">boolean</span>
  89. </td>
  90. <td class="description last"></td>
  91. </tr>
  92. <tr>
  93. <td class="name"><code>deleteId</code></td>
  94. <td class="type">
  95. <span class="param-type">string</span>
  96. |
  97. <span class="param-type">null</span>
  98. </td>
  99. <td class="description last">ID identifying delete transaction</td>
  100. </tr>
  101. <tr>
  102. <td class="name"><code>utcDateCreated</code></td>
  103. <td class="type">
  104. <span class="param-type">string</span>
  105. </td>
  106. <td class="description last"></td>
  107. </tr>
  108. <tr>
  109. <td class="name"><code>utcDateModified</code></td>
  110. <td class="type">
  111. <span class="param-type">string</span>
  112. </td>
  113. <td class="description last"></td>
  114. </tr>
  115. </tbody>
  116. </table>
  117. <dl class="details">
  118. <dt class="tag-source">Source:</dt>
  119. <dd class="tag-source"><ul class="dummy"><li>
  120. <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line30">line 30</a>
  121. </li></ul></dd>
  122. </dl>
  123. </div>
  124. <h3 class="subsection-title">Extends</h3>
  125. <ul>
  126. <li><a href="Entity.html">Entity</a></li>
  127. </ul>
  128. <h3 class="subsection-title">Methods</h3>
  129. <h4 class="name" id="getNote"><span class="type-signature">(async) </span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="Note.html">Note</a>|null)>}</span></h4>
  130. <dl class="details">
  131. <dt class="tag-source">Source:</dt>
  132. <dd class="tag-source"><ul class="dummy"><li>
  133. <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line47">line 47</a>
  134. </li></ul></dd>
  135. </dl>
  136. <h5>Returns:</h5>
  137. <dl>
  138. <dt>
  139. Type
  140. </dt>
  141. <dd>
  142. <span class="param-type">Promise.&lt;(<a href="Note.html">Note</a>|null)></span>
  143. </dd>
  144. </dl>
  145. <h4 class="name" id="getTargetNote"><span class="type-signature">(async) </span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="Note.html">Note</a>|null)>}</span></h4>
  146. <dl class="details">
  147. <dt class="tag-source">Source:</dt>
  148. <dd class="tag-source"><ul class="dummy"><li>
  149. <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line54">line 54</a>
  150. </li></ul></dd>
  151. </dl>
  152. <h5>Returns:</h5>
  153. <dl>
  154. <dt>
  155. Type
  156. </dt>
  157. <dd>
  158. <span class="param-type">Promise.&lt;(<a href="Note.html">Note</a>|null)></span>
  159. </dd>
  160. </dl>
  161. <h4 class="name" id="isDefinition"><span class="type-signature"></span>isDefinition<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  162. <dl class="details">
  163. <dt class="tag-source">Source:</dt>
  164. <dd class="tag-source"><ul class="dummy"><li>
  165. <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line69">line 69</a>
  166. </li></ul></dd>
  167. </dl>
  168. <h5>Returns:</h5>
  169. <dl>
  170. <dt>
  171. Type
  172. </dt>
  173. <dd>
  174. <span class="param-type">boolean</span>
  175. </dd>
  176. </dl>
  177. </article>
  178. </section>
  179. </div>
  180. <nav>
  181. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="Entity.html">Entity</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
  182. </nav>
  183. <br class="clear">
  184. <footer>
  185. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a>
  186. </footer>
  187. <script> prettyPrint(); </script>
  188. <script src="scripts/linenumber.js"> </script>
  189. </body>
  190. </html>