mirror of
				https://github.com/zadam/trilium.git
				synced 2025-10-30 09:56:36 +01:00 
			
		
		
		
	
		
			
	
	
		
			494 lines
		
	
	
		
			6.5 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
		
		
			
		
	
	
			494 lines
		
	
	
		
			6.5 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
|  | <!DOCTYPE html> | ||
|  | <html lang="en"> | ||
|  | <head> | ||
|  |     <meta charset="utf-8"> | ||
|  |     <title>JSDoc: Class: NoteContent</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">Class: NoteContent</h1> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | <section> | ||
|  | 
 | ||
|  | <header> | ||
|  |      | ||
|  |         <h2><span class="attribs"><span class="type-signature"></span></span>NoteContent<span class="signature">(row)</span><span class="type-signature"></span></h2> | ||
|  |          | ||
|  |             <div class="class-description">This represents a Note which is a central object in the Trilium Notes project.</div> | ||
|  |          | ||
|  |      | ||
|  | </header> | ||
|  | 
 | ||
|  | <article> | ||
|  |     <div class="container-overview"> | ||
|  |      | ||
|  |          | ||
|  | 
 | ||
|  |      | ||
|  |     <h2>Constructor</h2> | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  |     <h4 class="name" id="NoteContent"><span class="type-signature"></span>new NoteContent<span class="signature">(row)</span><span class="type-signature"></span></h4> | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  |     <h5>Parameters:</h5> | ||
|  |      | ||
|  | 
 | ||
|  | <table class="params"> | ||
|  |     <thead> | ||
|  |     <tr> | ||
|  |          | ||
|  |         <th>Name</th> | ||
|  |          | ||
|  | 
 | ||
|  |         <th>Type</th> | ||
|  | 
 | ||
|  |          | ||
|  | 
 | ||
|  |          | ||
|  | 
 | ||
|  |         <th class="last">Description</th> | ||
|  |     </tr> | ||
|  |     </thead> | ||
|  | 
 | ||
|  |     <tbody> | ||
|  |      | ||
|  | 
 | ||
|  |         <tr> | ||
|  |              | ||
|  |                 <td class="name"><code>row</code></td> | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="type"> | ||
|  |              | ||
|  |             </td> | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="description last">object containing database row from "note_contents" table</td> | ||
|  |         </tr> | ||
|  | 
 | ||
|  |      | ||
|  |     </tbody> | ||
|  | </table> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  |     <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>noteContentId</code></td> | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="type"> | ||
|  |              | ||
|  |                  | ||
|  | <span class="param-type">string</span> | ||
|  | 
 | ||
|  | 
 | ||
|  |              | ||
|  |             </td> | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="description last">primary key</td> | ||
|  |         </tr> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |         <tr> | ||
|  |              | ||
|  |                 <td class="name"><code>noteId</code></td> | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="type"> | ||
|  |              | ||
|  |                  | ||
|  | <span class="param-type">string</span> | ||
|  | 
 | ||
|  | 
 | ||
|  |              | ||
|  |             </td> | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="description last">reference to owning note</td> | ||
|  |         </tr> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |         <tr> | ||
|  |              | ||
|  |                 <td class="name"><code>isProtected</code></td> | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="type"> | ||
|  |              | ||
|  |                  | ||
|  | <span class="param-type">boolean</span> | ||
|  | 
 | ||
|  | 
 | ||
|  |              | ||
|  |             </td> | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="description last">true if note content is protected</td> | ||
|  |         </tr> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |         <tr> | ||
|  |              | ||
|  |                 <td class="name"><code>content</code></td> | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="type"> | ||
|  |              | ||
|  |                  | ||
|  | <span class="param-type">blob</span> | ||
|  | 
 | ||
|  | 
 | ||
|  |              | ||
|  |             </td> | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="description last">note content - e.g. HTML text for text notes, file payload for files</td> | ||
|  |         </tr> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |         <tr> | ||
|  |              | ||
|  |                 <td class="name"><code>dateCreated</code></td> | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="type"> | ||
|  |              | ||
|  |                  | ||
|  | <span class="param-type">string</span> | ||
|  | 
 | ||
|  | 
 | ||
|  |              | ||
|  |             </td> | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="description last"></td> | ||
|  |         </tr> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |         <tr> | ||
|  |              | ||
|  |                 <td class="name"><code>dateModified</code></td> | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="type"> | ||
|  |              | ||
|  |                  | ||
|  | <span class="param-type">string</span> | ||
|  | 
 | ||
|  | 
 | ||
|  |              | ||
|  |             </td> | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |              | ||
|  | 
 | ||
|  |             <td class="description last"></td> | ||
|  |         </tr> | ||
|  | 
 | ||
|  |      | ||
|  |     </tbody> | ||
|  | </table> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | <dl class="details"> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  |     <dt class="tag-source">Source:</dt> | ||
|  |     <dd class="tag-source"><ul class="dummy"><li> | ||
|  |         <a href="entities_note_content.js.html">entities/note_content.js</a>, <a href="entities_note_content.js.html#line20">line 20</a> | ||
|  |     </li></ul></dd> | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | </dl> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  |      | ||
|  |     </div> | ||
|  | 
 | ||
|  |      | ||
|  |         <h3 class="subsection-title">Extends</h3> | ||
|  | 
 | ||
|  |          | ||
|  | 
 | ||
|  | 
 | ||
|  |     <ul> | ||
|  |         <li><a href="Entity.html">Entity</a></li> | ||
|  |     </ul> | ||
|  | 
 | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  |         <h3 class="subsection-title">Methods</h3> | ||
|  | 
 | ||
|  |          | ||
|  |              | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  |     <h4 class="name" id="getNote"><span class="type-signature">(async) </span>getNote<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="Note.html">Note</a>>}</span></h4> | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | <dl class="details"> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  |     <dt class="tag-source">Source:</dt> | ||
|  |     <dd class="tag-source"><ul class="dummy"><li> | ||
|  |         <a href="entities_note_content.js.html">entities/note_content.js</a>, <a href="entities_note_content.js.html#line63">line 63</a> | ||
|  |     </li></ul></dd> | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | </dl> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | <h5>Returns:</h5> | ||
|  | 
 | ||
|  |          | ||
|  | 
 | ||
|  | 
 | ||
|  | <dl> | ||
|  |     <dt> | ||
|  |         Type | ||
|  |     </dt> | ||
|  |     <dd> | ||
|  |          | ||
|  | <span class="param-type">Promise.<<a href="Note.html">Note</a>></span> | ||
|  | 
 | ||
|  | 
 | ||
|  |     </dd> | ||
|  | </dl> | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  |          | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | 
 | ||
|  |      | ||
|  | </article> | ||
|  | 
 | ||
|  | </section> | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | 
 | ||
|  | </div> | ||
|  | 
 | ||
|  | <nav> | ||
|  |     <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="Link.html">Link</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteContent.html">NoteContent</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/jsdoc3/jsdoc">JSDoc 3.5.5</a> | ||
|  | </footer> | ||
|  | 
 | ||
|  | <script> prettyPrint(); </script> | ||
|  | <script src="scripts/linenumber.js"> </script> | ||
|  | </body> | ||
|  | </html> |