From 24673168bbd989c0c937d74a3200122086d74fca Mon Sep 17 00:00:00 2001 From: azivner Date: Sun, 7 Oct 2018 16:27:12 +0200 Subject: [PATCH] api docs update --- docs/backend_api/ApiToken.html | 2 +- docs/backend_api/Attribute.html | 2 +- docs/backend_api/BackendScriptApi.html | 2 +- docs/backend_api/Branch.html | 2 +- docs/backend_api/Entity.html | 2 +- docs/backend_api/Image.html | 2 +- docs/backend_api/Note.html | 2 +- docs/backend_api/NoteImage.html | 2 +- docs/backend_api/NoteRevision.html | 2 +- docs/backend_api/Option.html | 2 +- docs/backend_api/RecentNote.html | 2 +- docs/backend_api/entities_api_token.js.html | 2 +- docs/backend_api/entities_attribute.js.html | 2 +- docs/backend_api/entities_branch.js.html | 2 +- docs/backend_api/entities_entity.js.html | 2 +- docs/backend_api/entities_image.js.html | 2 +- docs/backend_api/entities_note.js.html | 2 +- docs/backend_api/entities_note_image.js.html | 2 +- .../entities_note_revision.js.html | 2 +- docs/backend_api/entities_option.js.html | 2 +- docs/backend_api/entities_recent_note.js.html | 2 +- docs/backend_api/global.html | 2 +- docs/backend_api/index.html | 2 +- .../services_backend_script_api.js.html | 2 +- docs/frontend_api/Branch.html | 2 +- docs/frontend_api/FrontendScriptApi.html | 379 +++++++++++++++++- docs/frontend_api/NoteFull.html | 2 +- docs/frontend_api/NoteShort.html | 2 +- docs/frontend_api/entities_branch.js.html | 2 +- docs/frontend_api/entities_note_full.js.html | 2 +- docs/frontend_api/entities_note_short.js.html | 2 +- docs/frontend_api/global.html | 4 +- docs/frontend_api/index.html | 2 +- .../services_frontend_script_api.js.html | 23 +- 34 files changed, 413 insertions(+), 55 deletions(-) diff --git a/docs/backend_api/ApiToken.html b/docs/backend_api/ApiToken.html index 513461163..8642aa735 100644 --- a/docs/backend_api/ApiToken.html +++ b/docs/backend_api/ApiToken.html @@ -288,7 +288,7 @@
diff --git a/docs/backend_api/Attribute.html b/docs/backend_api/Attribute.html index 8cba42261..b3d34fc0c 100644 --- a/docs/backend_api/Attribute.html +++ b/docs/backend_api/Attribute.html @@ -426,7 +426,7 @@
diff --git a/docs/backend_api/BackendScriptApi.html b/docs/backend_api/BackendScriptApi.html index 4235dde33..99ea4eb64 100644 --- a/docs/backend_api/BackendScriptApi.html +++ b/docs/backend_api/BackendScriptApi.html @@ -3814,7 +3814,7 @@ transactional by default.
diff --git a/docs/backend_api/Branch.html b/docs/backend_api/Branch.html index 90244543e..d1dcb70c4 100644 --- a/docs/backend_api/Branch.html +++ b/docs/backend_api/Branch.html @@ -511,7 +511,7 @@ Each note can have multiple (at least one) branches, meaning it can be placed in
diff --git a/docs/backend_api/Entity.html b/docs/backend_api/Entity.html index 06d760b44..01f52046f 100644 --- a/docs/backend_api/Entity.html +++ b/docs/backend_api/Entity.html @@ -216,7 +216,7 @@
diff --git a/docs/backend_api/Image.html b/docs/backend_api/Image.html index 3af2be45b..31e3f2762 100644 --- a/docs/backend_api/Image.html +++ b/docs/backend_api/Image.html @@ -380,7 +380,7 @@
diff --git a/docs/backend_api/Note.html b/docs/backend_api/Note.html index 5b9409129..3f58d4527 100644 --- a/docs/backend_api/Note.html +++ b/docs/backend_api/Note.html @@ -6651,7 +6651,7 @@ Cache is note instance scoped.
diff --git a/docs/backend_api/NoteImage.html b/docs/backend_api/NoteImage.html index 690c9baf5..28b67ea8f 100644 --- a/docs/backend_api/NoteImage.html +++ b/docs/backend_api/NoteImage.html @@ -334,7 +334,7 @@
diff --git a/docs/backend_api/NoteRevision.html b/docs/backend_api/NoteRevision.html index fbd8d171e..317a91731 100644 --- a/docs/backend_api/NoteRevision.html +++ b/docs/backend_api/NoteRevision.html @@ -403,7 +403,7 @@
diff --git a/docs/backend_api/Option.html b/docs/backend_api/Option.html index 4a8482ce2..74de22bc1 100644 --- a/docs/backend_api/Option.html +++ b/docs/backend_api/Option.html @@ -311,7 +311,7 @@
diff --git a/docs/backend_api/RecentNote.html b/docs/backend_api/RecentNote.html index 07116489a..86e19d189 100644 --- a/docs/backend_api/RecentNote.html +++ b/docs/backend_api/RecentNote.html @@ -288,7 +288,7 @@
diff --git a/docs/backend_api/entities_api_token.js.html b/docs/backend_api/entities_api_token.js.html index 0fc30fe88..d066908b5 100644 --- a/docs/backend_api/entities_api_token.js.html +++ b/docs/backend_api/entities_api_token.js.html @@ -75,7 +75,7 @@ module.exports = ApiToken;
diff --git a/docs/backend_api/entities_attribute.js.html b/docs/backend_api/entities_attribute.js.html index a51aebe98..5783b5f41 100644 --- a/docs/backend_api/entities_attribute.js.html +++ b/docs/backend_api/entities_attribute.js.html @@ -134,7 +134,7 @@ module.exports = Attribute;
diff --git a/docs/backend_api/entities_branch.js.html b/docs/backend_api/entities_branch.js.html index 1de70e8a8..edd23b3b6 100644 --- a/docs/backend_api/entities_branch.js.html +++ b/docs/backend_api/entities_branch.js.html @@ -105,7 +105,7 @@ module.exports = Branch;
diff --git a/docs/backend_api/entities_entity.js.html b/docs/backend_api/entities_entity.js.html index 5e3b0d17f..3559ae81d 100644 --- a/docs/backend_api/entities_entity.js.html +++ b/docs/backend_api/entities_entity.js.html @@ -93,7 +93,7 @@ module.exports = Entity;
diff --git a/docs/backend_api/entities_image.js.html b/docs/backend_api/entities_image.js.html index 3f31bfbd2..8ef53d133 100644 --- a/docs/backend_api/entities_image.js.html +++ b/docs/backend_api/entities_image.js.html @@ -83,7 +83,7 @@ module.exports = Image;
diff --git a/docs/backend_api/entities_note.js.html b/docs/backend_api/entities_note.js.html index feafba136..c9aa8c347 100644 --- a/docs/backend_api/entities_note.js.html +++ b/docs/backend_api/entities_note.js.html @@ -601,7 +601,7 @@ module.exports = Note;
diff --git a/docs/backend_api/entities_note_image.js.html b/docs/backend_api/entities_note_image.js.html index e60507b35..67990ae63 100644 --- a/docs/backend_api/entities_note_image.js.html +++ b/docs/backend_api/entities_note_image.js.html @@ -90,7 +90,7 @@ module.exports = NoteImage;
diff --git a/docs/backend_api/entities_note_revision.js.html b/docs/backend_api/entities_note_revision.js.html index 129d75cca..141785ab6 100644 --- a/docs/backend_api/entities_note_revision.js.html +++ b/docs/backend_api/entities_note_revision.js.html @@ -91,7 +91,7 @@ module.exports = NoteRevision;
diff --git a/docs/backend_api/entities_option.js.html b/docs/backend_api/entities_option.js.html index 8acb062d1..9349f16da 100644 --- a/docs/backend_api/entities_option.js.html +++ b/docs/backend_api/entities_option.js.html @@ -78,7 +78,7 @@ module.exports = Option;
diff --git a/docs/backend_api/entities_recent_note.js.html b/docs/backend_api/entities_recent_note.js.html index 108bf9ba2..64161f6ae 100644 --- a/docs/backend_api/entities_recent_note.js.html +++ b/docs/backend_api/entities_recent_note.js.html @@ -75,7 +75,7 @@ module.exports = RecentNote;
diff --git a/docs/backend_api/global.html b/docs/backend_api/global.html index 2e3b50f0f..f24e8b242 100644 --- a/docs/backend_api/global.html +++ b/docs/backend_api/global.html @@ -594,7 +594,7 @@
diff --git a/docs/backend_api/index.html b/docs/backend_api/index.html index 6c0ee3c57..bc8a0fb26 100644 --- a/docs/backend_api/index.html +++ b/docs/backend_api/index.html @@ -56,7 +56,7 @@
diff --git a/docs/backend_api/services_backend_script_api.js.html b/docs/backend_api/services_backend_script_api.js.html index 9e790304e..4e49f4eb6 100644 --- a/docs/backend_api/services_backend_script_api.js.html +++ b/docs/backend_api/services_backend_script_api.js.html @@ -278,7 +278,7 @@ module.exports = BackendScriptApi;
diff --git a/docs/frontend_api/Branch.html b/docs/frontend_api/Branch.html index d0a24eb02..90ea874fc 100644 --- a/docs/frontend_api/Branch.html +++ b/docs/frontend_api/Branch.html @@ -719,7 +719,7 @@
diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html index 9cbffba06..dd6f5247f 100644 --- a/docs/frontend_api/FrontendScriptApi.html +++ b/docs/frontend_api/FrontendScriptApi.html @@ -81,7 +81,7 @@
Source:
@@ -221,7 +221,7 @@
Source:
@@ -334,7 +334,7 @@
Source:
@@ -444,7 +444,7 @@
Source:
@@ -573,7 +573,7 @@
Source:
@@ -726,7 +726,7 @@
Source:
@@ -879,7 +879,7 @@
Source:
@@ -1057,7 +1057,7 @@
Source:
@@ -1188,7 +1188,7 @@
Source:
@@ -1244,6 +1244,110 @@ +

getCodeMimeTypes() → {array}

+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ list of currently used code mime types +
+ + + +
+
+ Type +
+
+ +array + + +
+
+ + + + + + + + + + + + +

getCurrentNoteContent() → {string}

@@ -1292,7 +1396,7 @@
Source:
@@ -1348,6 +1452,110 @@ +

getDefaultCodeMimeTypes() → {array}

+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ list of default code mime types +
+ + + +
+
+ Type +
+
+ +array + + +
+
+ + + + + + + + + + + + +

getInstanceName() → {string}

@@ -1401,7 +1609,7 @@ if some action needs to happen on only one specific instance.
Source:
@@ -1600,7 +1808,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -1708,7 +1916,7 @@ otherwise (by e.g. createNoteLink()) - callback called on note change + callback called on note change as user is typing (not necessarily tied to save event) @@ -1749,7 +1957,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -1880,7 +2088,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -1988,7 +2196,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -2165,7 +2373,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -2217,6 +2425,137 @@ Internally this serializes the anonymous function into string and sends it to ba + + + + +

setCodeMimeTypes(types)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
types + + +array + + + + list of mime types to be used
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + @@ -2322,7 +2661,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -2457,7 +2796,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -2507,7 +2846,7 @@ Internally this serializes the anonymous function into string and sends it to ba
diff --git a/docs/frontend_api/NoteFull.html b/docs/frontend_api/NoteFull.html index 1c335ca92..5dfb0e209 100644 --- a/docs/frontend_api/NoteFull.html +++ b/docs/frontend_api/NoteFull.html @@ -279,7 +279,7 @@
diff --git a/docs/frontend_api/NoteShort.html b/docs/frontend_api/NoteShort.html index b01b6ee04..5c2f1b23e 100644 --- a/docs/frontend_api/NoteShort.html +++ b/docs/frontend_api/NoteShort.html @@ -1316,7 +1316,7 @@ Its notable omission is the note content.
diff --git a/docs/frontend_api/entities_branch.js.html b/docs/frontend_api/entities_branch.js.html index 0742712ea..8fd3106c1 100644 --- a/docs/frontend_api/entities_branch.js.html +++ b/docs/frontend_api/entities_branch.js.html @@ -76,7 +76,7 @@ export default Branch;
diff --git a/docs/frontend_api/entities_note_full.js.html b/docs/frontend_api/entities_note_full.js.html index 742f8552d..a14a9f0e0 100644 --- a/docs/frontend_api/entities_note_full.js.html +++ b/docs/frontend_api/entities_note_full.js.html @@ -64,7 +64,7 @@ export default NoteFull;
diff --git a/docs/frontend_api/entities_note_short.js.html b/docs/frontend_api/entities_note_short.js.html index c369da114..28367adff 100644 --- a/docs/frontend_api/entities_note_short.js.html +++ b/docs/frontend_api/entities_note_short.js.html @@ -128,7 +128,7 @@ export default NoteShort;
diff --git a/docs/frontend_api/global.html b/docs/frontend_api/global.html index 2e5c12b06..56e1bb957 100644 --- a/docs/frontend_api/global.html +++ b/docs/frontend_api/global.html @@ -303,7 +303,7 @@
Source:
@@ -339,7 +339,7 @@
diff --git a/docs/frontend_api/index.html b/docs/frontend_api/index.html index dfc80b998..08d878fb3 100644 --- a/docs/frontend_api/index.html +++ b/docs/frontend_api/index.html @@ -56,7 +56,7 @@
diff --git a/docs/frontend_api/services_frontend_script_api.js.html b/docs/frontend_api/services_frontend_script_api.js.html index 8b26e8a38..4cf24ebeb 100644 --- a/docs/frontend_api/services_frontend_script_api.js.html +++ b/docs/frontend_api/services_frontend_script_api.js.html @@ -33,6 +33,7 @@ import infoService from './info.js'; import linkService from './link.js'; import treeCache from './tree_cache.js'; import noteDetailService from './note_detail.js'; +import noteTypeService from './note_type.js'; /** * This is the main frontend API interface for scripts. It's published in the local "api" object. @@ -229,9 +230,27 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null) { /** * @method - * @param {function} func - callback called on note change + * @param {function} func - callback called on note change as user is typing (not necessarily tied to save event) */ this.onNoteChange = noteDetailService.onNoteChange; + + /** + * @method + * @returns {array} list of default code mime types + */ + this.getDefaultCodeMimeTypes = noteTypeService.getDefaultCodeMimeTypes; + + /** + * @method + * @returns {array} list of currently used code mime types + */ + this.getCodeMimeTypes = noteTypeService.getCodeMimeTypes; + + /** + * @method + * @param {array} types - list of mime types to be used + */ + this.setCodeMimeTypes = noteTypeService.setCodeMimeTypes; } export default FrontendScriptApi; @@ -250,7 +269,7 @@ export default FrontendScriptApi;