docs/backend_api/global.html

<!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, canvas - 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">
                
                    &lt;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">
                
                    &lt;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">
                
                    &lt;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">
                
                    &lt;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">
                
                    &lt;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">
                
                    &lt;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.&lt;<a href="global.html#CreateNoteAttribute">CreateNoteAttribute</a>></span>


            </td>

            
                <td class="attributes">
                
                    &lt;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="AbstractEntity.html">AbstractEntity</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="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.10</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`<!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>`



rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<h4 class="name" id="CreateNewNoteParams">CreateNewNoteParams</h4>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00





			`<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>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>parentNoteId</code></td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

			`<td class="type">`


			`<span class="param-type">string</span>`



			`</td>`





rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">MANDATORY</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</tr>`



			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>title</code></td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

			`<td class="type">`


			`<span class="param-type">string</span>`



			`</td>`





rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">MANDATORY</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</tr>`



			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>content</code></td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

			`<td class="type">`


			`<span class="param-type">string</span>`
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`\|`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<span class="param-type">buffer</span>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00


rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00




rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">MANDATORY</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</tr>`



rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<tr>`

			`<td class="name"><code>type</code></td>`

added jsdocs generated pages 2018-08-29 20:44:35 +02:00
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="type">`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<span class="param-type">string</span>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00


rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00
added jsdocs generated pages 2018-08-29 20:44:35 +02:00
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00
added jsdocs generated pages 2018-08-29 20:44:35 +02:00
added triggerCommand and triggerEvent into frontend API 2022-05-13 22:33:57 +02:00			`<td class="description last">text, code, file, image, search, book, relation-map, canvas - MANDATORY</td>`
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`</tr>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00


			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>mime</code></td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

			`<td class="type">`


API docs update 2019-11-25 22:45:09 +01:00			`<span class="param-type">string</span>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00


			`</td>`





rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">value is derived from default mimes for type</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</tr>`



			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>isProtected</code></td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

			`<td class="type">`


rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<span class="param-type">boolean</span>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00


			`</td>`





rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">default is false</td>`
API docs update 2019-11-25 22:45:09 +01:00			`</tr>`



			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>isExpanded</code></td>`
API docs update 2019-11-25 22:45:09 +01:00

			`<td class="type">`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<span class="param-type">boolean</span>`
API docs update 2019-11-25 22:45:09 +01:00


			`</td>`

added jsdocs generated pages 2018-08-29 20:44:35 +02:00

API docs update 2019-11-25 22:45:09 +01:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">default is false</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</tr>`



			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>prefix</code></td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

			`<td class="type">`


			`<span class="param-type">string</span>`



			`</td>`





rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">default is empty string</td>`
API docs update 2019-11-25 22:45:09 +01:00			`</tr>`



			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>notePosition</code></td>`
API docs update 2019-11-25 22:45:09 +01:00

			`<td class="type">`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<span class="param-type">int</span>`
API docs update 2019-11-25 22:45:09 +01:00


			`</td>`



added jsdocs generated pages 2018-08-29 20:44:35 +02:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">default is last existing notePosition in a parent + 10</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</tr>`


rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`</tbody>`
			`</table>`




			`<dl class="details">`


























			`<dt class="tag-source">Source:</dt>`
			`<dd class="tag-source"><ul class="dummy"><li>`
updated API docs 2021-09-30 12:26:13 +02:00			`<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>`
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`</li></ul></dd>`







			`</dl>`




added jsdocs generated pages 2018-08-29 20:44:35 +02:00



rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<h4 class="name" id="CreateNoteAttribute">CreateNoteAttribute</h4>`

added jsdocs generated pages 2018-08-29 20:44:35 +02:00



rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00
			`<h5>Type:</h5>`
			`<ul>`
			`<li>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<span class="param-type">object</span>`


			`</li>`
			`</ul>`

added jsdocs generated pages 2018-08-29 20:44:35 +02:00
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00


			`<h5 class="subsection-title">Properties:</h5>`
API docs update 2019-11-25 22:45:09 +01:00


rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<table class="props">`
			`<thead>`
			`<tr>`

			`<th>Name</th>`


			`<th>Type</th>`


			`<th>Attributes</th>`




			`<th class="last">Description</th>`
			`</tr>`
			`</thead>`

			`<tbody>`


API docs update 2019-11-25 22:45:09 +01:00			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>type</code></td>`
API docs update 2019-11-25 22:45:09 +01:00

			`<td class="type">`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<span class="param-type">string</span>`
API docs update 2019-11-25 22:45:09 +01:00


			`</td>`

added jsdocs generated pages 2018-08-29 20:44:35 +02:00
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="attributes">`



			`</td>`

added jsdocs generated pages 2018-08-29 20:44:35 +02:00
API docs update 2019-11-25 22:45:09 +01:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">attribute type - label, relation etc.</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</tr>`



			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>name</code></td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

			`<td class="type">`


API docs update 2019-11-25 22:45:09 +01:00			`<span class="param-type">string</span>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00


			`</td>`


rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="attributes">`

added jsdocs generated pages 2018-08-29 20:44:35 +02:00
rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00
			`</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00

			`<td class="description last">attribute name</td>`
API docs update 2019-11-25 22:45:09 +01:00			`</tr>`



			`<tr>`

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="name"><code>value</code></td>`
API docs update 2019-11-25 22:45:09 +01:00

			`<td class="type">`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<span class="param-type">string</span>`
API docs update 2019-11-25 22:45:09 +01:00


			`</td>`


rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="attributes">`

			`<optional><br>`



			`</td>`

API docs update 2019-11-25 22:45:09 +01:00
added jsdocs generated pages 2018-08-29 20:44:35 +02:00

rename API .createNote() to .createNewNote() to allow future backwards compatibility 2019-11-28 22:35:55 +01:00			`<td class="description last">attribute value</td>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</tr>`


			`</tbody>`
			`</table>`




			`<dl class="details">`


























			`<dt class="tag-source">Source:</dt>`
			`<dd class="tag-source"><ul class="dummy"><li>`
updated API docs 2021-09-30 12:26:13 +02:00			`<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>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</li></ul></dd>`







			`</dl>`







API docs updates 2019-12-03 22:53:17 +01:00
			`<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>`
updated API docs 2021-09-30 12:26:13 +02:00			`<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>`
API docs updates 2019-12-03 22:53:17 +01:00			`</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>`
updated API docs 2021-09-30 12:26:13 +02:00			`<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>`
API docs updates 2019-12-03 22:53:17 +01:00			`</li></ul></dd>`







			`</dl>`







added jsdocs generated pages 2018-08-29 20:44:35 +02:00


			`</article>`

			`</section>`




			`</div>`

			`<nav>`
fix docs 2022-04-16 00:17:32 +02:00			<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="AbstractEntity.html">AbstractEntity</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="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>
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</nav>`

			`<br class="clear">`

			`<footer>`
fix docs 2022-04-16 00:17:32 +02:00			`Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>`
added jsdocs generated pages 2018-08-29 20:44:35 +02:00			`</footer>`

			`<script> prettyPrint(); </script>`
			`<script src="scripts/linenumber.js"> </script>`
			`</body>`
			`</html>`