blob: 03444449d58f918e33d87c081588260115170699 (
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
70
71
72
73
74
75
76
77
|
<?php
declare(strict_types=1);
/*
* @copyright 2023 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author 2023 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\User;
use OCP\IUser;
/**
* DTO to hold out-of-office information of a user
*
* @since 28.0.0
*/
interface IOutOfOfficeData {
/**
* Get the unique token assigned to the current out-of-office event
*
* @since 28.0.0
*/
public function getId(): string;
/**
* @since 28.0.0
*/
public function getUser(): IUser;
/**
* Get the accurate out-of-office start date
*
* This event is not guaranteed to be emitted exactly at start date
*
* @since 28.0.0
*/
public function getStartDate(): int;
/**
* Get the (preliminary) out-of-office end date
*
* @since 28.0.0
*/
public function getEndDate(): int;
/**
* Get the short summary text displayed in the user status and similar
*
* @since 28.0.0
*/
public function getShortMessage(): string;
/**
* Get the long out-of-office message for auto responders and similar
*
* @since 28.0.0
*/
public function getMessage(): string;
}
|
