This is the main entry point to the Joplin API. You can access various services using the provided accessors.
This is a beta API
Please note that the plugin API is relatively new and should be considered Beta state. Besides possible bugs, what it means is that there might be necessary breaking changes from one version to the next. Whenever such change is needed, best effort will be done to:
Maintain backward compatibility;
When possible, deprecate features instead of removing them;
Document breaking changes in the changelog;
So if you are developing a plugin, please keep an eye on the changelog as everything will be in there with information about how to update your code. There won't be any major API rewrite or architecture changes, but possibly small tweaks like function signature change, type change, etc.
Eventually, the plugin API will be versioned to make this process smoother.
It is not possible to bundle native packages with a plugin, because they
need to work cross-platforms. Instead access to certain useful native
packages is provided using this function.
This is the main entry point to the Joplin API. You can access various services using the provided accessors.
This is a beta API
Please note that the plugin API is relatively new and should be considered Beta state. Besides possible bugs, what it means is that there might be necessary breaking changes from one version to the next. Whenever such change is needed, best effort will be done to:
So if you are developing a plugin, please keep an eye on the changelog as everything will be in there with information about how to update your code. There won't be any major API rewrite or architecture changes, but possibly small tweaks like function signature change, type change, etc.
Eventually, the plugin API will be versioned to make this process smoother.