blob: f1640298189b0788901a9b8585935dc542edd1f1 (
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2020, Georg Ehrke
*
* @author Georg Ehrke <oc.list@georgehrke.com>
*
* @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\UserStatus;
use DateTimeImmutable;
/**
* Interface IUserStatus
*
* @package OCP\UserStatus
* @since 20.0.0
*/
interface IUserStatus {
/**
* @var string
* @since 20.0.0
*/
public const ONLINE = 'online';
/**
* @var string
* @since 20.0.0
*/
public const AWAY = 'away';
/**
* @var string
* @since 20.0.0
*/
public const DND = 'dnd';
/**
* @var string
* @since 20.0.0
*/
public const OFFLINE = 'offline';
/**
* Get the user this status is connected to
*
* @return string
* @since 20.0.0
*/
public function getUserId():string;
/**
* Get the status
*
* It will return one of the constants defined above.
* It will never return invisible. In case a user marked
* themselves as invisible, it will return offline.
*
* @return string See IUserStatus constants
* @since 20.0.0
*/
public function getStatus():string;
/**
* Get a custom message provided by the user
*
* @return string|null
* @since 20.0.0
*/
public function getMessage():?string;
/**
* Get a custom icon provided by the user
*
* @return string|null
* @since 20.0.0
*/
public function getIcon():?string;
/**
* Gets the time that the custom status will be cleared at
*
* @return DateTimeImmutable|null
* @since 20.0.0
*/
public function getClearAt():?DateTimeImmutable;
}
|
