| Name | + + +Type | + + + + +Default | + + +Description | +
|---|---|---|---|
matchBy |
+
+
+ + + +string + + + + | + + + + ++ + attachmentId + + | + + +choose by which property we detect if to update an existing attachment. + Supported values are either 'attachmentId' (default) or 'title' | +
api.log(api.startNote.
Source:
api.log(api.startNote.
Source:
api.log(api.startNote.
Source:
api.log(api.startNote.
Source:
api.log(api.startNote.
Source:
api.log(api.startNote.
Source:
api.log(api.startNote.
Source:
api.log(api.startNote.
Source:
api.log(api.startNote.
Source:
api.log(api.startNote.
+ backupNow(backupName) → {Promise}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ backupName
+
+
+string
+
+
+
+
+
+
+
+
+
+ If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ - resolves once the backup is finished
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
createDataNote(parentNoteId, title, content) → {Object}
@@ -1188,7 +1343,7 @@ JSON MIME type. See also createNewNote() for more options.
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
diff --git a/docs/frontend_api/FBranch.html b/docs/frontend_api/FBranch.html
index 3220829d1..c62471050 100644
--- a/docs/frontend_api/FBranch.html
+++ b/docs/frontend_api/FBranch.html
@@ -1124,7 +1124,7 @@ parents.
diff --git a/docs/frontend_api/FNote.html b/docs/frontend_api/FNote.html
index 3e2ffb611..4e9edf3e5 100644
--- a/docs/frontend_api/FNote.html
+++ b/docs/frontend_api/FNote.html
@@ -6570,7 +6570,7 @@
- getSortedNotePathRecords(hoistedNoteIdopt) → {Array.<{isArchived: boolean, isInHoistedSubTree: boolean, isSearch: boolean, notePath: Array.<string>, isHidden: boolean}>}
+ getSortedNotePathRecords(hoistedNoteIdopt) → {Array.<{isArchived: boolean, isInHoistedSubTree: boolean, isSearch: boolean, notePath: Array.<string>, isHidden: boolean}>}
@@ -6723,7 +6723,7 @@
-Array.<{isArchived: boolean, isInHoistedSubTree: boolean, isSearch: boolean, notePath: Array.<string>, isHidden: boolean}>
+Array.<{isArchived: boolean, isInHoistedSubTree: boolean, isSearch: boolean, notePath: Array.<string>, isHidden: boolean}>
@@ -8690,7 +8690,7 @@
diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html
index 3b340b60a..ab2da083f 100644
--- a/docs/frontend_api/FrontendScriptApi.html
+++ b/docs/frontend_api/FrontendScriptApi.html
@@ -293,7 +293,7 @@ available in the JS frontend notes. You can use e.g. api.showMessage(api.s
-BasicWidget
+BasicWidget
@@ -8356,7 +8356,7 @@ Typical use case is when a new note has been created, we should wait until it is
diff --git a/docs/frontend_api/entities_fattachment.js.html b/docs/frontend_api/entities_fattachment.js.html
index c49ab8dd2..7b320d895 100644
--- a/docs/frontend_api/entities_fattachment.js.html
+++ b/docs/frontend_api/entities_fattachment.js.html
@@ -80,7 +80,7 @@ export default FAttachment;
diff --git a/docs/frontend_api/entities_fattribute.js.html b/docs/frontend_api/entities_fattribute.js.html
index 7daa67ff2..7b1bd8625 100644
--- a/docs/frontend_api/entities_fattribute.js.html
+++ b/docs/frontend_api/entities_fattribute.js.html
@@ -116,7 +116,7 @@ export default FAttribute;
diff --git a/docs/frontend_api/entities_fblob.js.html b/docs/frontend_api/entities_fblob.js.html
index e98ee01c6..70d0dc312 100644
--- a/docs/frontend_api/entities_fblob.js.html
+++ b/docs/frontend_api/entities_fblob.js.html
@@ -75,7 +75,7 @@
diff --git a/docs/frontend_api/entities_fbranch.js.html b/docs/frontend_api/entities_fbranch.js.html
index f2049871d..44268f761 100644
--- a/docs/frontend_api/entities_fbranch.js.html
+++ b/docs/frontend_api/entities_fbranch.js.html
@@ -100,7 +100,7 @@ export default FBranch;
diff --git a/docs/frontend_api/entities_fnote.js.html b/docs/frontend_api/entities_fnote.js.html
index d6f68bcca..4ccd4ac22 100644
--- a/docs/frontend_api/entities_fnote.js.html
+++ b/docs/frontend_api/entities_fnote.js.html
@@ -1021,7 +1021,7 @@ export default FNote;
diff --git a/docs/frontend_api/global.html b/docs/frontend_api/global.html
index 518a2455d..b47464576 100644
--- a/docs/frontend_api/global.html
+++ b/docs/frontend_api/global.html
@@ -94,6 +94,242 @@
+ Members
+
+
+
+hoistedNoteId
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+note
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+noteId
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+notePath
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
Methods
@@ -322,6 +558,157 @@
+
+
+
+
+
+ (async) refreshWithNote(note) → {Promise.<void>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ note
+
+
+FNote
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
@@ -337,7 +724,7 @@
diff --git a/docs/frontend_api/index.html b/docs/frontend_api/index.html
index 1fc84f364..1a696bafb 100644
--- a/docs/frontend_api/index.html
+++ b/docs/frontend_api/index.html
@@ -50,7 +50,7 @@
diff --git a/docs/frontend_api/services_frontend_script_api.js.html b/docs/frontend_api/services_frontend_script_api.js.html
index 3c978b25c..350a4ba2f 100644
--- a/docs/frontend_api/services_frontend_script_api.js.html
+++ b/docs/frontend_api/services_frontend_script_api.js.html
@@ -601,7 +601,7 @@ export default FrontendScriptApi;
diff --git a/src/services/backend_script_api.js b/src/services/backend_script_api.js
index 5854e002f..3a47761a9 100644
--- a/src/services/backend_script_api.js
+++ b/src/services/backend_script_api.js
@@ -19,7 +19,8 @@ const SpacedUpdate = require("./spaced_update");
const specialNotesService = require("./special_notes");
const branchService = require("./branches");
const exportService = require("./export/zip");
-const syncMutex = require("./sync_mutex.js");
+const syncMutex = require("./sync_mutex");
+const backupService = require("./backup");
/**
* This is the main backend API interface for scripts. All the properties and methods are published in the "api" object
@@ -586,6 +587,13 @@ function BackendScriptApi(currentNote, apiParams) {
*/
this.runOutsideOfSync = syncMutex.doExclusively;
+ /**
+ * @method
+ * @param {string} backupName - If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file
+ * @returns {Promise} - resolves once the backup is finished
+ */
+ this.backupNow = backupService.backupNow;
+
/**
* This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.
*