Skip to main content

Interface: IUserDataApi

Defined in: Api/IUserDataApi.ts:14

Methods​

addVerseToCollection()​

addVerseToCollection(collectionId, verseId): Promise<void>

Defined in: Api/IUserDataApi.ts:48

Parameters​

collectionId​

number

verseId​

number

Returns​

Promise<void>

createCollection()​

createCollection(name, parentId?): Promise<{ collectionId: number; name: string; }>

Defined in: Api/IUserDataApi.ts:47

Parameters​

name​

string

parentId?​

number

Returns​

Promise<{ collectionId: number; name: string; }>

createHighlight()​

createHighlight(verseId, moduleAbbreviation, colorCode): Promise<UserHighlightResult>

Defined in: Api/IUserDataApi.ts:23

Parameters​

verseId​

number

moduleAbbreviation​

string

colorCode​

string

Returns​

Promise<UserHighlightResult>

createNote()​

createNote(note): Promise<UserNoteResult>

Defined in: Api/IUserDataApi.ts:31

Parameters​

note​
content​

string

noteType​

string

tags?​

string[]

title​

string

verseId?​

number

Returns​

Promise<UserNoteResult>

createUserCrossReference()​

createUserCrossReference(sourceVerseId, targetVerseId, notes?): Promise<UserCrossReferenceResult>

Defined in: Api/IUserDataApi.ts:17

Parameters​

sourceVerseId​

number

targetVerseId​

number

notes?​

string

Returns​

Promise<UserCrossReferenceResult>

deleteHighlight()​

deleteHighlight(highlightId): Promise<void>

Defined in: Api/IUserDataApi.ts:25

Parameters​

highlightId​

number

Returns​

Promise<void>

deleteNote()​

deleteNote(noteId): Promise<void>

Defined in: Api/IUserDataApi.ts:43

Parameters​

noteId​

number

Returns​

Promise<void>

deleteUserCrossReference()​

deleteUserCrossReference(crossRefId): Promise<void>

Defined in: Api/IUserDataApi.ts:18

Parameters​

crossRefId​

number

Returns​

Promise<void>

getCollections()​

getCollections(): Promise<object[]>

Defined in: Api/IUserDataApi.ts:46

Returns​

Promise<object[]>

getHighlightsForModule()​

getHighlightsForModule(moduleAbbreviation): Promise<UserHighlightResult[]>

Defined in: Api/IUserDataApi.ts:22

Parameters​

moduleAbbreviation​

string

Returns​

Promise<UserHighlightResult[]>

getHighlightsForVerse()​

getHighlightsForVerse(verseId): Promise<UserHighlightResult[]>

Defined in: Api/IUserDataApi.ts:21

Parameters​

verseId​

number

Returns​

Promise<UserHighlightResult[]>

getNoteById()​

getNoteById(noteId): Promise<UserNoteResult | null>

Defined in: Api/IUserDataApi.ts:28

Parameters​

noteId​

number

Returns​

Promise<UserNoteResult | null>

getNotesForVerse()​

getNotesForVerse(verseId): Promise<UserNoteResult[]>

Defined in: Api/IUserDataApi.ts:29

Parameters​

verseId​

number

Returns​

Promise<UserNoteResult[]>

getUserCrossReferences()​

getUserCrossReferences(verseId): Promise<UserCrossReferenceResult[]>

Defined in: Api/IUserDataApi.ts:16

Parameters​

verseId​

number

Returns​

Promise<UserCrossReferenceResult[]>

isVerseBookmarked()​

isVerseBookmarked(verseId): Promise<boolean>

Defined in: Api/IUserDataApi.ts:50

Parameters​

verseId​

number

Returns​

Promise<boolean>

removeVerseFromCollection()​

removeVerseFromCollection(collectionId, verseId): Promise<void>

Defined in: Api/IUserDataApi.ts:49

Parameters​

collectionId​

number

verseId​

number

Returns​

Promise<void>

searchNotes()​

searchNotes(query): Promise<UserNoteResult[]>

Defined in: Api/IUserDataApi.ts:30

Parameters​

query​

string

Returns​

Promise<UserNoteResult[]>

updateHighlight()​

updateHighlight(highlightId, colorCode): Promise<UserHighlightResult>

Defined in: Api/IUserDataApi.ts:24

Parameters​

highlightId​

number

colorCode​

string

Returns​

Promise<UserHighlightResult>

updateNote()​

updateNote(noteId, updates): Promise<UserNoteResult>

Defined in: Api/IUserDataApi.ts:38

Parameters​

noteId​

number

updates​
content?​

string

tags?​

string[]

title?​

string

Returns​

Promise<UserNoteResult>