diff options
Diffstat (limited to 'lib/public/SpeechToText/Events')
3 files changed, 140 insertions, 0 deletions
diff --git a/lib/public/SpeechToText/Events/AbstractTranscriptionEvent.php b/lib/public/SpeechToText/Events/AbstractTranscriptionEvent.php new file mode 100644 index 00000000000..6554292d413 --- /dev/null +++ b/lib/public/SpeechToText/Events/AbstractTranscriptionEvent.php @@ -0,0 +1,58 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCP\SpeechToText\Events; + +use OCP\EventDispatcher\Event; +use OCP\Files\File; + +/** + * @since 27.0.0 + * @deprecated 30.0.0 + */ +abstract class AbstractTranscriptionEvent extends Event { + /** + * @since 27.0.0 + */ + public function __construct( + private int $fileIdId, + private ?File $file, + private ?string $userId, + private string $appId, + ) { + parent::__construct(); + } + + /** + * @since 27.0.0 + */ + public function getFileId(): int { + return $this->fileIdId; + } + + /** + * @since 27.0.0 + */ + public function getFile(): ?File { + return $this->file; + } + + /** + * @since 27.0.0 + */ + public function getUserId(): ?string { + return $this->userId; + } + + /** + * @since 27.0.0 + */ + public function getAppId(): string { + return $this->appId; + } +} diff --git a/lib/public/SpeechToText/Events/TranscriptionFailedEvent.php b/lib/public/SpeechToText/Events/TranscriptionFailedEvent.php new file mode 100644 index 00000000000..4c2b0d52017 --- /dev/null +++ b/lib/public/SpeechToText/Events/TranscriptionFailedEvent.php @@ -0,0 +1,41 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ + + +namespace OCP\SpeechToText\Events; + +use OCP\Files\File; + +/** + * This Event is emitted if a transcription of a media file using a Speech-To-Text provider failed + * @since 27.0.0 + * @deprecated 30.0.0 + */ +class TranscriptionFailedEvent extends AbstractTranscriptionEvent { + /** + * @since 27.0.0 + */ + public function __construct( + int $fileId, + ?File $file, + private string $errorMessage, + ?string $userId, + string $appId, + ) { + parent::__construct($fileId, $file, $userId, $appId); + } + + /** + * @since 27.0.0 + * @return string The error message + */ + public function getErrorMessage(): string { + return $this->errorMessage; + } +} diff --git a/lib/public/SpeechToText/Events/TranscriptionSuccessfulEvent.php b/lib/public/SpeechToText/Events/TranscriptionSuccessfulEvent.php new file mode 100644 index 00000000000..e8e5359a29e --- /dev/null +++ b/lib/public/SpeechToText/Events/TranscriptionSuccessfulEvent.php @@ -0,0 +1,41 @@ +<?php + +declare(strict_types=1); + +/** + * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ + + +namespace OCP\SpeechToText\Events; + +use OCP\Files\File; + +/** + * This Event is emitted when a transcription of a media file happened successfully + * @since 27.0.0 + * @deprecated 30.0.0 + */ +class TranscriptionSuccessfulEvent extends AbstractTranscriptionEvent { + /** + * @since 27.0.0 + */ + public function __construct( + int $fileId, + ?File $file, + private string $transcript, + ?string $userId, + string $appId, + ) { + parent::__construct($fileId, $file, $userId, $appId); + } + + /** + * @since 27.0.0 + * @return string The transcript of the media file + */ + public function getTranscript(): string { + return $this->transcript; + } +} |