Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-06 08:39:17 +01:00
Code Issues Projects Releases Wiki Activity

Add line in dev docs for new hook.

Browse source
This commit is contained in:
Ryan Lanny Jenkins 2021-03-27 12:04:25 -05:00
parent 6c4cb82c03
commit 39b5a7636c
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/dev/plugins.rst
View file

@ -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