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.
82 lines
2.7 KiB
ReStructuredText
82 lines
2.7 KiB
ReStructuredText
.. _sec-jsclientlib-job:
|
|
|
|
:mod:`OctoPrintClient.job`
|
|
--------------------------
|
|
|
|
.. js:function:: OctoPrintClient.job.get(opts)
|
|
|
|
Retrieves information about the current job.
|
|
|
|
See :ref:`Retrieve information about the current job <sec-api-job-information>` for details.
|
|
|
|
: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.job.start(opts)
|
|
|
|
Starts the current job.
|
|
|
|
See :ref:`Issue a job command <sec-api-jobs-command>` for details.
|
|
|
|
: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.job.cancel(opts)
|
|
|
|
Cancels the current job.
|
|
|
|
See :ref:`Issue a job command <sec-api-jobs-command>` for details.
|
|
|
|
: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.job.restart(opts)
|
|
|
|
Restarts the current job. This is equivalent to cancelling and immediately restarting
|
|
the job.
|
|
|
|
**Example:**
|
|
|
|
.. code-block:: javascript
|
|
|
|
OctoPrint.job.restart();
|
|
|
|
// the above is a shorthand for:
|
|
|
|
OctoPrint.job.cancel()
|
|
.done(function(response) {
|
|
OctoPrint.job.start();
|
|
});
|
|
|
|
See :ref:`Issue a job command <sec-api-jobs-command>` for details.
|
|
|
|
: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.job.pause(opts)
|
|
|
|
Pauses the current job if it's running, does nothing if it's already paused.
|
|
|
|
See :ref:`Issue a job command <sec-api-jobs-command>` for details.
|
|
|
|
: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.job.resume(opts)
|
|
|
|
Resumes the current job if it's currently pause, does nothing if it's running.
|
|
|
|
See :ref:`Issue a job command <sec-api-jobs-command>` for details.
|
|
|
|
: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.job.togglePause(opts)
|
|
|
|
Resumes a paused and pauses a running job.
|
|
|
|
See :ref:`Issue a job command <sec-api-jobs-command>` for details.
|
|
|
|
:param object opts: Additional options for the request
|
|
:returns Promise: A `jQuery Promise <http://api.jquery.com/Types/#Promise>`_ for the request's response
|
|
|