joplin.workspace

The workspace service provides access to all the parts of Joplin that are being worked on - i.e. the currently selected notes or notebooks as well as various related events, such as when a new note is selected, or when the note content changes.

View the demo plugin

Index

Methods

Methods

filterEditorContextMenu

filterEditorContextMenu(handler: FilterHandler<EditContextMenuFilterObject>): void

Called just before the editor context menu is about to open. Allows adding items to it.

desktop

Parameters
- handler: FilterHandler<EditContextMenuFilterObject>

onNoteAlarmTrigger

onNoteAlarmTrigger(handler: WorkspaceEventHandler<NoteAlarmTriggerEvent>): Promise<Disposable>

Called when an alarm associated with a to-do is triggered.

Parameters
- handler: WorkspaceEventHandler<NoteAlarmTriggerEvent>

onNoteChange

onNoteChange(handler: ItemChangeHandler): Promise<Disposable>

Called when the content of the current note changes.

Parameters
- handler: ItemChangeHandler

onNoteContentChange

onNoteContentChange(callback: WorkspaceEventHandler<NoteContentChangeEvent>): Promise<void>

Called when the content of a note changes.

deprecated

Use onNoteChange() instead, which is reliably triggered whenever the note content, or any note property changes.

Parameters
- callback: WorkspaceEventHandler<NoteContentChangeEvent>

onNoteSelectionChange

onNoteSelectionChange(callback: WorkspaceEventHandler<NoteSelectionChangeEvent>): Promise<Disposable>

Called when a new note or notes are selected.

Parameters
- callback: WorkspaceEventHandler<NoteSelectionChangeEvent>

onResourceChange

onResourceChange(handler: ResourceChangeHandler): Promise<void>

Called when a resource is changed. Currently this handled will not be called when a resource is added or deleted.

Parameters
- handler: ResourceChangeHandler

onSyncComplete

onSyncComplete(callback: WorkspaceEventHandler<SyncCompleteEvent>): Promise<Disposable>

Called when the synchronisation process has finished.

Parameters
- callback: WorkspaceEventHandler<SyncCompleteEvent>

onSyncStart

onSyncStart(handler: SyncStartHandler): Promise<Disposable>

Called when the synchronisation process is starting.

Parameters
- handler: SyncStartHandler

selectedFolder

selectedFolder(): Promise<FolderEntity>

Gets the currently selected folder. In some cases, for example during search or when viewing a tag, no folder is actually selected in the user interface. In that case, that function would return the last selected folder.

selectedNote

selectedNote(): Promise<any>

Gets the currently selected note. Will be null if no note is selected.

selectedNoteIds

selectedNoteIds(): Promise<string[]>

Gets the IDs of the selected notes (can be zero, one, or many). Use the data API to retrieve information about these notes.