82 lines
2.7 KiB
ReStructuredText
82 lines
2.7 KiB
ReStructuredText
.. sec-jsclientlib-job:
|
|
|
|
:mod:`OctoPrint.job`
|
|
--------------------
|
|
|
|
.. js:function:: OctoPrint.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:: OctoPrint.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:: OctoPrint.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:: OctoPrint.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:: OctoPrint.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:: OctoPrint.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:: OctoPrint.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
|
|
|