ui/client/features/notes/services/NotesApi
Durable Notes over ui/server's /api/notes.
Cockpit client (features), next. Source: ui/client/features/notes/services/NotesApi.ts.
Functions#
createNote()#
Defined in: ui/client/features/notes/services/NotesApi.ts:34
anchor is for a caller that keeps a note of its own anchored to a specific place, e.g. the Pages
editor's Inspector "Notes" section -- omitted entirely (not even null), the server's own default applies.
Parameters#
draft?
Partial<Draft> = {}
opts?
anchor?
NoteAnchor | null
Returns#
duplicateNote()#
Defined in: ui/client/features/notes/services/NotesApi.ts:59
Parameters#
id
string
Returns#
fetchNote()#
Defined in: ui/client/features/notes/services/NotesApi.ts:22
Parameters#
id
string
Returns#
listNotes()#
Defined in: ui/client/features/notes/services/NotesApi.ts:12
Returns#
removeNote()#
removeNote(
id):Promise<ApiResult<string>>
Defined in: ui/client/features/notes/services/NotesApi.ts:69
Parameters#
id
string
Returns#
Promise<ApiResult<string>>
saveNote()#
saveNote(
id,rev,draft,extra?):Promise<SaveResult>
Defined in: ui/client/features/notes/services/NotesApi.ts:48
Save against rev (sent as If-Match). 409 STALE_REV hands back the copy that won. extra carries a plan and its
status when the caller (the Plan screen, ) saves one along with the text; the server marks the plan out of date
when text is saved without one.
Parameters#
id
string
rev
number
draft
extra?
plan?
unknown
status?
Returns#
Promise<SaveResult>