2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: BackendScriptApi< / 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: BackendScriptApi< / h1 >
< section >
< header >
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > BackendScriptApi< / h2 >
< / header >
< article >
< div class = "container-overview" >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line24" > line 24< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< / div >
< h3 class = "subsection-title" > Members< / h3 >
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "axios" > < span class = "type-signature" > < / span > axios< span class = "type-signature" > < / span > < / h4 >
< 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 > Axios< / code > < / td >
< td class = "type" >
< span class = "param-type" > axios< / span >
< / td >
< td class = "description last" > library for HTTP requests. See https://axios-http.com/ for documentation< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line37" > line 37< / a >
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
< h4 class = "name" id = "currentNote" > < span class = "type-signature" > < / span > currentNote< span class = "type-signature" > < / span > < / h4 >
< 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 >
2021-04-07 22:01:52 +02:00
< td class = "name" > < code > note< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
< / td >
< td class = "description last" > where script is currently executing. Don't mix this up with concept of active note< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line28" > line 28< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "dayjs" > < span class = "type-signature" > < / span > dayjs< span class = "type-signature" > < / span > < / h4 >
< 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 > day.js< / code > < / td >
< td class = "type" >
< span class = "param-type" > dayjs< / span >
< / td >
< td class = "description last" > library for date manipulation. See https://day.js.org/ for documentation< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line39" > line 39< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "originEntity" > < span class = "type-signature" > < / span > originEntity< span class = "type-signature" > < / span > < / h4 >
< 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 > entity< / code > < / td >
< td class = "type" >
2021-09-30 12:26:13 +02:00
< span class = "param-type" > Entity< / span >
2021-04-07 22:01:52 +02:00
< / td >
< td class = "description last" > whose event triggered this executions< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line30" > line 30< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "sql" > < span class = "type-signature" > < / span > sql< span class = "type-signature" > < / span > < / h4 >
< 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 > sql< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
2021-04-07 22:01:52 +02:00
< span class = "param-type" > < a href = "module-sql.html" > module:sql< / a > < / span >
2018-08-29 20:44:35 +02:00
< / td >
2021-04-07 22:01:52 +02:00
< td class = "description last" > < / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line407" > line 407< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "startNote" > < span class = "type-signature" > < / span > startNote< span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< 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 >
2021-04-07 22:01:52 +02:00
< td class = "name" > < code > note< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
2021-04-07 22:01:52 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
2018-08-29 20:44:35 +02:00
< / td >
2021-04-07 22:01:52 +02:00
< td class = "description last" > where script started executing< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line26" > line 26< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "xml2js" > < span class = "type-signature" > < / span > xml2js< span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< 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 >
2021-04-07 22:01:52 +02:00
< td class = "name" > < code > xml2js< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
2021-04-07 22:01:52 +02:00
< span class = "param-type" > axios< / span >
2018-08-29 20:44:35 +02:00
< / td >
2021-04-07 22:01:52 +02:00
< td class = "description last" > library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line41" > line 41< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "createDataNote" > < span class = "type-signature" > < / span > createDataNote< span class = "signature" > (parentNoteId, title, content)< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
2019-11-25 22:45:09 +01:00
< div class = "description" >
Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and
2019-11-28 22:35:55 +01:00
JSON MIME type. See also createNewNote() for more options.
2019-11-25 22:45:09 +01:00
< / div >
2019-02-20 22:24:51 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2019-11-25 22:45:09 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > title< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > content< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line200" > line 200< / a >
2019-11-25 22:45:09 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2021-04-07 22:01:52 +02:00
< div class = "param-desc" >
object having "note" and "branch" keys representing respective objects
< / div >
2019-11-25 22:45:09 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > Object< / span >
2019-11-25 22:45:09 +01:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "createNewNote" > < span class = "type-signature" > < / span > createNewNote< span class = "signature" > (params< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2019-11-25 22:45:09 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
2019-02-20 22:24:51 +01:00
2019-11-25 22:45:09 +01:00
< th > Type< / th >
2019-02-20 22:24:51 +01:00
2019-11-25 22:45:09 +01:00
< th > Attributes< / th >
2019-02-20 22:24:51 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
< tr >
2019-11-25 22:45:09 +01:00
< td class = "name" > < code > params< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
2019-11-28 22:35:55 +01:00
< span class = "param-type" > < a href = "global.html#CreateNewNoteParams" > CreateNewNoteParams< / a > < / span >
2018-08-29 20:44:35 +02:00
< / td >
< td class = "attributes" >
< optional>< br >
< / 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line227" > line 227< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-12-04 22:40:20 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
object contains newly created entities note and branch
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > Object< / span >
2019-12-04 22:40:20 +01:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "createNote" > < span class = "type-signature" > < / span > createNote< span class = "signature" > (parentNoteId, title, content< span class = "signature-attributes" > opt< / span > , extraOptions< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2019-12-04 22:40:20 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > create new note under this parent< / td >
< / tr >
< tr >
< td class = "name" > < code > title< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > content< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
""
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > extraOptions< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "global.html#CreateNoteExtraOptions" > CreateNoteExtraOptions< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
{}
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2020-09-30 22:48:52 +02:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > please use createTextNote() with similar API for simpler use cases or createNewNote() for more complex needs< / li > < / ul > < / dd >
2020-03-08 11:41:42 +01:00
2019-12-04 22:40:20 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line255" > line 255< / a >
2019-12-04 22:40:20 +01:00
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
object contains newly created entities note and branch
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > Object< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "createTextNote" > < span class = "type-signature" > < / span > createTextNote< span class = "signature" > (parentNoteId, title, content)< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2019-11-25 22:45:09 +01:00
< div class = "description" >
2019-11-28 22:35:55 +01:00
Create text note. See also createNewNote() for more options.
2019-11-25 22:45:09 +01:00
< / div >
< 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 > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > title< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > content< / 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line184" > line 184< / a >
2019-11-25 22:45:09 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2021-04-07 22:01:52 +02:00
< div class = "param-desc" >
- object having "note" and "branch" keys representing respective objects
< / div >
2019-11-25 22:45:09 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > Object< / span >
2019-11-25 22:45:09 +01:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "ensureNoteIsAbsentFromParent" > < span class = "type-signature" > < / span > ensureNoteIsAbsentFromParent< span class = "signature" > (noteId, parentNoteId)< / span > < span class = "type-signature" > → {void}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
If there's a branch between note and parent note, remove it. Otherwise do nothing.
< / div >
< 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 > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2021-04-07 22:01:52 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line155" > line 155< / a >
2021-04-07 22:01:52 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
< h4 class = "name" id = "ensureNoteIsPresentInParent" > < span class = "type-signature" > < / span > ensureNoteIsPresentInParent< span class = "signature" > (noteId, parentNoteId, prefix)< / span > < span class = "type-signature" > → {void}< / span > < / h4 >
< div class = "description" >
If there's no branch between note and parent note, create one. Otherwise do nothing.
< / div >
< 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 > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > prefix< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > if branch will be create between note and parent note, set this prefix< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2018-08-29 20:44:35 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line145" > line 145< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > void< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "escapeHtml" > < span class = "type-signature" > < / span > escapeHtml< span class = "signature" > (string)< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-04-07 22:01:52 +02:00
< td class = "name" > < code > string< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2021-04-07 22:01:52 +02:00
< td class = "description last" > to escape< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line395" > line 395< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
2021-04-07 22:01:52 +02:00
< div class = "param-desc" >
escaped string
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2021-04-07 22:01:52 +02:00
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2019-02-20 22:24:51 +01:00
< h4 class = "name" id = "getAppInfo" > < span class = "type-signature" > < / span > getAppInfo< span class = "signature" > ()< / span > < span class = "type-signature" > → {Object|*}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line418" > line 418< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- object representing basic info about running Trilium version
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Object< / span >
|
< span class = "param-type" > *< / span >
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getAttribute" > < span class = "type-signature" > < / span > getAttribute< span class = "signature" > (attributeId)< / span > < span class = "type-signature" > → {< a href = "Attribute.html" > Attribute< / a > |null}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< 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 > attributeId< / 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 >
2021-04-07 22:01:52 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line75" > line 75< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Attribute.html" > Attribute< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getBranch" > < span class = "type-signature" > < / span > getBranch< span class = "signature" > (branchId)< / span > < span class = "type-signature" > → {< a href = "Branch.html" > Branch< / a > |null}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< 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 > branchId< / 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 >
2021-04-07 22:01:52 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line68" > line 68< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Branch.html" > Branch< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getDateNote" > < span class = "type-signature" > < / span > getDateNote< span class = "signature" > (date)< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2019-02-20 22:24:51 +01:00
Returns day note for given date. If such note doesn't exist, it is created.
2018-08-29 20:44:35 +02:00
< / div >
< 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 > date< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2019-02-20 22:24:51 +01:00
< td class = "description last" > in YYYY-MM-DD format< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line313" > line 313< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
< h4 class = "name" id = "getInstanceName" > < span class = "type-signature" > < / span > getInstanceName< span class = "signature" > ()< / span > < span class = "type-signature" > → {string|null}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
< div class = "description" >
Instance name identifies particular Trilium instance. It can be useful for scripts
if some action needs to happen on only one specific instance.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line54" > line 54< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getMonthNote" > < span class = "type-signature" > < / span > getMonthNote< span class = "signature" > (date)< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
< div class = "description" >
Returns month note for given date. If such note doesn't exist, it is created.
< / div >
< 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 > date< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
< td class = "description last" > in YYYY-MM format< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line340" > line 340< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getNote" > < span class = "type-signature" > < / span > getNote< span class = "signature" > (noteId)< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< 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 > noteId< / 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 >
2021-04-07 22:01:52 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line61" > line 61< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getNotesWithLabel" > < span class = "type-signature" > < / span > getNotesWithLabel< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "Note.html" > Note< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
Retrieves notes with given label name & value
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > attribute name< / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > attribute value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line124" > line 124< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > Array.< < a href = "Note.html" > Note< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getNoteWithLabel" > < span class = "type-signature" > < / span > getNoteWithLabel< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
Retrieves first note with given label name & value
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > attribute name< / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > attribute value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line134" > line 134< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getRootCalendarNote" > < span class = "type-signature" > < / span > getRootCalendarNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
Returns root note of the calendar.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line304" > line 304< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-11-27 23:07:10 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
2019-11-27 23:07:10 +01:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "getTodayNote" > < span class = "type-signature" > < / span > getTodayNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
2019-11-27 23:07:10 +01:00
< div class = "description" >
Returns today's day note. If such note doesn't exist, it is created.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line321" > line 321< / a >
2021-04-07 22:01:52 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getWeekNote" > < span class = "type-signature" > < / span > getWeekNote< span class = "signature" > (date, options)< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
< div class = "description" >
Returns note for the first date of the week of the given date.
< / div >
< 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 > date< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > in YYYY-MM-DD format< / td >
< / tr >
< tr >
< td class = "name" > < code > options< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > "startOfTheWeek" - either "monday" (default) or "sunday"< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line331" > line 331< / a >
2019-11-27 23:07:10 +01:00
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "getYearNote" > < span class = "type-signature" > < / span > getYearNote< span class = "signature" > (year)< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2021-04-07 22:01:52 +02:00
Returns year note for given year. If such note doesn't exist, it is created.
2018-08-29 20:44:35 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-04-07 22:01:52 +02:00
< td class = "name" > < code > year< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
2019-02-20 22:24:51 +01:00
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
< / td >
2021-04-07 22:01:52 +02:00
< td class = "description last" > in YYYY format< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line349" > line 349< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
2019-02-20 22:24:51 +01:00
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "log" > < span class = "type-signature" > < / span > log< span class = "signature" > (message)< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2021-04-07 22:01:52 +02:00
Log given message to trilium logs.
2018-08-29 20:44:35 +02:00
< / div >
2019-02-20 22:24:51 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-04-07 22:01:52 +02:00
< td class = "name" > < code > message< / code > < / td >
2019-02-20 22:24:51 +01:00
< td class = "type" >
< / td >
2021-04-07 22:01:52 +02:00
< td class = "description last" > < / td >
2019-02-20 22:24:51 +01:00
< / tr >
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line296" > line 296< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "randomString" > < span class = "type-signature" > < / span > randomString< span class = "signature" > (length)< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
< div class = "description" >
2021-04-07 22:01:52 +02:00
Return randomly generated string of given length. This random string generation is NOT cryptographically secure.
2019-02-20 22:24:51 +01:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-04-07 22:01:52 +02:00
< td class = "name" > < code > length< / code > < / td >
2019-02-20 22:24:51 +01:00
< td class = "type" >
2021-04-07 22:01:52 +02:00
< span class = "param-type" > number< / span >
2019-02-20 22:24:51 +01:00
< / td >
2021-04-07 22:01:52 +02:00
< td class = "description last" > of the string< / td >
2019-02-20 22:24:51 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line388" > line 388< / a >
2019-03-20 22:51:13 +01:00
< / li > < / ul > < / dd >
< / dl >
2021-04-07 22:01:52 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
random string
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
2019-03-20 22:51:13 +01:00
2019-08-20 21:40:47 +02:00
2020-04-07 19:19:20 +02:00
< h4 class = "name" id = "refreshTree" > < span class = "type-signature" > < / span > refreshTree< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > - this is now no-op since all the changes should be gracefully handled per widget< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line413" > line 413< / a >
2020-04-07 19:19:20 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-03-20 22:51:13 +01:00
2021-09-30 12:26:13 +02:00
< h4 class = "name" id = "searchForNote" > < span class = "type-signature" > < / span > searchForNote< span class = "signature" > (query, searchParams< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "Note.html" > Note< / a > |null}< / span > < / h4 >
2019-03-20 22:51:13 +01:00
< div class = "description" >
This is a powerful search method - you can search by attributes and their values, e.g.:
2020-09-30 22:48:30 +02:00
"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
2019-03-20 22:51:13 +01:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2021-09-30 12:26:13 +02:00
< th > Attributes< / th >
2019-03-20 22:51:13 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-09-30 12:26:13 +02:00
< td class = "name" > < code > query< / code > < / td >
2019-03-20 22:51:13 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2021-09-30 12:26:13 +02:00
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > searchParams< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2019-03-20 22:51:13 +01:00
< 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line110" > line 110< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-03-20 22:51:13 +01:00
< h5 > Returns:< / h5 >
2019-04-22 18:08:33 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
|
< span class = "param-type" > null< / span >
2019-04-22 18:08:33 +02:00
< / dd >
< / dl >
2021-02-17 23:55:51 +01:00
< h4 class = "name" id = "searchForNotes" > < span class = "type-signature" > < / span > searchForNotes< span class = "signature" > (query, searchParams< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "Note.html" > Note< / a > >}< / span > < / h4 >
2019-04-22 18:08:33 +02:00
< div class = "description" >
This is a powerful search method - you can search by attributes and their values, e.g.:
2020-09-30 22:48:30 +02:00
"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
2019-03-20 22:51:13 +01:00
< / div >
2019-04-22 18:08:33 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2020-09-30 22:48:30 +02:00
< th > Attributes< / th >
2019-04-22 18:08:33 +02:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-09-30 22:48:30 +02:00
< td class = "name" > < code > query< / code > < / td >
2019-04-22 18:08:33 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2020-09-30 22:48:30 +02:00
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
2021-02-17 23:55:51 +01:00
< td class = "name" > < code > searchParams< / code > < / td >
2020-09-30 22:48:30 +02:00
< td class = "type" >
2021-02-17 23:55:51 +01:00
< span class = "param-type" > Object< / span >
2020-09-30 22:48:30 +02:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2019-04-22 18:08:33 +02:00
< 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line86" > line 86< / a >
2019-04-22 18:08:33 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-22 18:08:33 +02:00
< h5 > Returns:< / h5 >
2019-03-20 22:51:13 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > Array.< < a href = "Note.html" > Note< / a > >< / span >
2019-03-20 22:51:13 +01:00
< / dd >
< / dl >
2019-02-20 22:24:51 +01:00
2018-08-29 20:44:35 +02:00
2019-11-10 19:34:15 +01:00
< h4 class = "name" id = "setNoteToParent" > < span class = "type-signature" > < / span > setNoteToParent< span class = "signature" > (noteId, prefix, parentNoteId)< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
This method finds note by its noteId and prefix and either sets it to the given parentNoteId
or removes the branch (if parentNoteId is not given).
This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix.
< / div >
< 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 > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > prefix< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
2019-11-10 19:34:15 +01:00
|
2018-08-29 20:44:35 +02:00
2019-11-10 19:34:15 +01:00
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
2019-11-10 19:34:15 +01:00
< / td >
2018-08-29 20:44:35 +02:00
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2019-11-10 19:34:15 +01:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > - this method is pretty confusing and serves specialized purpose only< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line369" > line 369< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "sortNotesByTitle" > < span class = "type-signature" > < / span > sortNotesByTitle< span class = "signature" > (parentNoteId)< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< 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 > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > this note's child notes will be sorted< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line355" > line 355< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "toggleNoteInParent" > < span class = "type-signature" > < / span > toggleNoteInParent< span class = "signature" > (present, noteId, parentNoteId, prefix)< / span > < span class = "type-signature" > → {void}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
Based on the value, either create or remove branch between note and parent note.
< / div >
< 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 > present< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true if we want the branch to exist, false if we want it gone< / td >
< / tr >
< tr >
< td class = "name" > < code > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > prefix< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > if branch will be create between note and parent note, set this prefix< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line167" > line 167< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > void< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
< h4 class = "name" id = "transactional" > < span class = "type-signature" > < / span > transactional< span class = "signature" > (func)< / span > < span class = "type-signature" > → {?}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
This functions wraps code which is supposed to be running in transaction. If transaction already
exists, then we'll use that transaction.
< / div >
< 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 > func< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line379" > line 379< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
result of func callback
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-09-30 22:48:30 +02:00
< span class = "param-type" > ?< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "unescapeHtml" > < span class = "type-signature" > < / span > unescapeHtml< span class = "signature" > (string)< / span > < span class = "type-signature" > → {string}< / 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 > string< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > to unescape< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line402" > line 402< / a >
2021-04-07 22:01:52 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
unescaped string
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
< / article >
< / section >
< / div >
< nav >
2021-09-30 12:26:13 +02:00
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Modules< / h3 > < ul > < li > < a href = "module-sql.html" > sql< / a > < / li > < / ul > < h3 > Classes< / h3 > < ul > < li > < a href = "ApiToken.html" > ApiToken< / a > < / li > < li > < a href = "BackendScriptApi.html" > BackendScriptApi< / 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 >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2021-09-30 12:26:13 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 3.6.7< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
