2016-08-26 15:47:38 +00:00
|
|
|
.. sec-jsclientlib-wizard:
|
|
|
|
|
|
|
|
|
|
:mod:`OctoPrint.wizard`
|
|
|
|
|
-----------------------
|
|
|
|
|
|
2016-09-28 10:53:43 +00:00
|
|
|
.. note::
|
2016-08-26 15:47:38 +00:00
|
|
|
|
2016-09-28 10:53:43 +00:00
|
|
|
All methods here require that the used API token or a the existing browser session
|
|
|
|
|
has admin rights.
|
2016-08-26 15:47:38 +00:00
|
|
|
|
|
|
|
|
.. js:function:: OctoPrint.wizard.get(opts)
|
|
|
|
|
|
2016-09-28 10:53:43 +00:00
|
|
|
Retrieve additional data about registered wizards.
|
|
|
|
|
|
|
|
|
|
:param object opts: Additional options for the request
|
|
|
|
|
:returns Promise: A `jQuery Promise <http://api.jquery.com/Types/#Promise>`_ for the request's response
|
|
|
|
|
|
2016-08-26 15:47:38 +00:00
|
|
|
.. js:function:: OctoPrint.wizard.finish(handled, opts)
|
2016-09-28 10:53:43 +00:00
|
|
|
|
|
|
|
|
Inform wizards that the wizard dialog has been finished.
|
|
|
|
|
|
|
|
|
|
:param list handled: List of identifiers of handled wizards
|
|
|
|
|
: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:`Wizard API <sec-api-wizard>`
|
|
|
|
|
The documentation of the underlying wizard API.
|
