mirror of
https://github.com/nextcloud/server.git
synced 2026-11-02 20:11:47 +01:00
37 lines
1.2 KiB
PHP
37 lines
1.2 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
namespace OCP\TaskProcessing;
|
|
|
|
use OCP\AppFramework\Attribute\Implementable;
|
|
use OCP\Files\File;
|
|
use OCP\TaskProcessing\Exception\ProcessingException;
|
|
|
|
/**
|
|
* This is the interface that is implemented by apps that
|
|
* implement a task processing provider
|
|
* @since 30.0.0
|
|
*/
|
|
#[Implementable(since: '30.0.0')]
|
|
interface ISynchronousProvider extends IProvider {
|
|
|
|
/**
|
|
* Returns the shape of optional output parameters
|
|
*
|
|
* @param null|string $userId The user that created the current task
|
|
* @param array<string, list<numeric|string|File>|numeric|string|File> $input The task input
|
|
* @param callable(float):bool $reportProgress Report the task progress. If this returns false, that means the task was cancelled and processing should be stopped.
|
|
* @psalm-return array<string, list<numeric|string|FileShaped>|numeric|string|FileShaped>
|
|
* @throws ProcessingException
|
|
* @since 30.0.0
|
|
* @since 35.0.0 You can now also return a FileShaped object or a list of FileShaped objects
|
|
*/
|
|
public function process(?string $userId, array $input, callable $reportProgress): array;
|
|
}
|