Passed
Push — master ( f5c4f5...fd473f )
by Joas
18:20 queued 13s
created

TranscriptionSuccessfulEvent::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 8
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
nc 1
nop 5
dl 0
loc 8
rs 10
c 2
b 0
f 0
1
<?php
2
3
declare(strict_types=1);
4
5
/**
6
 * @copyright Copyright (c) 2023 Marcel Klehr <[email protected]>
7
 *
8
 * @author Marcel Klehr <[email protected]>
9
 *
10
 * @license GNU AGPL version 3 or any later version
11
 *
12
 * This program is free software: you can redistribute it and/or modify
13
 * it under the terms of the GNU Affero General Public License as
14
 * published by the Free Software Foundation, either version 3 of the
15
 * License, or (at your option) any later version.
16
 *
17
 * This program is distributed in the hope that it will be useful,
18
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20
 * GNU Affero General Public License for more details.
21
 *
22
 * You should have received a copy of the GNU Affero General Public License
23
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24
 */
25
26
27
namespace OCP\SpeechToText\Events;
28
29
use OCP\Files\File;
30
31
/**
32
 * This Event is emitted when a transcription of a media file happened successfully
33
 * @since 27.0.0
34
 */
35
class TranscriptionSuccessfulEvent extends AbstractTranscriptionEvent {
36
	/**
37
	 * @since 27.0.0
38
	 */
39
	public function __construct(
40
		int $fileId,
41
		?File $file,
42
		private string $transcript,
43
		?string $userId,
44
		string $appId,
45
	) {
46
		parent::__construct($fileId, $file, $userId, $appId);
47
	}
48
49
	/**
50
	 * @since 27.0.0
51
	 * @return string The transcript of the media file
52
	 */
53
	public function getTranscript(): string {
54
		return $this->transcript;
55
	}
56
}
57