blob: 550a5e17496d4026f291a7309a8fa0875149eb1c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Files\Events;
use OCP\EventDispatcher\Event;
/**
* This event is triggered when a user tries to download a file
* directly.
*
* @since 25.0.0
*/
class BeforeDirectFileDownloadEvent extends Event {
private string $path;
private bool $successful = true;
private ?string $errorMessage = null;
/**
* @since 25.0.0
*/
public function __construct(string $path) {
parent::__construct();
$this->path = $path;
}
/**
* @since 25.0.0
*/
public function getPath(): string {
return $this->path;
}
/**
* @since 25.0.0
*/
public function isSuccessful(): bool {
return $this->successful;
}
/**
* Set if the event was successful
*
* @since 25.0.0
*/
public function setSuccessful(bool $successful): void {
$this->successful = $successful;
}
/**
* Get the error message, if any
* @since 25.0.0
*/
public function getErrorMessage(): ?string {
return $this->errorMessage;
}
/**
* @since 25.0.0
*/
public function setErrorMessage(string $errorMessage): void {
$this->errorMessage = $errorMessage;
}
}
|