Skip to content

Include new task processing manager method in developer doc #13596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julien-nc merged 2 commits into from
Sep 5, 2025
Merged

Include new task processing manager method in developer doc #13596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7b0f08
feat(dev-taskprocessing): include new getAvailableTaskTypeIds in dev doc
julien-nc Sep 4, 2025
38de89f
chore(upgrade_to_32): Add OCP\TaskProcessing\Manager::getAvailableTas…
marcelklehr Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_32.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Added APIs

- New task processing task type ``OCP\TaskProcessing\TextToSpeech`` to convert text to speech.
- New task processing task type ``OCP\TaskProcessing\AnalyzeImages`` to ask questions about images.

- New method ``OCP\TaskProcessing\Manager::getAvailableTaskTypeIds`` to list only task type IDs without meta-data (faster than ``OCP\TaskProcessing\Manager::getAvailableTaskTypes``)

Changed APIs
^^^^^^^^^^^^
Expand Down
6 changes: 5 additions & 1 deletion developer_manual/digging_deeper/task_processing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ To consume the Task Processing API, you will need to :ref:`inject<dependency-in

* ``hasProviders()`` This method returns a boolean which indicates if any providers have been registered. If this is false you cannot use the TextProcessing feature.
* ``getAvailableTaskTypes(bool $showDisabled = false)`` This method returns an array of enabled task types indexed by their ID with their names and additional metadata. If you set ``$showdisabled`` to ``true`` (available since NC31), it will include disabled task types.
* ``getAvailableTaskTypeIds()`` This method (available since NC32) returns a list of available task type IDs. It uses the same logic as ``getAvailableTaskTypes()`` but is faster because it does not compute the task types metadata (which can be slow when getting default field values or multiselect value lists). If you just want to check if a feature is available, prefer using this method rather than ``getAvailableTaskTypes()``.
* ``scheduleTask(Task $task)`` This method provides the actual scheduling functionality. The task is defined using the Task class. This method runs the task asynchronously in a background job.
* ``getTask(int $id)`` This method fetches a task specified by its id.
* ``deleteTask(Task $task)`` This method deletes a task
Expand Down Expand Up @@ -210,7 +211,10 @@ To create a task we use the ``\OCP\TaskProcessing\Task`` class. Its constructor

.. code-block:: php

if (isset($textprocessingManager->getAvailableTaskTypes()[TextToTextSummary::ID]) {
// getAvailableTaskTypeIds is faster than getAvailableTaskTypes
// if (isset($textprocessingManager->getAvailableTaskTypes()[TextToTextSummary::ID]) {
// if you don't need the task type metadata, prefer this:
if (in_array(TextToTextSummary::ID, $textprocessingManager->getAvailableTaskTypeIds(), true) {
$summaryTask = new Task(TextToTextSummary::ID, $emailText, "my_app", $userId, (string) $emailId);
} else {
// cannot use summarization
Expand Down