Mercurial > hg > orthanc-book

changeset 232:15823481cf8f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added Jobs Lua callback
author amazy
date Tue, 26 Mar 2019 11:08:26 +0100
parents 1af668e84f4d
children 2e4188a3f3ef
files Sphinx/source/users/lua.rst
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/users/lua.rst	Thu Mar 07 12:41:10 2019 +0100
+++ b/Sphinx/source/users/lua.rst	Tue Mar 26 11:08:26 2019 +0100
@@ -74,6 +74,16 @@
   httpHeaders)``: Invoked to known whether a REST request should be
   accepted. :ref:`See this section <lua-filter-rest>`.
 
+Some **job-related events** allow to react to :ref:`job <jobs>` completion/failure:
+
+* ``function OnJobSubmitted(jobId)``:
+  Invoked when a new job has been submitted.  Note that this does not
+  mean the the job execution has started.
+* ``function OnJobFailure(jobId)``:
+  Invoked when a job has failed.
+* ``function OnJobSuccess(jobId)``: 
+  Invoked when a job has completed successfully.
+
 Some **DICOM-related events** allow to react to the reception of
 new medical images: