123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>JSDoc: Global</title>
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
- </head>
- <body>
- <div id="main">
- <h1 class="page-title">Global</h1>
-
- <section>
- <header>
-
- <h2></h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
- </div>
-
-
-
-
-
-
-
-
-
- <h3 class="subsection-title">Type Definitions</h3>
-
-
- <h4 class="name" id="CreateNewNoteParams">CreateNewNoteParams</h4>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">object</span>
- </li>
- </ul>
- <h5 class="subsection-title">Properties:</h5>
-
- <table class="props">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>parentNoteId</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">MANDATORY</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>title</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">MANDATORY</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>content</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
- |
- <span class="param-type">buffer</span>
-
- </td>
-
-
- <td class="description last">MANDATORY</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>type</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">text, code, file, image, search, book, relation-map - MANDATORY</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>mime</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">value is derived from default mimes for type</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>isProtected</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
-
- <td class="description last">default is false</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>isExpanded</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
-
- <td class="description last">default is false</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>prefix</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">default is empty string</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>notePosition</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">default is last existing notePosition in a parent + 10</td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line208">line 208</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="CreateNoteAttribute">CreateNoteAttribute</h4>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">object</span>
- </li>
- </ul>
- <h5 class="subsection-title">Properties:</h5>
-
- <table class="props">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>type</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
-
- </td>
-
-
- <td class="description last">attribute type - label, relation etc.</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>name</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
-
- </td>
-
-
- <td class="description last">attribute name</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="description last">attribute value</td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line169">line 169</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="CreateNoteAttribute">CreateNoteAttribute</h4>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">object</span>
- </li>
- </ul>
- <h5 class="subsection-title">Properties:</h5>
-
- <table class="props">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>type</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
-
- </td>
-
-
- <td class="description last">attribute type - label, relation etc.</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>name</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
-
- </td>
-
-
- <td class="description last">attribute name</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="description last">attribute value</td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line229">line 229</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="CreateNoteExtraOptions">CreateNoteExtraOptions</h4>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">object</span>
- </li>
- </ul>
- <h5 class="subsection-title">Properties:</h5>
-
- <table class="props">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th>Default</th>
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>json</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="default">
-
- false
-
- </td>
-
- <td class="description last">should the note be JSON</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>isProtected</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="default">
-
- false
-
- </td>
-
- <td class="description last">should the note be protected</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>type</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="default">
-
- 'text'
-
- </td>
-
- <td class="description last">note type</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>mime</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="default">
-
- 'text/html'
-
- </td>
-
- <td class="description last">MIME type of the note</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>attributes</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Array.<<a href="global.html#CreateNoteAttribute">CreateNoteAttribute</a>></span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
- </td>
-
-
- <td class="default">
-
- []
-
- </td>
-
- <td class="description last">attributes to be created for this note</td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="services_backend_script_api.js.html">services/backend_script_api.js</a>, <a href="services_backend_script_api.js.html#line236">line 236</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
- </article>
- </section>
- </div>
- <nav>
- <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="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</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>
- </nav>
- <br class="clear">
- <footer>
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a>
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|