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.
39 lines
1.3 KiB
ReStructuredText
39 lines
1.3 KiB
ReStructuredText
.. _sec-jsclientlib-logs:
|
|
|
|
:mod:`OctoPrintClient.logs`
|
|
---------------------------
|
|
|
|
.. note::
|
|
|
|
All methods here require that the used API token or a the existing browser session
|
|
has admin rights.
|
|
|
|
.. js:function:: OctoPrintClient.logs.list(opts)
|
|
|
|
Retrieves a list of log files.
|
|
|
|
See :ref:`Retrieve a list of available log files <sec-api-logs-list>` 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.logs.delete(path, opts)
|
|
|
|
Deletes the specified log ``path``.
|
|
|
|
See :ref:`Delete a specific log file <sec-api-logs-delete>` for details.
|
|
|
|
:param string path: The path to the log file to delete
|
|
: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.logs.download(path, opts)
|
|
|
|
Downloads the specified log ``file``.
|
|
|
|
See :js:func:`OctoPrint.download` for more details on the underlying library download mechanism.
|
|
|
|
:param string path: The path to the log file to download
|
|
:param object opts: Additional options for the request
|
|
:returns Promise: A `jQuery Promise <http://api.jquery.com/Types/#Promise>`_ for the request's response
|
|
|