Skip to content

Commit bee17c8

Browse files
committed
docs(dev): Fix recent changes in the TaskProcessing API
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
1 parent 16c3cd9 commit bee17c8

3 files changed

Lines changed: 13 additions & 4 deletions

File tree

developer_manual/digging_deeper/task_processing.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,8 @@ Important to note here is that ``Image``, ``Audio``, ``Video`` and ``File`` slot
417417

418418
This class would typically be saved into a file in ``lib/TaskProcessing`` of your app but you are free to put it elsewhere as long as it's loadable by Nextcloud's :ref:`dependency injection container<dependency-injection>`.
419419

420+
.. _task_processing-options:
421+
420422
Implementing an advanced TaskProcessing provider
421423
------------------------------------------------
422424

developer_manual/release_notes/deprecations.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ New deprecations
2222

2323
- ``\OCP\Broadcast\Events\\IBroadcastEvent`` is now deprecated as it is unused.
2424

25+
TaskProcessing API
26+
^^^^^^^^^^^^^^^^^^
27+
28+
- ``\OCP\TaskProcessing\ISynchronousWatermarkingProvider`` is now deprecated. ``\OCP\TaskProcessing\ISynchronousOptionsAwareProvider`` should now be used instead.
29+
2530
Older deprecations
2631
------------------
2732

developer_manual/release_notes/new.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ Expensive repair steps are only executed when explicitly requested by the admini
3535

3636
See :ref:`migration-repair-steps` for details.
3737

38+
TaskProcessing API
39+
------------------
40+
41+
Support for streaming the text output of TaskProcessing providers has been added.
42+
See :ref:`task_processing-options` for details about how to adjust your providers.
43+
3844
Added APIs
3945
^^^^^^^^^^
4046

@@ -46,7 +52,3 @@ Changed APIs
4652
- The ``\OCP\TaskProcessing\Task`` class now has ``getPreferStreaming`` and ``setPreferStreaming`` methods for indicating whether the provider should report the output progressively if it supports it.
4753
- The TaskProcessing OCS API now also accepts the ``preferStreaming`` flag when scheduling tasks.
4854

49-
Deprecated APIs
50-
^^^^^^^^^^^^^^^
51-
52-
- ``\OCP\TaskProcessing\ISynchronousWatermarkingProvider`` is now deprecated. ``\OCP\TaskProcessing\ISynchronousOptionsAwareProvider`` should now be used instead.

0 commit comments

Comments
 (0)