Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Notes

Methods about the notes of the open packs: comments attached to their files and folders.

notes.list

Returns the notes of an open pack for a path.

Params (ListNotes)

NameTypeRequiredDescription
packstringyesKey of the pack.
pathstringno, default ""Path of the file or folder whose notes to return, with the notes of the folders containing it. Empty for all the notes of the pack.

Result (NoteList)

NameTypeRequiredDescription
notesarray of NoteEntryyesThe notes.

notes.add

Attaches a note to a file or folder of an open pack.

Params (AddNote)

NameTypeRequiredDescription
packstringyesKey of the pack.
pathstringno, default ""Path of the file or folder to attach the note to. Empty for the whole pack.
messagestringyesText of the note.
urlstring or nullnoLink to attach to the note.
idinteger or nullnoID of a note attached to the same path, to replace it instead of adding a new one.

Result (NoteEntry)

NameTypeRequiredDescription
idintegeryesID of the note, unique within its path.
pathstringyesPath of the file or folder the note is attached to. Empty for the whole pack.
messagestringyesText of the note.
urlstring or nullnoLink attached to the note, if any.

notes.delete

Deletes a note of an open pack.

Params (DeleteNote)

NameTypeRequiredDescription
packstringyesKey of the pack.
pathstringyesPath the note is attached to.
idintegeryesID of the note.

Result (Done)

Empty object: {}.

Types

Type NoteEntry

A note of a pack.

NameTypeRequiredDescription
idintegeryesID of the note, unique within its path.
pathstringyesPath of the file or folder the note is attached to. Empty for the whole pack.
messagestringyesText of the note.
urlstring or nullnoLink attached to the note, if any.