eaadf8743b
We now have a global OctoPrintClient, which is the class from which
all clients are derived, and a global OctoPrint, which is a single
instance already setup and ready to use in case we only need one.
It would be cleaner to have clients create that singular instance
themselves, but we need to maintain backward compatibility for now
with how we established the client to work with the 1.3.0 release.
New clients can be create with
client = new OctoPrintClient({ /* options */ });
Alternatively the options can be left out and set at a later point:
client = new OctoPrintClient();
/* ... */
client.options = { /* options */ };
Individual client components register themselves with OctoPrintClient
via OctoPrintClient.registerComponent(name, component) from the
component JS files. Just like before their instances are then
available in the individual client instances under "<client>.<name>",
e.g. "OctoPrint.files".
Plugin components register themselves with OctoPrintClient via
OctoPrintClient.registerPluginComponent(name, component) from the
component JS files. Just like before their instances are then
available in the individual client instances under "<client>.plugins
.<name>", e.g. "OctoPrint.plugins.softwareupdate".
This should make it possible to create dashboard pages utilizing the
JS client that monitor the status of multiple OctoPrint instances,
without workarounds such as having to swap out the options globally
before each request.
See #1681 for the corresponding discussion.
41 lines
1.5 KiB
ReStructuredText
41 lines
1.5 KiB
ReStructuredText
.. _sec-jsclientlib-settings:
|
|
|
|
:mod:`OctoPrintClient.settings`
|
|
-------------------------------
|
|
|
|
.. js:function:: OctoPrintClient.settings.get(opts)
|
|
|
|
Retrieves the current settings.
|
|
|
|
:param object opts: Additional options for the request
|
|
:returns Promise: A `jQuery Promise <http://api.jquery.com/Types/#Promise>`_ for the request's response
|
|
|
|
.. js:function:: OctoPrintClient.settings.save(settings, opts)
|
|
|
|
Saves the provided ``settings``.
|
|
|
|
:param object settings: The settings to save
|
|
:param object opts: Additional options for the request
|
|
:returns Promise: A `jQuery Promise <http://api.jquery.com/Types/#Promise>`_ for the request's response
|
|
|
|
.. js:function:: OctoPrintClient.settings.getPluginSettings(plugin, opts)
|
|
|
|
Retrieves the settings of the specified ``plugin``.
|
|
|
|
:param string plugin: The plugin for which to retrieve the settings
|
|
:param object opts: Additional options for the request
|
|
:returns Promise: A `jQuery Promise <http://api.jquery.com/Types/#Promise>`_ for the request's response
|
|
|
|
.. js:function:: OctoPrintClient.settings.savePluginSettings(plugin, settings, opts)
|
|
|
|
Saves the ``settings`` for the specified ``plugin``.
|
|
|
|
:param string plugin: The plugin for which to save settings
|
|
:param object settings: The settings to save
|
|
:param object opts: Additional options for the request
|
|
:returns Promise: A `jQuery Promise <http://api.jquery.com/Types/#Promise>`_ for the request's response
|
|
|
|
.. seealso::
|
|
|
|
:ref:`Settings API <sec-api-settings>`
|
|
The documentation of the underlying settings API.
|