2025-04-12 13:19:03 +03:00
<!DOCTYPE html> < html class = "default" lang = "en" data-base = "../" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > BBranch | trilium< / title > < meta name = "description" content = "Documentation for trilium" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / > < link rel = "stylesheet" href = "../assets/style.css" / > < link rel = "stylesheet" href = "../assets/highlight.css" / > < script defer src = "../assets/main.js" > < / script > < script async src = "../assets/icons.js" id = "tsd-icons-script" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < script async src = "../assets/navigation.js" id = "tsd-nav-script" > < / script > < script async src = "../assets/hierarchy.js" id = "tsd-hierarchy-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => window . app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < a href = "../index.html" class = "title" > trilium< / a > < div id = "tsd-toolbar-links" > < / div > < button id = "tsd-search-trigger" class = "tsd-widget" aria-label = "Search" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-search" > < / use > < / svg > < / button > < dialog id = "tsd-search" aria-label = "Search" > < input role = "combobox" id = "tsd-search-input" aria-controls = "tsd-search-results" aria-autocomplete = "list" aria-expanded = "true" autocapitalize = "off" autocomplete = "off" placeholder = "Search the docs" maxLength = "100" / > < ul role = "listbox" id = "tsd-search-results" > < / ul > < div id = "tsd-search-status" aria-live = "polite" aria-atomic = "true" > < div > Preparing search index...< / div > < / div > < / dialog > < a href = "#" class = "tsd-widget menu" id = "tsd-toolbar-menu-trigger" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-menu" > < / use > < / svg > < / a > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" aria-label = "Breadcrumb" > < li > < a href = "../modules/Backend_Script_API.html" > Backend Script API< / a > < / li > < li > < a href = "../modules/Backend_Script_API._internal_.html" > < internal> < / a > < / li > < li > < a href = "" aria-current = "page" > BBranch< / a > < / li > < / ul > < h1 > Class BBranch< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
parents.< / p >
< p > Note that you should not rely on the branch's identity, since it can change easily with a note's move.
Always check noteId instead.< / p >
2025-04-12 13:30:24 +03:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / section > < section class = "tsd-panel tsd-hierarchy" data-refl = "1868" > < h4 > Hierarchy (< a href = "../hierarchy.html#Backend Script API.<internal>.BBranch" > View Summary< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li class = "tsd-hierarchy-item" > < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" class = "tsd-signature-type tsd-kind-class" > AbstractBeccaEntity< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "" class = "tsd-signature-type tsd-kind-class" > BBranch< / a > < span class = "tsd-signature-symbol" > > < / span > < ul class = "tsd-hierarchy" > < li class = "tsd-hierarchy-item" > < span class = "tsd-hierarchy-target" > BBranch< / span > < / li > < / ul > < / li > < / ul > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L20" > src/becca/entities/bbranch.ts:20< / a > < / li > < / ul > < / aside > < section class = "tsd-panel-group tsd-index-group" > < section class = "tsd-panel tsd-index-panel" > < details class = "tsd-index-content tsd-accordion" open > < summary class = "tsd-accordion-summary tsd-index-summary" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronSmall" > < / use > < / svg > < h5 class = "tsd-index-heading uppercase" > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Constructors< / h3 > < div class = "tsd-index-list" > < a href = "#constructor" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Constructor" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a >
2025-04-12 13:19:03 +03:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "#blobid" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > blob< wbr / > Id?< / span > < / a >
< a href = "#branchid" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > branch< wbr / > Id?< / span > < / a >
< a href = "#datecreated" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > date< wbr / > Created?< / span > < / a >
< a href = "#datemodified" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > date< wbr / > Modified?< / span > < / a >
< a href = "#isexpanded" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > is< wbr / > Expanded< / span > < / a >
< a href = "#isprotected" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > is< wbr / > Protected?< / span > < / a >
< a href = "#issynced" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > is< wbr / > Synced?< / span > < / a >
< a href = "#noteid" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > note< wbr / > Id< / span > < / a >
< a href = "#noteposition" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > note< wbr / > Position< / span > < / a >
< a href = "#parentnoteid" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > parent< wbr / > Note< wbr / > Id< / span > < / a >
< a href = "#prefix" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > prefix< / span > < / a >
< a href = "#utcdatecreated" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > utc< wbr / > Date< wbr / > Created< / span > < / a >
< a href = "#utcdatemodified" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > utc< wbr / > Date< wbr / > Modified?< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Accessors< / h3 > < div class = "tsd-index-list" > < a href = "#becca" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > becca< / span > < / a >
< a href = "#childnote" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > child< wbr / > Note< / span > < / a >
< a href = "#isdeleted" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > is< wbr / > Deleted< / span > < / a >
< a href = "#isweak" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > is< wbr / > Weak< / span > < / a >
< a href = "#parentnote" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > parent< wbr / > Note< / span > < / a >
< a href = "#entityname" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > entity< wbr / > Name< / span > < / a >
< a href = "#hashedproperties" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > hashed< wbr / > Properties< / span > < / a >
< a href = "#primarykeyname" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Accessor" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > primary< wbr / > Key< wbr / > Name< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "#_getcontent" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > _get< wbr / > Content< / span > < / a >
< a href = "#_setcontent" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > _set< wbr / > Content< / span > < / a >
< a href = "#beforesaving" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > before< wbr / > Saving< / span > < / a >
< a href = "#createclone" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > create< wbr / > Clone< / span > < / a >
< a href = "#deletebranch" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > delete< wbr / > Branch< / span > < / a >
< a href = "#generatehash" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > generate< wbr / > Hash< / span > < / a >
< a href = "#getnote" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Note< / span > < / a >
< a href = "#getpojo" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Pojo< / span > < / a >
< a href = "#getpojotosave" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Pojo< wbr / > To< wbr / > Save< / span > < / a >
< a href = "#getutcdatechanged" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Utc< wbr / > Date< wbr / > Changed< / span > < / a >
< a href = "#hasstringcontent" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > has< wbr / > String< wbr / > Content< / span > < / a >
< a href = "#init" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > init< / span > < / a >
< a href = "#markasdeleted" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > mark< wbr / > As< wbr / > Deleted< / span > < / a >
< a href = "#markasdeletedsimple" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > mark< wbr / > As< wbr / > Deleted< wbr / > Simple< / span > < / a >
< a href = "#putentitychange" class = "tsd-index-link tsd-is-protected tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > put< wbr / > Entity< wbr / > Change< / span > < / a >
< a href = "#save" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > save< / span > < / a >
< a href = "#update" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > update< / span > < / a >
< a href = "#updatefromrow" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Method" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > update< wbr / > From< wbr / > Row< / span > < / a >
2025-04-12 13:30:24 +03:00
< / div > < / section > < / div > < / details > < / section > < / section > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Constructors" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h2 > Constructors< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "constructor" > < span > constructor< / span > < a href = "#constructor" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "" > < div class = "tsd-signature tsd-anchor-link" id = "constructorbbranch" > < span class = "tsd-signature-keyword" > new< / span > < span class = "tsd-kind-constructor-signature" > BBranch< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > row< / span > < span class = "tsd-signature-symbol" > ?:< / span > < a href = "../interfaces/Backend_Script_API._internal_.BranchRow.html" class = "tsd-signature-type tsd-kind-interface" > BranchRow< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "" class = "tsd-signature-type tsd-kind-class" > BBranch< / a > < a href = "#constructorbbranch" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > row< / span > : < a href = "../interfaces/Backend_Script_API._internal_.BranchRow.html" class = "tsd-signature-type tsd-kind-interface" > BranchRow< / a > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "" class = "tsd-signature-type tsd-kind-class" > BBranch< / a > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > .< a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L39" > src/becca/entities/bbranch.ts:39< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < / section > < / details > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h2 > Properties< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < h3 class = "tsd-anchor-link" id = "blobid" > < code class = "tsd-tag" > Optional< / code > < span > blob< wbr / > Id< / span > < a href = "#blobid" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > blobId< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > string< / span > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > .< a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html#blobid" > blobId< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/abstract_becca_entity.ts#L34" > src/becca/entities/abstract_becca_entity.ts:34< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "branchid" > < code class = "tsd-tag" > Optional< / code > < span > branch< wbr / > Id< / span > < a href = "#branchid" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > branchId< / span > < s
2025-04-12 13:19:03 +03:00
As a result, note with only weak branches should be immediately deleted.
An example is shared or bookmarked clones - they are created automatically and exist for technical reasons,
not as user-intended actions. From user perspective, they don't count as real clones and for the purpose
of deletion should not act as a clone.< / p >
2025-04-12 13:30:24 +03:00
< / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L129" > src/becca/entities/bbranch.ts:129< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "parentnote" > < span > parent< wbr / > Note< / span > < a href = "#parentnote" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li > < div class = "tsd-signature" id = "parentnoteparentnote" > < span class = "tsd-signature-keyword" > get< / span > < span class = "tsd-kind-get-signature" > parentNote< / span > < span class = "tsd-signature-symbol" > ()< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > |< / span > < a href = "Backend_Script_API._internal_.BNote.html" class = "tsd-signature-type tsd-kind-class" > BNote< / a > < / div > < div class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > undefined< / span > < span class = "tsd-signature-symbol" > |< / span > < a href = "Backend_Script_API._internal_.BNote.html" class = "tsd-signature-type tsd-kind-class" > BNote< / a > < / h4 > < p > root branch will have undefined parent, all other branches have to have a parent note< / p >
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L109" > src/becca/entities/bbranch.ts:109< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "entityname" > < code class = "tsd-tag" > Static< / code > < span > entity< wbr / > Name< / span > < a href = "#entityname" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li > < div class = "tsd-signature" id = "entitynameentityname" > < span class = "tsd-signature-keyword" > get< / span > < span class = "tsd-kind-get-signature" > entityName< / span > < span class = "tsd-signature-symbol" > ()< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L21" > src/becca/entities/bbranch.ts:21< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "hashedproperties" > < code class = "tsd-tag" > Static< / code > < span > hashed< wbr / > Properties< / span > < a href = "#hashedproperties" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li > < div class = "tsd-signature" id = "hashedpropertieshashedproperties" > < span class = "tsd-signature-keyword" > get< / span > < span class = "tsd-kind-get-signature" > hashedProperties< / span > < span class = "tsd-signature-symbol" > ()< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / div > < div class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L28" > src/becca/entities/bbranch.ts:28< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "primarykeyname" > < code class = "tsd-tag" > Static< / code > < span > primary< wbr / > Key< wbr / > Name< / span > < a href = "#primarykeyname" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li > < div class = "tsd-signature" id = "primarykeynameprimarykeyname" > < span class = "tsd-signature-keyword" > get< / span > < span class = "tsd-kind-get-signature" > primaryKeyName< / span > < span class = "tsd-signature-symbol" > ()< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div > < div class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L24" > src/becca/entities/bbranch.ts:24< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < / section > < / details > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Methods" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h2 > Methods< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member tsd-is-protected tsd-is-inherited" > < h3 class = "tsd-anchor-link" id = "_getcontent" > < code class = "tsd-tag" > Protected< / code > < span > _get< wbr / > Content< / span > < a href = "#_getcontent" aria-label = "Permalink" class = "tsd-anchor-i
2025-04-12 13:19:03 +03:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > deleteId< / span > : < span class = "tsd-signature-type" > string< / span > < / span > < div class = "tsd-comment tsd-typography" > < p > optional delete identified< / p >
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > taskContext< / span > : < a href = "Backend_Script_API._internal_.TaskContext.html" class = "tsd-signature-type tsd-kind-class" > TaskContext< / a > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 > < p > true if note has been deleted, false otherwise< / p >
2025-04-12 13:30:24 +03:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L140" > src/becca/entities/bbranch.ts:140< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < h3 class = "tsd-anchor-link" id = "generatehash" > < span > generate< wbr / > Hash< / span > < a href = "#generatehash" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-inherited" > < li class = "tsd-is-inherited" > < div class = "tsd-signature tsd-anchor-link" id = "generatehash-1" > < span class = "tsd-kind-call-signature" > generateHash< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > isDeleted< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < a href = "#generatehash-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > isDeleted< / span > : < span class = "tsd-signature-type" > boolean< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > .< a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html#generatehash" > generateHash< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/abstract_becca_entity.ts#L63" > src/becca/entities/abstract_becca_entity.ts:63< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "getnote" > < span > get< wbr / > Note< / span > < a href = "#getnote" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "" > < div class = "tsd-signature tsd-anchor-link" id = "getnote-1" > < span class = "tsd-kind-call-signature" > getNote< / span > < span class = "tsd-signature-symbol" > ()< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "Backend_Script_API._internal_.BNote.html" class = "tsd-signature-type tsd-kind-class" > BNote< / a > < a href = "#getnote-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < a href = "Backend_Script_API._internal_.BNote.html" class = "tsd-signature-type tsd-kind-class" > BNote< / a > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L104" > src/becca/entities/bbranch.ts:104< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "getpojo" > < span > get< wbr / > Pojo< / span > < a href = "#getpojo" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "" > < div class = "tsd-signature tsd-anchor-link" id = "getpojo-1" > < span class = "tsd-kind-call-signature" > getPojo< / span > < span class = "tsd-signature-symbol" > ()< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-symbol" > {< / span > < br / > < span class = "tsd-kind-property" > branchId< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-s
2025-04-12 13:19:03 +03:00
< p > This is a low-level method, for notes and branches use < code > note.deleteNote()< / code > and 'branch.deleteBranch()` instead.< / p >
2025-04-12 13:30:24 +03:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > deleteId< / span > : < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > |< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > = null< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > .< a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html#markasdeleted" > markAsDeleted< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/abstract_becca_entity.ts#L277" > src/becca/entities/abstract_becca_entity.ts:277< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < h3 class = "tsd-anchor-link" id = "markasdeletedsimple" > < span > mark< wbr / > As< wbr / > Deleted< wbr / > Simple< / span > < a href = "#markasdeletedsimple" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-inherited" > < li class = "tsd-is-inherited" > < div class = "tsd-signature tsd-anchor-link" id = "markasdeletedsimple-1" > < span class = "tsd-kind-call-signature" > markAsDeletedSimple< / span > < span class = "tsd-signature-symbol" > ()< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > void< / span > < a href = "#markasdeletedsimple-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > .< a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html#markasdeletedsimple" > markAsDeletedSimple< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/abstract_becca_entity.ts#L303" > src/becca/entities/abstract_becca_entity.ts:303< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-is-protected tsd-is-inherited" > < h3 class = "tsd-anchor-link" id = "putentitychange" > < code class = "tsd-tag" > Protected< / code > < span > put< wbr / > Entity< wbr / > Change< / span > < a href = "#putentitychange" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-protected tsd-is-inherited" > < li class = "tsd-is-inherited" > < div class = "tsd-signature tsd-anchor-link" id = "putentitychange-1" > < span class = "tsd-kind-call-signature" > putEntityChange< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > isDeleted< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > void< / span > < a href = "#putentitychange-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > isDeleted< / span > : < span class = "tsd-signature-type" > boolean< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > .< a href = "Backe
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < code class = "tsd-tag" > Optional< / code > < span class = "tsd-kind-parameter" > opts< / span > : < span class = "tsd-signature-symbol" > {}< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > this< / span > < / h4 > < div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > .< a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html#save" > save< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/abstract_becca_entity.ts#L103" > src/becca/entities/abstract_becca_entity.ts:103< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "update" > < span > update< / span > < a href = "#update" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "" > < div class = "tsd-signature tsd-anchor-link" id = "update-1" > < span class = "tsd-kind-call-signature" > update< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > __namedParameters< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "" class = "tsd-signature-type tsd-kind-class" > BBranch< / a > < a href = "#update-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > __namedParameters< / span > : < span class = "tsd-signature-type" > any< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "" class = "tsd-signature-type tsd-kind-class" > BBranch< / a > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/TriliumNext/Notes/blob/e8f6e2d433198ddaef343ea7453bc1d286eb2785/src/becca/entities/bbranch.ts#L54" > src/becca/entities/bbranch.ts:54< / a > < / li > < / ul > < / aside > < / div > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "updatefromrow" > < span > update< wbr / > From< wbr / > Row< / span > < a href = "#updatefromrow" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "" > < div class = "tsd-signature tsd-anchor-link" id = "updatefromrow-1" > < span class = "tsd-kind-call-signature" > updateFromRow< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > row< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/Backend_Script_API._internal_.BranchRow.html" class = "tsd-signature-type tsd-kind-interface" > BranchRow< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > void< / span > < a href = "#updatefromrow-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / div > < div class = "tsd-description" > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > row< / span > : < a href = "../interfaces/Backend_Script_API._internal_.BranchRow.html" class = "tsd-signature-type tsd-kind-interface" > BranchRow< / a > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < aside class = "tsd-sources" > < p > Overrides < a href = "Backend_Script_API._internal_.AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > .< a href = "Backend_Script_API._internal_.AbstractBeccaEnt
