JSDoc: Class: Note

Constructor

new Note()

Source:

becca/entities/note.js, line 18

Members

children :Array.<Note>

Type:

Array.<Note>

Source:

becca/entities/note.js, line 89

contentSize :int|null

size of the content in bytes

Type:

int | null

Source:

becca/entities/note.js, line 115

dateCreated :string

Type:

string

Source:

becca/entities/note.js, line 62

dateModified :string

Type:

string

Source:

becca/entities/note.js, line 64

flatTextCache :string|null

Type:

string | null

Source:

becca/entities/note.js, line 78

isDecrypted :boolean

Type:

boolean

Source:

becca/entities/note.js, line 73

isProtected :boolean

Type:

boolean

Source:

becca/entities/note.js, line 56

mime :string

Type:

string

Source:

becca/entities/note.js, line 60

noteId :string

Type:

string

Source:

becca/entities/note.js, line 52

noteSize :int|null

size of the content and note revision contents in bytes

Type:

int | null

Source:

becca/entities/note.js, line 120

ownedAttributes :Array.<Attribute>

Type:

Array.<Attribute>

Source:

becca/entities/note.js, line 91

parentBranches :Array.<Branch>

Type:

Array.<Branch>

Source:

becca/entities/note.js, line 85

parents :Array.<Note>

Type:

Array.<Note>

Source:

becca/entities/note.js, line 87

revisionCount :int|null

number of note revisions for this note

Type:

int | null

Source:

becca/entities/note.js, line 125

targetRelations :Array.<Attribute>

Type:

Array.<Attribute>

Source:

becca/entities/note.js, line 101

title :string

Type:

string

Source:

becca/entities/note.js, line 54

type :string

Type:

string

Source:

becca/entities/note.js, line 58

utcDateCreated :string

Type:

string

Source:

becca/entities/note.js, line 66

utcDateModified :string

Type:

string

Source:

becca/entities/note.js, line 68

Methods

__getInheritableAttributes() → {Array.<Attribute>}

Source:

becca/entities/note.js, line 398

Returns:

Type: Array.<Attribute>

addAttribute() → {Attribute}

Source:

becca/entities/note.js, line 1014

Returns:

Type: Attribute

getAllNotePaths() → {Array.<Array.<string>>}

Source:

becca/entities/note.js, line 936

Returns:

- array of notePaths (each represented by array of noteIds constituting the particular note path)

Type: Array.<Array.<string>>

getAncestors() → {Array.<Note>}

Source:

becca/entities/note.js, line 858

Returns:

Type: Array.<Note>

getAttribute(type, name) → {Attribute}

Parameters:

Name	Type	Description
`type`	string	attribute type (label, relation, etc.)
`name`	string	attribute name

Source:

becca/entities/note.js, line 516

Returns:

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.

Type: Attribute

getAttributes(typeopt, nameopt) → {Array.<Attribute>}

Parameters:

Name	Type	Attributes	Description
`type`	string	<optional>	(optional) attribute type to filter
`name`	string	<optional>	(optional) attribute name to filter

Source:

becca/entities/note.js, line 329

Returns:

all note's attributes, including inherited ones

Type: Array.<Attribute>

getAttributeValue(type, name) → {string|null}

Parameters:

Name	Type	Description
`type`	string	attribute type (label, relation, etc.)
`name`	string	attribute name

Source:

becca/entities/note.js, line 527

Returns:

attribute value of given type and name or null if no such attribute exists.

Type: string | null

getBranches() → {Array.<Branch>}

Deprecated:

use getParentBranches() instead

Source:

becca/entities/note.js, line 143

Returns:

Type: Array.<Branch>

getChildBranches() → {Array.<Branch>}

Source:

becca/entities/note.js, line 163

Returns:

Type: Array.<Branch>

getChildNotes() → {Array.<Note>}

Source:

becca/entities/note.js, line 153

Returns:

Type: Array.<Note>

getContent() → {*}

Source:

becca/entities/note.js, line 177

Returns:

Type: *

getContentMetadata() → {Object}

Source:

becca/entities/note.js, line 211

Returns:

Type: Object

getFlatText() → {string}

This is used for: - fast searching - note similarity evaluation

Source:

becca/entities/note.js, line 653

Returns:

- returns flattened textual representation of note, prefixes and attributes

Type: string

getJsonContent() → {*}

Source:

becca/entities/note.js, line 222

Returns:

Type: *

getLabel(name) → {Attribute|null}

Parameters:

Name	Type	Description
`name`	string	label name

Source:

becca/entities/note.js, line 458

Returns:

label if it exists, null otherwise

Type: Attribute | null

getLabels(nameopt) → {Array.<Attribute>}

Parameters:

Name	Type	Attributes	Description
`name`	string	<optional>	label name to filter

Source:

becca/entities/note.js, line 548

Returns:

all note's labels (attributes with type label), including inherited ones

Type: Array.<Attribute>

getLabelValue(name) → {string|null}

Parameters:

Name	Type	Description
`name`	string	label name

Source:

becca/entities/note.js, line 482

Returns:

label value if label exists, null otherwise

Type: string | null

getLabelValues(nameopt) → {Array.<string>}

Parameters:

Name	Type	Attributes	Description
`name`	string	<optional>	label name to filter

Source:

becca/entities/note.js, line 556

Returns:

all note's label values, including inherited ones

Type: Array.<string>

getOwnedAttribute() → {Attribute}

Source:

becca/entities/note.js, line 622

Returns:

attribute belonging to this specific note (excludes inherited attributes) This method can be significantly faster than the getAttribute()

Type: Attribute

getOwnedAttributes(typeopt, nameopt) → {Array.<Attribute>}

Parameters:

Name	Type	Attributes	Description
`type`	string	<optional>	(optional) attribute type to filter
`name`	string	<optional>	(optional) attribute name to filter

Source:

becca/entities/note.js, line 597

Returns:

note's "owned" attributes - excluding inherited ones

Type: Array.<Attribute>

getOwnedAttributeValue(type, name) → {string|null}

Parameters:

Name	Type	Description
`type`	string	attribute type (label, relation, etc.)
`name`	string	attribute name

Source:

becca/entities/note.js, line 538

Returns:

attribute value of given type and name or null if no such attribute exists.

Type: string | null

getOwnedLabel(name) → {Attribute|null}

Parameters:

Name	Type	Description
`name`	string	label name

Source:

becca/entities/note.js, line 464

Returns:

label if it exists, null otherwise

Type: Attribute | null

getOwnedLabels(nameopt) → {Array.<Attribute>}

Parameters:

Name	Type	Attributes	Description
`name`	string	<optional>	label name to filter

Source:

becca/entities/note.js, line 564

Returns:

all note's labels (attributes with type label), excluding inherited ones

Type: Array.<Attribute>

getOwnedLabelValue(name) → {string|null}

Parameters:

Name	Type	Description
`name`	string	label name

Source:

becca/entities/note.js, line 488

Returns:

label value if label exists, null otherwise

Type: string | null

getOwnedLabelValues(nameopt) → {Array.<string>}

Parameters:

Name	Type	Attributes	Description
`name`	string	<optional>	label name to filter

Source:

becca/entities/note.js, line 572

Returns:

all note's label values, excluding inherited ones

Type: Array.<string>

getOwnedRelation(name) → {Attribute|null}

Parameters:

Name	Type	Description
`name`	string	relation name

Source:

becca/entities/note.js, line 476

Returns:

relation if it exists, null otherwise

Type: Attribute | null

getOwnedRelations(nameopt) → {Array.<Attribute>}

Parameters:

Name	Type	Attributes	Description
`name`	string	<optional>	relation name to filter

Source:

becca/entities/note.js, line 588

Returns:

all note's relations (attributes with type relation), excluding inherited ones

Type: Array.<Attribute>

getOwnedRelationValue(name) → {string|null}

Parameters:

Name	Type	Description
`name`	string	relation name

Source:

becca/entities/note.js, line 500

Returns:

relation value if relation exists, null otherwise

Type: string | null

getParentBranches() → {Array.<Branch>}

Source:

becca/entities/note.js, line 135

Returns:

Type: Array.<Branch>

getParentNotes() → {Array.<Note>}

Source:

becca/entities/note.js, line 148

Returns:

Type: Array.<Note>

getRelation(name) → {Attribute|null}

Parameters:

Name	Type	Description
`name`	string	relation name

Source:

becca/entities/note.js, line 470

Returns:

relation if it exists, null otherwise

Type: Attribute | null

getRelations(nameopt) → {Array.<Attribute>}

Parameters:

Name	Type	Attributes	Description
`name`	string	<optional>	relation name to filter

Source:

becca/entities/note.js, line 580

Returns:

all note's relations (attributes with type relation), including inherited ones

Type: Array.<Attribute>

getRelationValue(name) → {string|null}

Parameters:

Name	Type	Description
`name`	string	relation name

Source:

becca/entities/note.js, line 494

Returns:

relation value if relation exists, null otherwise

Type: string | null

getScriptEnv() → {string|null}

Source:

becca/entities/note.js, line 308

Returns:

JS script environment - either "frontend" or "backend"

Type: string | null

getSubtreeNoteIds() → {Array.<String>}

Source:

becca/entities/note.js, line 801

Returns:

Type: Array.<String>

getSubtreeNotes() → {Array.<Note>}

Source:

becca/entities/note.js, line 780

Returns:

Type: Array.<Note>

getSubtreeNotesIncludingTemplated() → {Array.<Note>}

Source:

becca/entities/note.js, line 749

Returns:

Type: Array.<Note>

getTemplatedNotes() → {Array.<Note>}

Source:

becca/entities/note.js, line 898

Returns:

- returns only notes which are templated, does not include their subtrees in effect returns notes which are influenced by note's non-inheritable attributes

Type: Array.<Note>

hasAncestor() → {boolean}

Source:

becca/entities/note.js, line 882

Returns:

Type: boolean

hasChildren() → {boolean}

Source:

becca/entities/note.js, line 158

Returns:

Type: boolean

hasLabel(name) → {boolean}

Parameters:

Name	Type	Description
`name`	string	label name

Source:

becca/entities/note.js, line 434

Returns:

true if label exists (including inherited)

Type: boolean

hasOwnedAttribute(type, name) → {boolean}

Parameters:

Name	Type	Description
`type`	string	attribute type (label, relation, etc.)
`name`	string	attribute name

Source:

becca/entities/note.js, line 507

Returns:

true if note has an attribute with given type and name (excluding inherited)

Type: boolean

hasOwnedLabel(name) → {boolean}

Parameters:

Name	Type	Description
`name`	string	label name

Source:

becca/entities/note.js, line 440

Returns:

true if label exists (excluding inherited)

Type: boolean

hasOwnedRelation(name) → {boolean}

Parameters:

Name	Type	Description
`name`	string	relation name

Source:

becca/entities/note.js, line 452

Returns:

true if relation exists (excluding inherited)

Type: boolean

hasRelation(name) → {boolean}

Parameters:

Name	Type	Description
`name`	string	relation name

Source:

becca/entities/note.js, line 446

Returns:

true if relation exists (including inherited)

Type: boolean

isDescendantOfNote(ancestorNoteId) → {boolean}

Parameters:

Name	Type	Description
`ancestorNoteId`

Source:

becca/entities/note.js, line 957

Returns:

- true if ancestorNoteId occurs in at least one of the note's paths

Type: boolean

isHtml() → {boolean}

Source:

becca/entities/note.js, line 297

Returns:

true if this note is HTML

Type: boolean

isJavaScript() → {boolean}

Source:

becca/entities/note.js, line 289

Returns:

true if this note is JavaScript (code or attachment)

Type: boolean

isJson() → {boolean}

Source:

becca/entities/note.js, line 284

Returns:

true if this note is of application/json content type

Type: boolean

isRoot() → {boolean}

Source:

becca/entities/note.js, line 279

Returns:

true if this note is the root of the note tree. Root note has "root" noteId

Type: boolean

isStringNote() → {boolean}

Source:

becca/entities/note.js, line 303

Returns:

true if the note has string content (not binary)

Type: boolean

removeAttribute(type, name, valueopt)

Removes given attribute name-value pair if it exists.

Parameters:

Name	Type	Attributes	Description
`type`	string		attribute type (label, relation, etc.)
`name`	string		attribute name
`value`	string	<optional>	attribute value (optional)

Source:

becca/entities/note.js, line 1001

removeLabel(name, valueopt)

Remove label name-value pair, if it exists.

Parameters:

Name	Type	Attributes	Description
`name`	string		label name
`value`	string	<optional>	label value

Source:

becca/entities/note.js, line 1092

removeRelation(name, valueopt)

Remove relation name-value pair, if it exists.

Parameters:

Name	Type	Attributes	Description
`name`	string		relation name
`value`	string	<optional>	relation value (noteId)

Source:

becca/entities/note.js, line 1100

setAttribute(type, name, valueopt)

Update's given attribute's value or creates it if it doesn't exist

Parameters:

Name	Type	Attributes	Description
`type`	string		attribute type (label, relation, etc.)
`name`	string		attribute name
`value`	string	<optional>	attribute value (optional)

Source:

becca/entities/note.js, line 970

setLabel(name, valueopt)

Update's given label's value or creates it if it doesn't exist

Parameters:

Name	Type	Attributes	Description
`name`	string		label name
`value`	string	<optional>	label value

Source:

becca/entities/note.js, line 1076

setRelation(name, value)

Update's given relation's value or creates it if it doesn't exist

Parameters:

Name	Type	Description
`name`	string	relation name
`value`	string	relation value (noteId)

Source:

becca/entities/note.js, line 1084

toggleAttribute(type, enabled, name, valueopt)

Based on enabled, attribute is either set or removed.

Parameters:

Name	Type	Attributes	Description
`type`	string		attribute type ('relation', 'label' etc.)
`enabled`	boolean		toggle On or Off
`name`	string		attribute name
`value`	string	<optional>	attribute value (optional)

Source:

becca/entities/note.js, line 1043

toggleLabel(enabled, name, valueopt)

Based on enabled, label is either set or removed.

Parameters:

Name	Type	Attributes	Description
`enabled`	boolean		toggle On or Off
`name`	string		label name
`value`	string	<optional>	label value (optional)

Source:

becca/entities/note.js, line 1059

toggleRelation(enabled, name, valueopt)

Based on enabled, relation is either set or removed.

Parameters:

Name	Type	Attributes	Description
`enabled`	boolean		toggle On or Off
`name`	string		relation name
`value`	string	<optional>	relation value (noteId)

Source:

becca/entities/note.js, line 1068