Skip to main content

Interface: IUserNoteRepository

Defined in: Data/Repositories/IUserNoteRepository.ts:20

Interface for User Note repository Defines all operations for working with user notes in the user database

Methods​

countDescendants()​

countDescendants(noteId): number

Defined in: Data/Repositories/IUserNoteRepository.ts:28

Parameters​

noteId​

number

Returns​

number

create()​

create(entity): UserNote

Defined in: Data/Repositories/IUserNoteRepository.ts:40

Parameters​

entity​

UserNote

Returns​

UserNote

delete()​

delete(id): boolean

Defined in: Data/Repositories/IUserNoteRepository.ts:42

Parameters​

id​

number

Returns​

boolean

getAll()​

getAll(options?): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:22

Parameters​

options?​

RepositoryQueryOptions

Returns​

UserNote[]

getAllNoteSummaries()​

getAllNoteSummaries(): NoteSummary[]

Defined in: Data/Repositories/IUserNoteRepository.ts:37

Returns​

NoteSummary[]

getById()​

getById(id): UserNote | undefined

Defined in: Data/Repositories/IUserNoteRepository.ts:21

Parameters​

id​

number

Returns​

UserNote | undefined

getByTag()​

getByTag(tag): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:31

Parameters​

tag​

string

Returns​

UserNote[]

getByType()​

getByType(noteType): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:23

Parameters​

noteType​

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

Returns​

UserNote[]

getChildNotes()​

getChildNotes(parentNoteId): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:27

Parameters​

parentNoteId​

number

Returns​

UserNote[]

getForVerse()​

getForVerse(verseId): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:24

Parameters​

verseId​

number

Returns​

UserNote[]

getForVerseRange()​

getForVerseRange(startVerseId, endVerseId): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:25

Parameters​

startVerseId​

number

endVerseId​

number

Returns​

UserNote[]

getModifiedSince()​

getModifiedSince(since, limit?): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:32

Parameters​

since​

string

limit?​

number

Returns​

UserNote[]

getNextVerseWithContent()​

getNextVerseWithContent(currentVerseId): number | undefined

Defined in: Data/Repositories/IUserNoteRepository.ts:35

Parameters​

currentVerseId​

number

Returns​

number | undefined

getPreviousVerseWithContent()​

getPreviousVerseWithContent(currentVerseId): number | undefined

Defined in: Data/Repositories/IUserNoteRepository.ts:36

Parameters​

currentVerseId​

number

Returns​

number | undefined

getTopLevelNotes()​

getTopLevelNotes(): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:26

Returns​

UserNote[]

getVersesWithNotesInRange()​

getVersesWithNotesInRange(startVerseId, endVerseId): number[]

Defined in: Data/Repositories/IUserNoteRepository.ts:38

Parameters​

startVerseId​

number

endVerseId​

number

Returns​

number[]

search(query): UserNote[]

Defined in: Data/Repositories/IUserNoteRepository.ts:30

Parameters​

query​

string

Returns​

UserNote[]

update()​

update(entity): UserNote

Defined in: Data/Repositories/IUserNoteRepository.ts:41

Parameters​

entity​

UserNote

Returns​

UserNote