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 >
2023-02-17 16:15:58 +01:00
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > BackendScriptApi< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h2 >
2018-08-29 20:44:35 +02:00
< / header >
< article >
< div class = "container-overview" >
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "BackendScriptApi" > < span class = "type-signature" > < / span > new BackendScriptApi< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< div class = "description" >
2023-09-06 09:25:00 +02:00
< p > This is the main backend API interface for scripts. All the properties and methods are published in the "api" object
available in the JS backend notes. You can use e.g. < code > api.log(api.startNote.title);< / code > < / p >
2023-02-17 16:15:58 +01:00
< / div >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line44" > line 44< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< / div >
< h3 class = "subsection-title" > Members< / h3 >
2023-01-03 15:02:01 +01:00
< h4 class = "name" id = "__private" > < span class = "type-signature" > < / span > __private< span class = "type-signature" > < / span > < / h4 >
2022-06-02 17:25:58 +02:00
< div class = "description" >
This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.
< / div >
2023-01-03 15:02:01 +01: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 >
< td class = "name" > < code > becca< / code > < / td >
< td class = "type" >
2022-06-02 17:25:58 +02:00
2023-01-03 15:02:01 +01:00
< span class = "param-type" > Becca< / span >
2022-06-02 17:25:58 +02:00
2023-01-03 15:02:01 +01:00
< / td >
2022-06-02 17:25:58 +02:00
2023-01-03 15:02:01 +01:00
< td class = "description last" > provides access to the backend in-memory object graph, see < a href = "https://github.com/zadam/trilium/blob/master/src/becca/becca.js" > https://github.com/zadam/trilium/blob/master/src/becca/becca.js< / a > < / td >
< / tr >
< / tbody >
< / table >
2022-06-02 17:25:58 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line679" > line 679< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-02 17:25:58 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "axios" > < span class = "type-signature" > < / span > axios< span class = "type-signature" > :axios< / span > < / h4 >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
Axios library for HTTP requests. See < a href = "https://axios-http.com" > https://axios-http.com< / a > for documentation
< / div >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2021-04-07 22:01:52 +02:00
< span class = "param-type" > axios< / span >
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2021-04-07 22:01:52 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > use native (browser compatible) fetch() instead< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line70" > line 70< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "currentNote" > < span class = "type-signature" > < / span > currentNote< span class = "type-signature" > :< a href = "BNote.html" > BNote< / a > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
Note where the script is currently executing. Don't mix this up with the concept of active note
< / div >
2018-08-29 20:44:35 +02:00
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2021-04-07 22:01:52 +02:00
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2021-04-07 22:01:52 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01: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 >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "dayjs" > < span class = "type-signature" > < / span > dayjs< span class = "type-signature" > :dayjs< / span > < / h4 >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
day.js library for date manipulation. See < a href = "https://day.js.org" > https://day.js.org< / a > for documentation
< / div >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2021-04-07 22:01:52 +02:00
< span class = "param-type" > dayjs< / span >
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2021-04-07 22:01:52 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01: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 >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "originEntity" > < span class = "type-signature" > < / span > originEntity< span class = "type-signature" > :< a href = "AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > < / span > < / h4 >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
Entity whose event triggered this execution
< / div >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2021-04-07 22:01:52 +02:00
2023-02-17 16:15:58 +01:00
< span class = "param-type" > < a href = "AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > < / span >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2021-04-07 22:01:52 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line59" > line 59< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "sql" > < span class = "type-signature" > < / span > sql< span class = "type-signature" > :< a href = "module-sql.html" > module:sql< / a > < / span > < / h4 >
2021-04-07 22:01:52 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
sql
< / div >
2021-04-07 22:01:52 +02:00
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2018-08-29 20:44:35 +02:00
2022-01-14 19:53:59 +01:00
< span class = "param-type" > < a href = "module-sql.html" > module:sql< / a > < / span >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line516" > line 516< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "startNote" > < span class = "type-signature" > < / span > startNote< span class = "type-signature" > :< a href = "BNote.html" > BNote< / a > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
Note where the script started executing
< / div >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2018-08-29 20:44:35 +02:00
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line49" > line 49< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-02-20 22:24:51 +01:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "xml2js" > < span class = "type-signature" > < / span > xml2js< span class = "type-signature" > :xml2js< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
xml2js library for XML parsing. See < a href = "https://github.com/Leonidas-from-XIV/node-xml2js" > https://github.com/Leonidas-from-XIV/node-xml2js< / a > for documentation
< / div >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< span class = "param-type" > xml2js< / span >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line80" > line 80< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-02-20 22:24:51 +01:00
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
2023-11-21 20:46:48 +01:00
< h4 class = "name" id = "backupNow" > < span class = "type-signature" > < / span > backupNow< span class = "signature" > (backupName)< / span > < span class = "type-signature" > → {Promise}< / 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 > backupName< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file< / 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#line672" > line 672< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- resolves once the backup is finished
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise< / span >
< / dd >
< / dl >
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" >
2023-09-06 09:25:00 +02:00
Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and
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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line276" > line 276< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-11-25 22:45:09 +01:00
< / 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 >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "createNewNote" > < span class = "type-signature" > < / span > createNewNote< span class = "signature" > (params)< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2019-11-25 22:45:09 +01:00
2023-08-21 04:17:16 -04:00
< h5 > Parameters:< / h5 >
2019-11-25 22:45:09 +01:00
2023-08-21 04:17:16 -04:00
< table class = "params" >
2019-11-25 22:45:09 +01:00
< 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
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" >
2023-01-03 14:31:46 +01:00
< span class = "param-type" > object< / span >
2018-08-29 20:44:35 +02:00
< / td >
2023-01-03 14:31:46 +01:00
< td class = "description last" >
< h6 > Properties< / h6 >
2023-08-21 04:17:16 -04:00
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< table class = "params" >
2023-01-03 14:31:46 +01:00
< thead >
< tr >
< th > Name< / th >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< th > Type< / th >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< th > Attributes< / th >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< th > Default< / th >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< tbody >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< td class = "attributes" >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< td class = "default" >
< / td >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< td class = "description last" > < / td >
< / tr >
2018-08-29 20:44:35 +02:00
2019-08-20 21:40:47 +02:00
2023-01-03 14:31:46 +01:00
< tr >
< td class = "name" > < code > title< / code > < / td >
2019-08-20 21:40:47 +02:00
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "attributes" >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "default" >
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "description last" > < / td >
< / tr >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< tr >
< td class = "name" > < code > content< / code > < / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
|
2019-12-04 22:40:20 +01:00
2023-08-21 04:17:16 -04:00
< span class = "param-type" > Buffer< / span >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "attributes" >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "default" >
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "description last" > < / td >
< / tr >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< tr >
< td class = "name" > < code > type< / code > < / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#NoteType" > NoteType< / a > < / span >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "attributes" >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "default" >
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "description last" > text, code, file, image, search, book, relationMap, canvas< / td >
< / tr >
2019-12-04 22:40:20 +01:00
< tr >
2023-01-03 14:31:46 +01:00
< td class = "name" > < code > mime< / code > < / td >
2019-12-04 22:40:20 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
2023-01-03 14:31:46 +01:00
< optional>< br >
2019-12-04 22:40:20 +01:00
2023-08-21 04:17:16 -04:00
2019-12-04 22:40:20 +01:00
< / td >
< td class = "default" >
< / td >
2023-01-03 14:31:46 +01:00
< td class = "description last" > value is derived from default mimes for type< / td >
2019-12-04 22:40:20 +01:00
< / tr >
< tr >
2023-01-03 14:31:46 +01:00
< td class = "name" > < code > isProtected< / code > < / td >
2019-12-04 22:40:20 +01:00
< td class = "type" >
2023-01-03 14:31:46 +01:00
< span class = "param-type" > boolean< / span >
2019-12-04 22:40:20 +01:00
< / td >
< td class = "attributes" >
2023-01-03 14:31:46 +01:00
< optional>< br >
2019-12-04 22:40:20 +01:00
2023-08-21 04:17:16 -04:00
2019-12-04 22:40:20 +01:00
< / td >
< td class = "default" >
2023-01-03 14:31:46 +01:00
false
2019-12-04 22:40:20 +01:00
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
2023-01-03 14:31:46 +01:00
< td class = "name" > < code > isExpanded< / code > < / td >
2019-12-04 22:40:20 +01:00
< td class = "type" >
2023-01-03 14:31:46 +01:00
< span class = "param-type" > boolean< / span >
2019-12-04 22:40:20 +01:00
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2019-12-04 22:40:20 +01:00
< / td >
< td class = "default" >
2023-01-03 14:31:46 +01:00
false
2019-12-04 22:40:20 +01:00
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
2023-01-03 14:31:46 +01:00
< td class = "name" > < code > prefix< / code > < / td >
2019-12-04 22:40:20 +01:00
< td class = "type" >
2023-01-03 14:31:46 +01:00
< span class = "param-type" > string< / span >
2019-12-04 22:40:20 +01:00
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2019-12-04 22:40:20 +01:00
< / td >
< td class = "default" >
2023-01-03 14:31:46 +01:00
''
2019-12-04 22:40:20 +01:00
< / td >
< td class = "description last" > < / td >
< / tr >
2023-01-03 14:31:46 +01:00
< tr >
< td class = "name" > < code > notePosition< / code > < / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#int" > int< / a > < / span >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< / td >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
< / td >
< td class = "description last" > default is last existing notePosition in a parent + 10< / td >
< / tr >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< / tbody >
< / table >
< / td >
< / tr >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
< / tbody >
< / table >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< dl class = "details" >
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
2020-03-08 11:41:42 +01:00
2019-12-04 22:40:20 +01:00
2023-01-03 14:31:46 +01:00
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line299" > line 299< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-12-04 22:40:20 +01:00
< / 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 >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +01: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 >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +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" > object< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
{}
< / td >
2023-08-21 04:17:16 -04:00
< td class = "description last" >
< h6 > Properties< / h6 >
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
< table class = "params" >
2023-01-03 14:31:46 +01:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > json< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > should the note be JSON< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > isProtected< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > should the note be protected< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > type< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
'text'
< / td >
< td class = "description last" > note type< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > mime< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
'text/html'
< / td >
< td class = "description last" > MIME type of the note< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > attributes< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > Array.< object>< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
[]
< / td >
< td class = "description last" > attributes to be created for this note
< h6 > Properties< / h6 >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
< table class = "params" >
2023-01-03 14:31:46 +01:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#AttributeType" > AttributeType< / a > < / span >
2023-01-03 14:31:46 +01:00
< / td >
< td class = "attributes" >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "description last" > attribute type - label, relation etc.< / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / 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 >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "description last" > attribute value< / td >
< / tr >
< / tbody >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
2023-08-21 04:17:16 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2023-01-03 14:31:46 +01:00
< dl class = "details" >
< 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 >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line319" > line 319< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2023-01-03 14:31:46 +01:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
object contains newly created entities note and branch
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Object< / span >
< / dd >
< / dl >
< h4 class = "name" id = "createOrUpdateLauncher" > < span class = "type-signature" > < / span > createOrUpdateLauncher< span class = "signature" > (opts)< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
< div class = "description" >
Creates a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.
< / 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 > opts< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2023-08-21 04:17:16 -04:00
< td class = "description last" >
< h6 > Properties< / h6 >
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
< table class = "params" >
2023-01-03 14:31:46 +01:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > id< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
< / td >
< td class = "description last" > id of the launcher, only alphanumeric at least 6 characters long< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > type< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > "note"< / span >
|
< span class = "param-type" > "script"< / span >
|
< span class = "param-type" > "customWidget"< / span >
2023-01-03 14:31:46 +01:00
< / td >
< td class = "attributes" >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
< / td >
2023-09-06 09:25:00 +02:00
< td class = "description last" > one of
* "note" - activating the launcher will navigate to the target note (specified in targetNoteId param)
* "script" - activating the launcher will execute the script (specified in scriptNoteId param)
* "customWidget" - the launcher will be rendered with a custom widget (specified in widgetNoteId param)< / td >
2023-01-03 14:31:46 +01:00
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > title< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > isVisible< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > if true, will be created in the "Visible launchers", otherwise in "Available launchers"< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > icon< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
< / td >
< td class = "description last" > name of the boxicon to be used (e.g. "bx-time")< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > keyboardShortcut< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
< / td >
< td class = "description last" > will activate the target note/script upon pressing, e.g. "ctrl+e"< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > targetNoteId< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
< / td >
< td class = "description last" > for type "note"< / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > scriptNoteId< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +01:00
< / td >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +01:00
< td class = "attributes" >
< optional>< br >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +01:00
< td class = "default" >
< / td >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +01:00
< td class = "description last" > for type "script"< / td >
< / tr >
2022-12-22 14:57:00 +01:00
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > widgetNoteId< / code > < / td >
2022-12-22 14:57:00 +01:00
< td class = "type" >
2023-01-03 14:31:46 +01:00
< span class = "param-type" > string< / span >
2022-12-22 14:57:00 +01:00
< / td >
2023-01-03 14:31:46 +01:00
< td class = "attributes" >
< optional>< br >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2022-12-22 14:57:00 +01:00
2023-01-03 14:31:46 +01:00
< td class = "default" >
< / td >
< td class = "description last" > for type "customWidget"< / td >
2022-12-22 14:57:00 +01:00
< / tr >
< / tbody >
< / table >
2023-08-21 04:17:16 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2022-12-22 14:57:00 +01:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line543" > line 543< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-12-22 14:57:00 +01:00
< / dl >
2023-01-03 14:31:46 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Object< / span >
< / dd >
< / dl >
2022-12-22 14:57:00 +01:00
2018-08-29 20:44:35 +02:00
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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line259" > line 259< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-11-25 22:45:09 +01:00
< / 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" >
2022-01-10 19:54:38 +01:00
If there's a branch between note and parent note, remove it. Otherwise, do nothing.
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 > 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
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line236" > line 236< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
2023-05-31 14:00:37 +02:00
< h4 class = "name" id = "ensureNoteIsPresentInParent" > < span class = "type-signature" > < / span > ensureNoteIsPresentInParent< span class = "signature" > (noteId, parentNoteId, prefix)< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2021-04-07 22:01:52 +02:00
< div class = "description" >
2023-05-31 14:00:37 +02:00
If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.
2021-04-07 22:01:52 +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 > 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 >
2023-07-15 12:07:45 +02:00
< td class = "description last" > if branch is created between note and parent note, set this prefix< / td >
2021-04-07 22:01:52 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line226" > line 226< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-05-31 14:00:37 +02:00
< span class = "param-type" > Object< / 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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line503" > line 503< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2022-12-29 21:15:34 +01:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "exportSubtreeToZipFile" > < span class = "type-signature" > < / span > exportSubtreeToZipFile< span class = "signature" > (noteId, format, zipFilePath)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
2022-12-29 21:15:34 +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 >
< 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 > format< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > either 'html' or 'markdown'< / td >
< / tr >
< tr >
< td class = "name" > < code > zipFilePath< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line609" > line 609< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-12-29 21:15:34 +01:00
< / dl >
2023-01-03 13:54:27 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > Promise.< void>< / span >
2023-01-03 13:54:27 +01:00
< / dd >
< / dl >
2022-12-29 21:15:34 +01:00
2018-08-29 20:44:35 +02:00
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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line522" > line 522< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-02-20 22:24:51 +01:00
< / 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 >
2023-10-31 22:26:56 +01:00
< h4 class = "name" id = "getAttachment" > < span class = "type-signature" > < / span > getAttachment< span class = "signature" > (attachmentId)< / span > < span class = "type-signature" > → {< a href = "BAttachment.html" > BAttachment< / 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 >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > attachmentId< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line116" > line 116< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > < a href = "BAttachment.html" > BAttachment< / a > < / span >
2020-09-30 22:48:30 +02:00
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-10-31 22:26:56 +01:00
< h4 class = "name" id = "getAttribute" > < span class = "type-signature" > < / span > getAttribute< span class = "signature" > (attributeId)< / span > < span class = "type-signature" > → {< a href = "BAttribute.html" > BAttribute< / 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 >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > attributeId< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line109" > line 109< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-01-10 19:54:38 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > < a href = "BAttribute.html" > BAttribute< / a > < / span >
2022-01-10 19:54:38 +01:00
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
2023-10-31 22:26:56 +01:00
< h4 class = "name" id = "getAttribute" > < span class = "type-signature" > < / span > getAttribute< span class = "signature" > (attributeId)< / span > < span class = "type-signature" > → {< a href = "BAttribute.html" > BAttribute< / a > |null}< / span > < / h4 >
2022-01-10 19:54:38 +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 >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > attributeId< / code > < / td >
2022-01-10 19:54:38 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-10-26 16:52:00 +02:00
2022-01-10 19:54:38 +01:00
2023-10-31 22:26:56 +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 >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line156" > line 156< / a >
2023-10-31 22:26:56 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "BAttribute.html" > BAttribute< / a > < / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
2022-01-10 19:54:38 +01:00
2023-10-31 22:26:56 +01:00
< h4 class = "name" id = "getBranch" > < span class = "type-signature" > < / span > getBranch< span class = "signature" > (branchId)< / span > < span class = "type-signature" > → {< a href = "BBranch.html" > BBranch< / a > |null}< / span > < / h4 >
2022-01-10 19:54:38 +01:00
2023-10-31 22:26:56 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2022-01-10 19:54:38 +01:00
2022-10-26 16:52:00 +02:00
< tr >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > branchId< / code > < / td >
2022-10-26 16:52:00 +02:00
< td class = "type" >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > string< / span >
2022-10-26 16:52:00 +02:00
< / td >
2023-10-31 22:26:56 +01:00
< td class = "description last" > < / td >
2022-10-26 16:52:00 +02:00
< / tr >
2022-01-10 19:54:38 +01:00
< / tbody >
< / table >
< dl class = "details" >
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line102" > line 102< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
2023-10-31 22:26:56 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "BBranch.html" > BBranch< / a > < / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getDayNote" > < span class = "type-signature" > < / span > getDayNote< span class = "signature" > (date, rootNote< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "BNote.html" > BNote< / a > |null}< / span > < / h4 >
< div class = "description" >
Returns day 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 > Attributes< / 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 = "attributes" >
< / td >
< td class = "description last" > in YYYY-MM-DD format< / td >
< / tr >
< tr >
< td class = "name" > < code > rootNote< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > specify calendar root note, normally leave empty to use the default calendar< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01: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 >
2023-10-31 22:26:56 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getEtapiToken" > < span class = "type-signature" > < / span > getEtapiToken< span class = "signature" > (etapiTokenId)< / span > < span class = "type-signature" > → {< a href = "BEtapiToken.html" > BEtapiToken< / a > |null}< / 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 > etapiTokenId< / 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 >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line130" > line 130< / a >
2023-10-31 22:26:56 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "BEtapiToken.html" > BEtapiToken< / a > < / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getEtapiTokens" > < span class = "type-signature" > < / span > getEtapiTokens< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "BEtapiToken.html" > BEtapiToken< / a > >}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line136" > line 136< / a >
2023-10-31 22:26:56 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< < a href = "BEtapiToken.html" > BEtapiToken< / a > >< / span >
< / 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 >
< 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 >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line88" > line 88< / a >
2023-10-31 22:26:56 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getMonthNote" > < span class = "type-signature" > < / span > getMonthNote< span class = "signature" > (date, rootNote< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "BNote.html" > BNote< / a > |null}< / span > < / h4 >
< div class = "description" >
Returns month note for given date. If such a note doesn't exist, it is created.
< / 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 > date< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > in YYYY-MM format< / td >
< / tr >
< tr >
< td class = "name" > < code > rootNote< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > specify calendar root note, normally leave empty to use the default calendar< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line433" > line 433< / a >
2023-10-31 22:26:56 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getNote" > < span class = "type-signature" > < / span > getNote< span class = "signature" > (noteId)< / span > < span class = "type-signature" > → {< a href = "BNote.html" > BNote< / a > |null}< / 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 > 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 >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line95" > line 95< / a >
2023-10-31 22:26:56 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
< 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 = "BNote.html" > BNote< / a > |null}< / span > < / h4 >
< 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 >
2018-08-29 20:44:35 +02:00
2020-09-30 22:48:30 +02:00
2023-10-31 22:26:56 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< tbody >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< td class = "attributes" >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< td class = "description last" > attribute name< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< tr >
< td class = "name" > < code > value< / code > < / td >
2018-08-29 20:44:35 +02:00
2023-10-31 22:26:56 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2019-02-20 22:24:51 +01:00
2023-10-31 22:26:56 +01:00
< / td >
2019-02-20 22:24:51 +01:00
2023-10-31 22:26:56 +01:00
< td class = "attributes" >
< optional>< br >
2019-02-20 22:24:51 +01:00
2023-10-31 22:26:56 +01:00
2019-02-20 22:24:51 +01:00
2023-10-31 22:26:56 +01:00
< / td >
2019-02-20 22:24:51 +01:00
2023-10-31 22:26:56 +01:00
2019-02-20 22:24:51 +01:00
2023-10-31 22:26:56 +01:00
< td class = "description last" > attribute value< / td >
< / tr >
2019-02-20 22:24:51 +01:00
2023-10-31 22:26:56 +01:00
< / tbody >
< / table >
2019-02-20 22:24:51 +01:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line215" > line 215< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-02-20 22:24:51 +01:00
< / 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 >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2019-02-20 22:24:51 +01:00
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
2023-10-31 22:26:56 +01: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 = "BNote.html" > BNote< / a > >}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
< div class = "description" >
2023-10-31 22:26:56 +01:00
Retrieves notes with given label name & value
2019-02-20 22:24:51 +01:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-10-26 16:52:00 +02:00
< th > Attributes< / th >
2019-02-20 22:24:51 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > name< / code > < / td >
2019-02-20 22:24:51 +01:00
< 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
2022-10-26 16:52:00 +02:00
< td class = "attributes" >
< / 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
2023-10-31 22:26:56 +01:00
< td class = "description last" > attribute name< / td >
2019-02-20 22:24:51 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2019-02-20 22:24:51 +01:00
2022-10-26 16:52:00 +02:00
< tr >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > value< / code > < / td >
2022-10-26 16:52:00 +02:00
< td class = "type" >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > string< / span >
2022-10-26 16:52:00 +02:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2023-10-31 22:26:56 +01:00
< td class = "description last" > attribute value< / td >
2022-10-26 16:52:00 +02:00
< / tr >
2019-02-20 22:24:51 +01:00
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line205" > line 205< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > Array.< < a href = "BNote.html" > BNote< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-10-31 22:26:56 +01:00
< h4 class = "name" id = "getOption" > < span class = "type-signature" > < / span > getOption< span class = "signature" > (optionName)< / span > < span class = "type-signature" > → {< a href = "BOption.html" > BOption< / 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 >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > optionName< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line143" > line 143< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > < a href = "BOption.html" > BOption< / a > < / span >
2020-09-30 22:48:30 +02:00
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-10-31 22:26:56 +01:00
< h4 class = "name" id = "getOptions" > < span class = "type-signature" > < / span > getOptions< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "BOption.html" > BOption< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line149" > line 149< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > Array.< < a href = "BOption.html" > BOption< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-10-31 22:26:56 +01:00
< h4 class = "name" id = "getRevision" > < span class = "type-signature" > < / span > getRevision< span class = "signature" > (revisionId)< / span > < span class = "type-signature" > → {< a href = "BRevision.html" > BRevision< / 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 >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > revisionId< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2023-10-31 22:26:56 +01:00
< td class = "description last" > < / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line123" > line 123< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > < a href = "BRevision.html" > BRevision< / a > < / span >
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getRootCalendarNote" > < span class = "type-signature" > < / span > getRootCalendarNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "BNote.html" > BNote< / 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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line392" > line 392< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2020-09-30 22:48:30 +02:00
|
< span class = "param-type" > null< / span >
2019-11-27 23:07:10 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getTodayNote" > < span class = "type-signature" > < / span > getTodayNote< span class = "signature" > (rootNote< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "BNote.html" > BNote< / 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 >
2022-10-26 16:52:00 +02:00
< 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 > rootNote< / code > < / td >
< td class = "type" >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2022-10-26 16:52:00 +02:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2023-02-17 16:15:58 +01:00
< td class = "description last" > specify calendar root note, normally leave empty to use the default calendar< / td >
2022-10-26 16:52:00 +02:00
< / tr >
< / tbody >
< / table >
2019-11-27 23:07:10 +01:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line411" > line 411< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2021-04-07 22:01:52 +02:00
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getWeekNote" > < span class = "type-signature" > < / span > getWeekNote< span class = "signature" > (date, options< span class = "signature-attributes" > opt< / span > , rootNote< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "BNote.html" > BNote< / a > |null}< / span > < / h4 >
2021-04-07 22:01:52 +02:00
< 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 >
2022-10-26 16:52:00 +02:00
< th > Attributes< / th >
2021-04-07 22:01:52 +02:00
< 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 >
2022-10-26 16:52:00 +02:00
< td class = "attributes" >
< / td >
2021-04-07 22:01:52 +02:00
< 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 >
2022-10-26 16:52:00 +02:00
< td class = "attributes" >
< optional>< br >
< / td >
2021-04-07 22:01:52 +02:00
2023-02-17 16:15:58 +01:00
< td class = "description last" >
< h6 > Properties< / h6 >
2022-10-26 16:52:00 +02:00
2023-02-17 16:15:58 +01:00
< 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 > startOfTheWeek< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
monday
< / td >
< td class = "description last" > either "monday" (default) or "sunday"< / td >
< / tr >
< / tbody >
< / table >
2022-10-26 16:52:00 +02:00
2023-02-17 16:15:58 +01:00
< / td >
< / tr >
< tr >
< td class = "name" > < code > rootNote< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2022-10-26 16:52:00 +02:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2023-02-17 16:15:58 +01:00
< td class = "description last" > specify calendar root note, normally leave empty to use the default calendar< / td >
2022-10-26 16:52:00 +02:00
< / tr >
2021-04-07 22:01:52 +02:00
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line423" > line 423< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-11-27 23:07:10 +01:00
< / dl >
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2020-09-30 22:48:30 +02:00
|
< span class = "param-type" > null< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getYearNote" > < span class = "type-signature" > < / span > getYearNote< span class = "signature" > (year, rootNote< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {< a href = "BNote.html" > BNote< / a > |null}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2023-10-31 22:26:56 +01:00
Returns year note for given year. If such a 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 >
2022-10-26 16:52:00 +02:00
< th > Attributes< / th >
2018-08-29 20:44:35 +02:00
< 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 >
2022-10-26 16:52:00 +02:00
< td class = "attributes" >
< / td >
2018-08-29 20:44:35 +02:00
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 >
2022-10-26 16:52:00 +02:00
< tr >
< td class = "name" > < code > rootNote< / code > < / td >
< td class = "type" >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2022-10-26 16:52:00 +02:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2023-02-17 16:15:58 +01:00
< td class = "description last" > specify calendar root note, normally leave empty to use the default calendar< / td >
2022-10-26 16:52:00 +02:00
< / tr >
2018-08-29 20:44:35 +02:00
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line443" > line 443< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2020-09-30 22:48:30 +02:00
|
< span class = "param-type" > null< / span >
2019-02-20 22:24:51 +01:00
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "log" > < span class = "type-signature" > < / span > log< span class = "signature" > (message)< / span > < span class = "type-signature" > → {void}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2022-10-26 16:52:00 +02:00
Log given message to trilium logs and log pane in UI
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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line365" > line 365< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
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
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#int" > int< / a > < / span >
2021-04-07 22:01:52 +02:00
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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line496" > line 496< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-03-20 22:51:13 +01:00
< / 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
2019-03-20 22:51:13 +01:00
2023-09-06 09:25:00 +02:00
< h4 class = "name" id = "runOnFrontend" > < span class = "type-signature" > < / span > runOnFrontend< span class = "signature" > (script, params)< / span > < span class = "type-signature" > → {undefined}< / span > < / h4 >
< div class = "description" >
Executes given anonymous function on the frontend(s).
2023-10-31 22:26:56 +01:00
Internally, this serializes the anonymous function into string and sends it to frontend(s) via WebSocket.
2023-09-06 09:25:00 +02:00
Note that there can be multiple connected frontend instances (e.g. in different tabs). In such case, all
instances execute the given function.
< / 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 > script< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > script to be executed on the frontend< / td >
< / tr >
< tr >
< td class = "name" > < code > params< / code > < / td >
< td class = "type" >
< span class = "param-type" > Array.< ?>< / span >
< / td >
< td class = "description last" > list of parameters to the anonymous function to be sent to frontend< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line622" > line 622< / a >
2023-09-06 09:25:00 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- no return value is provided.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > undefined< / span >
< / dd >
< / dl >
2023-10-24 00:13:20 +02:00
< h4 class = "name" id = "runOutsideOfSync" > < span class = "type-signature" > < / span > runOutsideOfSync< span class = "signature" > (callback)< / span > < span class = "type-signature" > → {Promise}< / span > < / h4 >
< div class = "description" >
Sync process can make data intermittently inconsistent. Scripts which require strong data consistency
can use this function to wait for a possible sync process to finish and prevent new sync process from starting
while it is running.
Because this is an async process, the inner callback doesn't have automatic transaction handling, so in case
you need to make some DB changes, you need to surround your call with api.transactional(...)
< / 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 > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "description last" > function to be executed while sync process is not running< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line665" > line 665< / a >
2023-10-24 00:13:20 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- resolves once the callback is finished (callback is awaited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise< / span >
< / dd >
< / dl >
2023-01-03 13:54:27 +01: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 = "BNote.html" > BNote< / a > |null}< / span > < / h4 >
2019-03-20 22:51:13 +01:00
< div class = "description" >
2023-09-06 09:25:00 +02:00
This is a powerful search method - you can search by attributes and their values, e.g.:
"#dateModified =* MONTH AND #log". See < a href = "https://github.com/zadam/trilium/wiki/Search" > https://github.com/zadam/trilium/wiki/Search< / a > for full documentation for all options
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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line191" > line 191< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-02-20 22:24:51 +01:00
< / 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 >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "BNote.html" > BNote< / a > < / span >
2020-09-30 22:48:30 +02:00
|
< span class = "param-type" > null< / span >
2019-04-22 18:08:33 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +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 = "BNote.html" > BNote< / a > >}< / span > < / h4 >
2019-04-22 18:08:33 +02:00
< div class = "description" >
2023-09-06 09:25:00 +02:00
This is a powerful search method - you can search by attributes and their values, e.g.:
"#dateModified =* MONTH AND #log". See < a href = "https://github.com/zadam/trilium/wiki/Search" > https://github.com/zadam/trilium/wiki/Search< / a > for full documentation for all options
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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01: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 >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-04-22 18:08:33 +02:00
< / 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 >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Array.< < a href = "BNote.html" > BNote< / 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
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "setNoteToParent" > < span class = "type-signature" > < / span > setNoteToParent< span class = "signature" > (noteId, prefix, parentNoteId)< / span > < span class = "type-signature" > → {void}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2023-09-06 09:25:00 +02:00
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.
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 > 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" >
2023-02-17 16:15:58 +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 >
2019-11-10 19:34:15 +01:00
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line477" > line 477< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-12-25 13:03:22 +01:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
2022-12-25 13:03:22 +01:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "sortNotes" > < span class = "type-signature" > < / span > sortNotes< span class = "signature" > (parentNoteId, sortConfig< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {void}< / span > < / h4 >
2022-12-25 13:03:22 +01:00
< div class = "description" >
Sort child notes of a given note.
< / 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 > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > this note's child notes will be sorted< / td >
< / tr >
< tr >
< td class = "name" > < code > sortConfig< / code > < / td >
< td class = "type" >
2023-01-03 14:31:46 +01:00
< span class = "param-type" > object< / span >
2022-12-25 13:03:22 +01:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2023-08-21 04:17:16 -04:00
< td class = "description last" >
< h6 > Properties< / h6 >
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
< table class = "params" >
2023-01-03 14:31:46 +01:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > sortBy< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
title
< / td >
2023-09-06 09:25:00 +02:00
< td class = "description last" > 'title', 'dateCreated', 'dateModified' or a label name
See < a href = "https://github.com/zadam/trilium/wiki/Sorting" > https://github.com/zadam/trilium/wiki/Sorting< / a > for details.< / td >
2023-01-03 14:31:46 +01:00
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > reverse< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > foldersFirst< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < / td >
< / tr >
2022-12-25 13:03:22 +01:00
2023-01-03 14:31:46 +01:00
< / tbody >
< / table >
2023-08-21 04:17:16 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2023-01-03 14:31:46 +01:00
< dl class = "details" >
2022-12-25 13:03:22 +01:00
2023-01-03 14:31:46 +01:00
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line457" > line 457< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< span class = "param-type" > void< / span >
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2023-02-17 16:15:58 +01: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 >
2023-07-15 12:07:45 +02:00
< td class = "description last" > if branch is created between note and parent note, set this prefix< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line248" > line 248< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "transactional" > < span class = "type-signature" > < / span > transactional< span class = "signature" > (func)< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2023-09-06 09:25:00 +02:00
This functions wraps code which is supposed to be running in transaction. If transaction already
exists, then we'll use that transaction.
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 > func< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line487" > line 487< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / 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 >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > any< / 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" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-11-21 20:46:48 +01:00
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line510" > line 510< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
< / 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 >
2023-08-21 04:17:16 -04: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 = "AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > < / li > < li > < a href = "BAttachment.html" > BAttachment< / a > < / li > < li > < a href = "BAttribute.html" > BAttribute< / a > < / li > < li > < a href = "BBranch.html" > BBranch< / a > < / li > < li > < a href = "BEtapiToken.html" > BEtapiToken< / a > < / li > < li > < a href = "BNote.html" > BNote< / a > < / li > < li > < a href = "BOption.html" > BOption< / a > < / li > < li > < a href = "BRecentNote.html" > BRecentNote< / a > < / li > < li > < a href = "BRevision.html" > BRevision< / a > < / li > < li > < a href = "BackendScriptApi.html" > BackendScriptApi< / a > < / li > < / ul > < h3 > Global< / h3 > < ul > < li > < a href = "global.html#api" > api< / a > < / li > < / ul >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2023-05-31 14:00:37 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 4.0.2< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
