2018-08-30 02:44:35 +08:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: Note< / 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: Note< / h1 >
< section >
< header >
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > Note< span class = "signature" > (row)< / span > < span class = "type-signature" > < / span > < / h2 >
< div class = "class-description" > This represents a Note which is a central object in the Trilium Notes project.< / div >
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
< h4 class = "name" id = "Note" > < span class = "type-signature" > < / span > new Note< span class = "signature" > (row)< / 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 > row< / code > < / td >
< td class = "type" >
< / td >
< td class = "description last" > object containing database row from "notes" table< / td >
< / tr >
< / tbody >
< / table >
< 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 > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > primary key< / td >
< / tr >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > one of "text", "code", "file" or "render"< / td >
< / tr >
< tr >
< td class = "name" > < code > mime< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > MIME type, e.g. "text/html"< / td >
< / tr >
< tr >
< td class = "name" > < code > title< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > note title< / td >
< / tr >
< tr >
< td class = "name" > < code > content< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > note content - e.g. HTML text for text notes, file payload for files< / td >
< / tr >
< tr >
< td class = "name" > < code > isProtected< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true if note is protected< / td >
< / tr >
< tr >
< td class = "name" > < code > isDeleted< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true if note is deleted< / td >
< / tr >
< tr >
< td class = "name" > < code > dateCreated< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > dateModified< / 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 >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line29" > line 29< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< / div >
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
< li > < a href = "Entity.html" > Entity< / a > < / li >
< / ul >
< h3 class = "subsection-title" > Methods< / h3 >
< h4 class = "name" id = "findNotesWithAttribute" > < span class = "type-signature" > (async) < / span > findNotesWithAttribute< span class = "signature" > (type, 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" >
Finds notes with given attribute name and value. Only own attributes are considered, not inherited ones
< / 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 > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / 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" >
< / 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 >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line443" > line 443< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "findNotesWithLabel" > < span class = "type-signature" > (async) < / span > findNotesWithLabel< 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" >
Finds notes with given label name and value. Only own labels are considered, not inherited ones
< / 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" > label 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" > label value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line481" > line 481< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "findNotesWithRelation" > < span class = "type-signature" > (async) < / span > findNotesWithRelation< 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" >
Finds notes with given relation name and value. Only own relations are considered, not inherited ones
< / 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" > relation 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" > relation value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line490" > line 490< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "getAttribute" > < span class = "type-signature" > (async) < / span > getAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {Promise.< < a href = "Attribute.html" > Attribute< / 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 > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / 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 = "description last" > attribute name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line251" > line 251< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
< / dd >
< / dl >
2018-09-03 22:05:28 +08:00
< h4 class = "name" id = "getAttributes" > < span class = "type-signature" > (async) < / span > getAttributes< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08: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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > attribute name to filter< / td >
< / tr >
< / tbody >
< / table >
2018-08-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line120" > line 120< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
all note's attributes, including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getAttributeValue" > < span class = "type-signature" > (async) < / span > getAttributeValue< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {Promise.< 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 > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / 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 = "description last" > attribute name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line262" > line 262< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
attribute value of given type and name or null if no such attribute exists.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< string>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getBranches" > < span class = "type-signature" > (async) < / span > getBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Branch.html" > Branch< / a > >>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line520" > line 520< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Branch.html" > Branch< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getChildBranches" > < span class = "type-signature" > (async) < / span > getChildBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Branch.html" > Branch< / a > >>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line548" > line 548< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
child branches of this note
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Branch.html" > Branch< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getChildNotes" > < span class = "type-signature" > (async) < / span > getChildNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Note.html" > Note< / a > >>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line534" > line 534< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
child notes of this note
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Note.html" > Note< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getLabel" > < span class = "type-signature" > (async) < / span > getLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< < a href = "Attribute.html" > Attribute< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > label name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line349" > line 349< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
label if it exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
< / dd >
< / dl >
2018-11-13 19:50:08 +08:00
< h4 class = "name" id = "getLabelDefinitions" > < span class = "type-signature" > (async) < / span > getLabelDefinitions< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< 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" >
< optional>< br >
< / td >
< td class = "description last" > label name to filter< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line145" > line 145< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
all note's label definitions, including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
2018-09-03 22:05:28 +08:00
< h4 class = "name" id = "getLabels" > < span class = "type-signature" > (async) < / span > getLabels< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< h5 > Parameters:< / h5 >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< td class = "attributes" >
< optional>< br >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< / td >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< td class = "description last" > label name to filter< / td >
< / tr >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08:00
< / tbody >
< / table >
2018-08-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line137" > line 137< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
all note's labels (attributes with type label), including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getLabelValue" > < span class = "type-signature" > (async) < / span > getLabelValue< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > label name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line361" > line 361< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
label value if label exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< string>< / span >
< / dd >
< / dl >
2018-11-09 06:49:44 +08:00
< h4 class = "name" id = "getLinks" > < span class = "type-signature" > (async) < / span > getLinks< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Link.html" > Link< / a > >>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line504" > line 504< / a >
2018-11-09 06:49:44 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Link.html" > Link< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getLinksWithDeleted" > < span class = "type-signature" > (async) < / span > getLinksWithDeleted< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Link.html" > Link< / a > >>}< / span > < / h4 >
2018-08-30 02:44:35 +08:00
2018-11-09 06:49:44 +08:00
< div class = "description" >
Return all links from this note, including deleted ones.
< / div >
2018-08-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line513" > line 513< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2018-11-09 06:49:44 +08:00
< span class = "param-type" > Promise.< Array.< < a href = "Link.html" > Link< / a > >>< / span >
2018-08-30 02:44:35 +08:00
< / dd >
< / dl >
< h4 class = "name" id = "getOwnedAttributes" > < span class = "type-signature" > (async) < / span > getOwnedAttributes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line105" > line 105< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
attributes belonging to this specific note (excludes inherited attributes)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getParentNotes" > < span class = "type-signature" > (async) < / span > getParentNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Note.html" > Note< / a > >>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line560" > line 560< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
parent notes of this note (note can have multiple parents because of cloning)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Note.html" > Note< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getRelation" > < span class = "type-signature" > (async) < / span > getRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< < a href = "Attribute.html" > Attribute< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line355" > line 355< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
relation if it exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "Attribute.html" > Attribute< / a > >< / span >
< / dd >
< / dl >
2018-11-13 19:50:08 +08:00
< h4 class = "name" id = "getRelationDefinitions" > < span class = "type-signature" > (async) < / span > getRelationDefinitions< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< 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" >
< optional>< br >
< / td >
< td class = "description last" > relation name to filter< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line161" > line 161< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
all note's relation definitions including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
2018-09-03 22:05:28 +08:00
< h4 class = "name" id = "getRelations" > < span class = "type-signature" > (async) < / span > getRelations< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
2018-08-30 02:44:35 +08:00
2018-09-03 22:05:28 +08: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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > relation name to filter< / td >
< / tr >
< / tbody >
< / table >
2018-08-30 02:44:35 +08:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line153" > line 153< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
all note's relations (attributes with type relation), including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getRelationTarget" > < span class = "type-signature" > (async) < / span > getRelationTarget< span class = "signature" > (name)< / 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 > name< / 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 >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line429" > line 429< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
target note of the relation or null (if target is empty or note was not found)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "Note.html" > Note< / a > >< / span >
|
< span class = "param-type" > null< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getRelationValue" > < span class = "type-signature" > (async) < / span > getRelationValue< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line367" > line 367< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
relation value if relation exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< string>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getRevisions" > < span class = "type-signature" > (async) < / span > getRevisions< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "NoteRevision.html" > NoteRevision< / a > >>}< / span > < / h4 >
< div class = "description" >
Returns note revisions of this note.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line497" > line 497< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "NoteRevision.html" > NoteRevision< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getScriptEnv" > < span class = "type-signature" > < / span > getScriptEnv< span class = "signature" > ()< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line86" > line 86< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
JS script environment - either "frontend" or "backend"
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
2018-11-09 06:49:44 +08:00
< h4 class = "name" id = "getTargetRelations" > < span class = "type-signature" > (async) < / span > getTargetRelations< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line112" > line 112< / a >
2018-11-09 06:49:44 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
relations targetting this specific note
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "Attribute.html" > Attribute< / a > >>< / span >
< / dd >
< / dl >
2018-08-30 02:44:35 +08:00
< h4 class = "name" id = "hasAttribute" > < span class = "type-signature" > (async) < / span > hasAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {Promise.< boolean>}< / 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 > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / 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 = "description last" > attribute name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line242" > line 242< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if note has an attribute with given type and name (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< boolean>< / span >
< / dd >
< / dl >
2018-09-03 22:05:28 +08:00
< h4 class = "name" id = "hasChildren" > < span class = "type-signature" > (async) < / span > hasChildren< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line527" > line 527< / a >
2018-09-03 22:05:28 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- true if note has children
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2018-08-30 02:44:35 +08:00
< h4 class = "name" id = "hasLabel" > < span class = "type-signature" > (async) < / span > hasLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< boolean>}< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > label name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line337" > line 337< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if label exists (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< boolean>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "hasRelation" > < span class = "type-signature" > (async) < / span > hasRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< boolean>}< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line343" > line 343< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if relation exists (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< boolean>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "invalidateAttributeCache" > < span class = "type-signature" > < / span > invalidateAttributeCache< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
Clear note's attributes cache to force fresh reload for next attribute request.
Cache is note instance scoped.
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line169" > line 169< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "isHtml" > < span class = "type-signature" > < / span > isHtml< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line81" > line 81< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if this note is HTML
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "isJavaScript" > < span class = "type-signature" > < / span > isJavaScript< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line75" > line 75< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if this note is JavaScript (code or attachment)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "isJson" > < span class = "type-signature" > < / span > isJson< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line70" > line 70< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if this note is of application/json content type
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "isRoot" > < span class = "type-signature" > < / span > isRoot< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line65" > line 65< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if this note is the root of the note tree. Root note has "root" noteId
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "loadAttributesToCache" > < span class = "type-signature" > (async) < / span > loadAttributesToCache< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line174" > line 174< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "removeAttribute" > < span class = "type-signature" > (async) < / span > removeAttribute< span class = "signature" > (type, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Removes given attribute name-value pair if it exists.
< / 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 > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / 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" >
< / 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 (optional)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line320" > line 320< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "removeLabel" > < span class = "type-signature" > (async) < / span > removeLabel< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Remove label name-value pair, if it exists.
< / 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" > label 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" > label value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line414" > line 414< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "removeRelation" > < span class = "type-signature" > (async) < / span > removeRelation< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Remove relation name-value pair, if it exists.
< / 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" > relation 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" > relation value (noteId)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line423" > line 423< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "setAttribute" > < span class = "type-signature" > (async) < / span > setAttribute< span class = "signature" > (type, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Creates given attribute name-value pair if it doesn't exist.
< / 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 > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / 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" >
< / 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 (optional)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line294" > line 294< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "setLabel" > < span class = "type-signature" > (async) < / span > setLabel< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Create label name-value pair if it doesn't exist yet.
< / 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" > label 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" > label value< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line396" > line 396< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "setRelation" > < span class = "type-signature" > (async) < / span > setRelation< span class = "signature" > (name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Create relation name-value pair if it doesn't exist yet.
< / 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" > relation 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" > relation value (noteId)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line405" > line 405< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "toggleAttribute" > < span class = "type-signature" > (async) < / span > toggleAttribute< span class = "signature" > (type, enabled, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Based on enabled, attribute is either set or removed.
< / 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 > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > attribute type ('relation', 'label' etc.)< / td >
< / tr >
< tr >
< td class = "name" > < code > enabled< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > toggle On or Off< / td >
< / tr >
< 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 (optional)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line277" > line 277< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "toggleLabel" > < span class = "type-signature" > (async) < / span > toggleLabel< span class = "signature" > (enabled, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Based on enabled, label is either set or removed.
< / 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 > enabled< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > toggle On or Off< / td >
< / tr >
< 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" > label 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" > label value (optional)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line377" > line 377< / a >
2018-08-30 02:44:35 +08:00
< / 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 = "toggleRelation" > < span class = "type-signature" > (async) < / span > toggleRelation< span class = "signature" > (enabled, name, value< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Based on enabled, relation is either set or removed.
< / 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 > enabled< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > toggle On or Off< / td >
< / tr >
< 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" > relation 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" > relation value (noteId)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2018-11-13 19:50:08 +08:00
< a href = "entities_note.js.html" > entities/note.js< / a > , < a href = "entities_note.js.html#line387" > line 387< / a >
2018-08-30 02:44:35 +08:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< nav >
2018-11-09 06:49:44 +08: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-30 02:44:35 +08:00
< / nav >
< br class = "clear" >
< footer >
2018-11-13 19:50:08 +08:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.5.5< / a > on Tue Nov 13 2018 12:12:03 GMT+0100 (Central European Standard Time)
2018-08-30 02:44:35 +08:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
