2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: BackendScriptApi< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
< h1 class = "page-title" > Class: BackendScriptApi< / h1 >
< section >
< header >
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > BackendScriptApi< / h2 >
< / header >
< article >
< div class = "container-overview" >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line21" > line 21< / a >
< / li > < / ul > < / dd >
< / dl >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< h4 class = "name" id = "currentNote" > < span class = "type-signature" > < / span > currentNote< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > note< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
< / td >
< td class = "description last" > where script is currently executing< / 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#line25" > line 25< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "originEntity" > < span class = "type-signature" > < / span > originEntity< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > entity< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Entity.html" > Entity< / a > < / span >
< / td >
< td class = "description last" > whose event triggered this executions< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line27" > line 27< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "startNote" > < span class = "type-signature" > < / span > startNote< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > note< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Note.html" > Note< / a > < / span >
< / td >
< td class = "description last" > where script started executing< / 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#line23" > line 23< / a >
< / li > < / ul > < / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< 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" > → {Promise.< {note: < a href = "Note.html" > Note< / a > , branch: < a href = "Branch.html" > Branch< / a > }>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > create new note under this parent< / td >
< / tr >
< tr >
< td class = "name" > < code > title< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > content< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
""
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > extraOptions< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "global.html#CreateNoteExtraOptions" > CreateNoteExtraOptions< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
{}
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< 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#line169" > line 169< / a >
< / li > < / ul > < / dd >
< / 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" > Promise.< {note: < a href = "Note.html" > Note< / a > , branch: < a href = "Branch.html" > Branch< / a > }>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "ensureNoteIsAbsentFromParent" > < span class = "type-signature" > < / span > ensureNoteIsAbsentFromParent< span class = "signature" > (noteId, parentNoteId)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
If there's a branch between note and parent note, remove it. Otherwise do nothing.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< 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#line130" > line 130< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "ensureNoteIsPresentInParent" > < span class = "type-signature" > < / span > ensureNoteIsPresentInParent< span class = "signature" > (noteId, parentNoteId, prefix)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
If there's no branch between note and parent note, create one. Otherwise do nothing.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > prefix< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > if branch will be create between note and parent note, set this prefix< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< 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#line120" > line 120< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getAttribute" > < span class = "type-signature" > < / span > getAttribute< span class = "signature" > (attributeId)< / span > < span class = "type-signature" > → {Promise.< (< a href = "Attribute.html" > Attribute< / 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 > attributeId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line64" > line 64< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< (< a href = "Attribute.html" > Attribute< / a > |null)>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getBranch" > < span class = "type-signature" > < / span > getBranch< span class = "signature" > (branchId)< / span > < span class = "type-signature" > → {Promise.< (< a href = "Branch.html" > Branch< / 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 > branchId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line57" > line 57< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< (< a href = "Branch.html" > Branch< / a > |null)>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getDateNote" > < span class = "type-signature" > < / span > getDateNote< span class = "signature" > (date)< / span > < span class = "type-signature" > → {Promise.< (< a href = "Note.html" > Note< / a > |null)>}< / span > < / h4 >
< div class = "description" >
Returns day note for given date (YYYY-MM-DD format). If such note doesn't exist, it is created.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > date< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / 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 >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line193" > line 193< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< (< a href = "Note.html" > Note< / a > |null)>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getEntities" > < span class = "type-signature" > < / span > getEntities< span class = "signature" > (SQL, array)< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Entity.html" > Entity< / a > >>}< / 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 > SQL< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > query< / td >
< / tr >
< tr >
< td class = "name" > < code > array< / code > < / td >
< td class = "type" >
< span class = "param-type" > Array.< ?>< / span >
< / td >
< td class = "description last" > of params< / 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#line89" > line 89< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Entity.html" > Entity< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getEntity" > < span class = "type-signature" > < / span > getEntity< span class = "signature" > (SQL, array)< / span > < span class = "type-signature" > → {Promise.< (< a href = "Entity.html" > Entity< / a > |null)>}< / span > < / h4 >
< div class = "description" >
Retrieves first entity from the SQL's result set.
< / 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 > SQL< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > query< / td >
< / tr >
< tr >
< td class = "name" > < code > array< / code > < / td >
< td class = "type" >
< span class = "param-type" > Array.< ?>< / span >
< / td >
< td class = "description last" > of params< / 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#line81" > line 81< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< (< a href = "Entity.html" > Entity< / a > |null)>< / span >
< / dd >
< / dl >
2018-11-08 23:49:44 +01:00
< h4 class = "name" id = "getImage" > < span class = "type-signature" > < / span > getImage< span class = "signature" > (imageId)< / span > < span class = "type-signature" > → {Promise.< (Image|null)>}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > imageId< / 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 >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line71" > line 71< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2018-11-08 23:49:44 +01:00
< span class = "param-type" > Promise.< (Image|null)>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
< h4 class = "name" id = "getInstanceName" > < span class = "type-signature" > < / span > getInstanceName< span class = "signature" > ()< / span > < span class = "type-signature" > → {string|null}< / span > < / h4 >
< 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 >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line43" > line 43< / a >
< / 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 = "getNote" > < span class = "type-signature" > < / span > getNote< span class = "signature" > (noteId)< / span > < span class = "type-signature" > → {Promise.< (< a href = "Note.html" > Note< / 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 >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line50" > line 50< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< (< a href = "Note.html" > Note< / a > |null)>< / span >
< / dd >
< / dl >
< 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" > → {Promise.< Array.< < a href = "Note.html" > Note< / a > >>}< / span > < / h4 >
< div class = "description" >
Retrieves notes with given label name & value
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > attribute name< / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > attribute value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line99" > line 99< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Note.html" > Note< / a > >>< / 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" > → {Promise.< (< a href = "Note.html" > Note< / 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 >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > attribute name< / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > attribute value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< 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 >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< (< a href = "Note.html" > Note< / a > |null)>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getRootCalendarNote" > < span class = "type-signature" > < / span > getRootCalendarNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< (< a href = "Note.html" > Note< / a > |null)>}< / span > < / h4 >
< div class = "description" >
Returns root note of the calendar.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line184" > line 184< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< (< a href = "Note.html" > Note< / a > |null)>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "log" > < span class = "type-signature" > < / span > log< span class = "signature" > (message)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
Log given message to trilium logs.
< / 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 > message< / code > < / td >
< td class = "type" >
< / 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 >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line176" > line 176< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "refreshTree" > < span class = "type-signature" > < / span > refreshTree< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Trigger tree refresh in all connected clients. This is required when some tree change happens in
the backend.
< / div >
< 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#line234" > line 234< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "setNoteToParent" > < span class = "type-signature" > < / span > setNoteToParent< span class = "signature" > (noteId, prefix, parentNoteId< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
This method finds note by its noteId and prefix and either sets it to the given parentNoteId
or removes the branch (if parentNoteId is not given).
This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / 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 = "attributes" >
< / 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 = "attributes" >
< / 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 = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line213" > line 213< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "sortNotesAlphabetically" > < span class = "type-signature" > < / span > sortNotesAlphabetically< span class = "signature" > (parentNoteId)< / span > < span class = "type-signature" > < / 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 > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > this note's child notes will be sorted< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line200" > line 200< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
Promise< void >
< / div >
< h4 class = "name" id = "toggleNoteInParent" > < span class = "type-signature" > < / span > toggleNoteInParent< span class = "signature" > (present, noteId, parentNoteId, prefix)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Based on the value, either create or remove branch between note and parent note.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > present< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true if we want the branch to exist, false if we want it gone< / td >
< / tr >
< tr >
< td class = "name" > < code > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > parentNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > prefix< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > if branch will be create between note and parent note, set this prefix< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_backend_script_api.js.html" > services/backend_script_api.js< / a > , < a href = "services_backend_script_api.js.html#line142" > line 142< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "transactional" > < span class = "type-signature" > < / span > transactional< span class = "signature" > (func)< / span > < span class = "type-signature" > → {Promise.< ?>}< / span > < / h4 >
< div class = "description" >
This functions wraps code which is supposed to be running in transaction. If transaction already
exists, then we'll use that transaction.
This method is required only when script has label manualTransactionHandling, all other scripts are
transactional by default.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > func< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< 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 >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
result of func callback
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< ?>< / span >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< nav >
2018-11-08 23:49:44 +01:00
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Classes< / h3 > < ul > < li > < a href = "ApiToken.html" > ApiToken< / a > < / li > < li > < a href = "Attribute.html" > Attribute< / a > < / li > < li > < a href = "BackendScriptApi.html" > BackendScriptApi< / a > < / li > < li > < a href = "Branch.html" > Branch< / a > < / li > < li > < a href = "Entity.html" > Entity< / a > < / li > < li > < a href = "Link.html" > Link< / a > < / li > < li > < a href = "Note.html" > Note< / a > < / li > < li > < a href = "NoteRevision.html" > NoteRevision< / a > < / li > < li > < a href = "Option.html" > Option< / a > < / li > < li > < a href = "RecentNote.html" > RecentNote< / a > < / li > < / ul > < h3 > < a href = "global.html" > Global< / a > < / h3 >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2018-11-08 23:49:44 +01:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.5.5< / a > on Thu Nov 08 2018 23:49:19 GMT+0100 (Central European Standard Time)
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
