Skip to main content

Class: UserNote

Defined in: Data/Models/User/UserNote.ts:7

User note entity from the user database Represents a user-created note (verse note, sermon, study, journal entry, etc.)

Constructors​

Constructor​

new UserNote(data): UserNote

Defined in: Data/Models/User/UserNote.ts:32

Parameters​

data​
content​

string

contentFormat?​

ContentFormat

createdDate?​

string

documentType?​

string

entryDate?​

string

metadata?​

Metadata

modifiedDate?​

string

noteId?​

number

noteType?​

"verse_note" | "document" | "sermon" | "study" | "journal" | "prayer"

parentNoteId?​

number

seriesName?​

string

tags?​

string[]

title?​

string

userCommentaryId?​

number

verseIdEnd?​

number

verseIdStart?​

number

visibility?​

Visibility

Returns​

UserNote

Properties​

content​

content: string

Defined in: Data/Models/User/UserNote.ts:14

contentFormat​

contentFormat: ContentFormat

Defined in: Data/Models/User/UserNote.ts:15

createdDate?​

optional createdDate?: string

Defined in: Data/Models/User/UserNote.ts:19

documentType?​

optional documentType?: string

Defined in: Data/Models/User/UserNote.ts:17

entryDate?​

optional entryDate?: string

Defined in: Data/Models/User/UserNote.ts:23

metadata?​

optional metadata?: Metadata

Defined in: Data/Models/User/UserNote.ts:24

modifiedDate?​

optional modifiedDate?: string

Defined in: Data/Models/User/UserNote.ts:20

noteId?​

optional noteId?: number

Defined in: Data/Models/User/UserNote.ts:8

noteType​

noteType: "verse_note" | "document" | "sermon" | "study" | "journal" | "prayer"

Defined in: Data/Models/User/UserNote.ts:16

parentNoteId?​

optional parentNoteId?: number

Defined in: Data/Models/User/UserNote.ts:10

seriesName?​

optional seriesName?: string

Defined in: Data/Models/User/UserNote.ts:22

tags​

tags: string[]

Defined in: Data/Models/User/UserNote.ts:21

title?​

optional title?: string

Defined in: Data/Models/User/UserNote.ts:13

userCommentaryId?​

optional userCommentaryId?: number

Defined in: Data/Models/User/UserNote.ts:9

verseIdEnd?​

optional verseIdEnd?: number

Defined in: Data/Models/User/UserNote.ts:12

verseIdStart?​

optional verseIdStart?: number

Defined in: Data/Models/User/UserNote.ts:11

visibility​

visibility: Visibility

Defined in: Data/Models/User/UserNote.ts:18

Methods​

addChild()​

addChild(note): void

Defined in: Data/Models/User/UserNote.ts:101

Add a child note

Parameters​

note​

UserNote

Returns​

void

addLinkedVerse()​

addLinkedVerse(link): void

Defined in: Data/Models/User/UserNote.ts:156

Add a linked verse

Parameters​

VerseLink

Returns​

void

addTag()​

addTag(tag): void

Defined in: Data/Models/User/UserNote.ts:121

Add a tag

Parameters​

tag​

string

Returns​

void

getChildren()​

getChildren(): UserNote[]

Defined in: Data/Models/User/UserNote.ts:94

Get child notes

Returns​

UserNote[]

getExcerpt()​

getExcerpt(maxLength?): string

Defined in: Data/Models/User/UserNote.ts:177

Get a brief excerpt of the content (for previews)

Parameters​

maxLength?​

number = 100

Returns​

string

getLinkedVerses()​

getLinkedVerses(): VerseLink[]

Defined in: Data/Models/User/UserNote.ts:149

Get linked verses

Returns​

VerseLink[]

hasChildren()​

hasChildren(): boolean

Defined in: Data/Models/User/UserNote.ts:87

Check if this note has child notes

Returns​

boolean

hasTag()​

hasTag(tag): boolean

Defined in: Data/Models/User/UserNote.ts:142

Check if note has a specific tag

Parameters​

tag​

string

Returns​

boolean

isAboutVerse()​

isAboutVerse(): boolean

Defined in: Data/Models/User/UserNote.ts:73

Check if this note is about a specific verse passage

Returns​

boolean

isVerseRange()​

isVerseRange(): boolean

Defined in: Data/Models/User/UserNote.ts:80

Check if this is a verse range (multiple verses)

Returns​

boolean

removeChild()​

removeChild(noteId): boolean

Defined in: Data/Models/User/UserNote.ts:109

Remove a child note

Parameters​

noteId​

number

Returns​

boolean

removeTag()​

removeTag(tag): boolean

Defined in: Data/Models/User/UserNote.ts:130

Remove a tag

Parameters​

tag​

string

Returns​

boolean

setLinkedVerses()​

setLinkedVerses(links): void

Defined in: Data/Models/User/UserNote.ts:163

Set all linked verses (from repository query)

Parameters​

VerseLink[]

Returns​

void

touch()​

touch(): void

Defined in: Data/Models/User/UserNote.ts:170

Update the modified date to now

Returns​

void