update API docs

2025-10-28 00:36:33 +01:00 · 2019-02-20 22:24:51 +01:00
parent 604f036a54
commit 60cbfdcabd
30 changed files with 2773 additions and 342 deletions
--- a/docs/backend_api/entities_note_content.js.html
+++ b/docs/backend_api/entities_note_content.js.html
@@ -0,0 +1,146 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: entities/note_content.js</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">Source: entities/note_content.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+
+const Entity = require('./entity');
+const protectedSessionService = require('../services/protected_session');
+const repository = require('../services/repository');
+const dateUtils = require('../services/date_utils');
+
+/**
+ * This represents a Note which is a central object in the Trilium Notes project.
+ *
+ * @property {string} noteContentId - primary key
+ * @property {string} noteId - reference to owning note
+ * @property {boolean} isProtected - true if note content is protected
+ * @property {blob} content - note content - e.g. HTML text for text notes, file payload for files
+ * @property {string} dateCreated
+ * @property {string} dateModified
+ *
+ * @extends Entity
+ */
+class NoteContent extends Entity {
+    static get entityName() {
+        return "note_contents";
+    }
+
+    static get primaryKeyName() {
+        return "noteContentId";
+    }
+
+    static get hashedProperties() {
+        return ["noteContentId", "noteId", "isProtected", "content"];
+    }
+
+    /**
+     * @param row - object containing database row from "note_contents" table
+     */
+    constructor(row) {
+        super(row);
+
+        this.isProtected = !!this.isProtected;
+        /* true if content (meaning any kind of potentially encrypted content) is either not encrypted
+         * or encrypted, but with available protected session (so effectively decrypted) */
+        this.isContentAvailable = true;
+
+        // check if there's noteContentId, otherwise this is a new entity which wasn't encrypted yet
+        if (this.isProtected &amp;&amp; this.noteContentId) {
+            this.isContentAvailable = protectedSessionService.isProtectedSessionAvailable();
+
+            if (this.isContentAvailable) {
+                protectedSessionService.decryptNoteContent(this);
+            }
+            else {
+                // saving ciphertexts in case we do want to update protected note outside of protected session
+                // (which is allowed)
+                this.contentCipherText = this.content;
+                this.content = "";
+            }
+        }
+    }
+
+    /**
+     * @returns {Promise&lt;Note>}
+     */
+    async getNote() {
+        return await repository.getNote(this.noteId);
+    }
+
+    beforeSaving() {
+        if (!this.dateCreated) {
+            this.dateCreated = dateUtils.nowDate();
+        }
+
+        super.beforeSaving();
+
+        if (this.isChanged) {
+            this.dateModified = dateUtils.nowDate();
+        }
+    }
+
+    // cannot be static!
+    updatePojo(pojo) {
+        if (pojo.isProtected) {
+            if (this.isContentAvailable) {
+                protectedSessionService.encryptNoteContent(pojo);
+            }
+            else {
+                // updating protected note outside of protected session means we will keep original ciphertext
+                pojo.content = pojo.contentCipherText;
+            }
+        }
+
+        delete pojo.isContentAvailable;
+        delete pojo.contentCipherText;
+    }
+}
+
+module.exports = NoteContent;</code></pre>
+        </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>