Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.53 KB

settings.rst

File metadata and controls

41 lines (26 loc) · 1.53 KB
Raw

: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.