From 39b5a7636c33fcffe0001f8038b1dc28f0af28d5 Mon Sep 17 00:00:00 2001 From: Ryan Lanny Jenkins Date: Sat, 27 Mar 2021 12:04:25 -0500 Subject: [PATCH] Add line in dev docs for new hook. --- docs/dev/plugins.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst index a6aa3d6d7..8a75bc142 100644 --- a/docs/dev/plugins.rst +++ b/docs/dev/plugins.rst @@ -200,6 +200,14 @@ The events currently available are: import pipeline stage is a better choice (see :ref:`plugin-stage`). Parameters: ``task`` and ``session``. +* `import_task_before_choice`: called after candidate search for an import task + before any decision is made about how/if to import or tag. Can be used to + present information about the task or initiate interaction with the user + before importing occurs. Return an importer action to take a specific action. + Parameters: ``task``, ``session``, and ``previous`` (which is the action + specified by the previous event handler for the same task, allowing an early + exist if e.g. a previous plugin has already selected to skip the import) + * `import_task_choice`: called after a decision has been made about an import task. This event can be used to initiate further interaction with the user. Use ``task.choice_flag`` to determine or change the action to be