From 0144dc12dfe46fc9e5d15d64cdd8c9e3f7398637 Mon Sep 17 00:00:00 2001 From: zadam Date: Tue, 12 Mar 2019 21:52:19 +0100 Subject: [PATCH] current note as in note loaded into right pane is now called "active note" in frontend API --- docs/frontend_api/FrontendScriptApi.html | 420 +++++++++--------- .../services_frontend_script_api.js.html | 12 +- .../services/frontend_script_api.js | 12 +- 3 files changed, 222 insertions(+), 222 deletions(-) diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html index cb200a398..73e9bb535 100644 --- a/docs/frontend_api/FrontendScriptApi.html +++ b/docs/frontend_api/FrontendScriptApi.html @@ -1244,6 +1244,214 @@ +

getActiveNote() → {NoteFull}

+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ active note (loaded into right pane) +
+ + + +
+
+ Type +
+
+ +NoteFull + + +
+
+ + + + + + + + + + + + + +

getActiveNoteContent() → {string}

+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ content of active note (loaded into right pane) +
+ + + +
+
+ Type +
+
+ +string + + +
+
+ + + + + + + + + + + + +

getCodeMimeTypes() → {array}

@@ -1348,214 +1556,6 @@ -

getCurrentNote() → {NoteFull}

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - -
- currently loaded note in the editor (HTML, code etc.) -
- - - -
-
- Type -
-
- -NoteFull - - -
-
- - - - - - - - - - - - - -

getCurrentNoteContent() → {string}

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - -
- content of currently loaded note in the editor (HTML, code etc.) -
- - - -
-
- Type -
-
- -string - - -
-
- - - - - - - - - - - - -

getDefaultCodeMimeTypes() → {array}

@@ -1964,7 +1964,7 @@ otherwise (by e.g. createNoteLink()) -

isNoteStillLoaded() → {boolean}

+

isNoteStillActive() → {boolean}

@@ -2359,7 +2359,7 @@ note. -

protectCurrentNote()

+

protectActiveNote()

diff --git a/docs/frontend_api/services_frontend_script_api.js.html b/docs/frontend_api/services_frontend_script_api.js.html index a543684c6..7d8adbce9 100644 --- a/docs/frontend_api/services_frontend_script_api.js.html +++ b/docs/frontend_api/services_frontend_script_api.js.html @@ -228,15 +228,15 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null) { /** * @method - * @returns {string} content of currently loaded note in the editor (HTML, code etc.) + * @returns {string} content of active note (loaded into right pane) */ - this.getCurrentNoteContent = noteDetailService.getCurrentNoteContent; + this.getActiveNoteContent = noteDetailService.getCurrentNoteContent; /** * @method - * @returns {NoteFull} currently loaded note in the editor (HTML, code etc.) + * @returns {NoteFull} active note (loaded into right pane) */ - this.getCurrentNote = noteDetailService.getCurrentNote; + this.getActiveNote = noteDetailService.getCurrentNote; /** * This method checks whether user navigated away from the note from which the scripts has been started. @@ -247,7 +247,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null) { * @method * @return {boolean} returns true if the original note is still loaded, false if user switched to another */ - this.isNoteStillLoaded = () => { + this.isNoteStillActive = () => { return this.originEntity.noteId === noteDetailService.getCurrentNoteId(); }; @@ -284,7 +284,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null) { /** * @method */ - this.protectCurrentNote = protectedSessionService.protectNoteAndSendToServer; + this.protectActiveNote = protectedSessionService.protectNoteAndSendToServer; } export default FrontendScriptApi; diff --git a/src/public/javascripts/services/frontend_script_api.js b/src/public/javascripts/services/frontend_script_api.js index 1d15ad453..7c79931d2 100644 --- a/src/public/javascripts/services/frontend_script_api.js +++ b/src/public/javascripts/services/frontend_script_api.js @@ -200,15 +200,15 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null) { /** * @method - * @returns {string} content of currently loaded note in the editor (HTML, code etc.) + * @returns {string} content of active note (loaded into right pane) */ - this.getCurrentNoteContent = noteDetailService.getCurrentNoteContent; + this.getActiveNoteContent = noteDetailService.getCurrentNoteContent; /** * @method - * @returns {NoteFull} currently loaded note in the editor (HTML, code etc.) + * @returns {NoteFull} active note (loaded into right pane) */ - this.getCurrentNote = noteDetailService.getCurrentNote; + this.getActiveNote = noteDetailService.getCurrentNote; /** * This method checks whether user navigated away from the note from which the scripts has been started. @@ -219,7 +219,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null) { * @method * @return {boolean} returns true if the original note is still loaded, false if user switched to another */ - this.isNoteStillLoaded = () => { + this.isNoteStillActive = () => { return this.originEntity.noteId === noteDetailService.getCurrentNoteId(); }; @@ -256,7 +256,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null) { /** * @method */ - this.protectCurrentNote = protectedSessionService.protectNoteAndSendToServer; + this.protectActiveNote = protectedSessionService.protectNoteAndSendToServer; } export default FrontendScriptApi; \ No newline at end of file