blob: 48eecfec24a31a707842ac4edf7aef7e14b7580f (
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\UserStatus;
use DateTimeImmutable;
/**
* Interface IUserStatus
*
* @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 28.0.0
*/
public const BUSY = 'busy';
/**
* @var string
* @since 20.0.0
*/
public const OFFLINE = 'offline';
/**
* @var string
* @since 20.0.0
*/
public const INVISIBLE = 'invisible';
/**
* @var string
* @since 25.0.0
*/
public const MESSAGE_CALL = 'call';
/**
* @var string
* @since 25.0.0
*/
public const MESSAGE_AVAILABILITY = 'availability';
/**
* @var string
* @since 28.0.1
*/
public const MESSAGE_OUT_OF_OFFICE = 'out-of-office';
/**
* @var string
* @since 28.0.0
*/
public const MESSAGE_VACATION = 'vacationing';
/**
* @var string
* @since 28.0.0
*/
public const MESSAGE_CALENDAR_BUSY = 'meeting';
/**
* @var string
* @since 28.0.0
*/
public const MESSAGE_CALENDAR_BUSY_TENTATIVE = 'busy-tentative';
/**
* 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;
}
|
