blob: 1307e2c74f7bf674e555726136be6ac74f01a78c (
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
|
<?php
/**
* @copyright 2017 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @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\Contacts\ContactsMenu;
use JsonSerializable;
/**
* @since 12.0
*/
interface IEntry extends JsonSerializable {
/**
* @since 12.0
* @return string
*/
public function getFullName(): string;
/**
* @since 12.0
* @return string[]
*/
public function getEMailAddresses(): array;
/**
* @since 12.0
* @return string|null image URI
*/
public function getAvatar(): ?string;
/**
* @since 12.0
* @param IAction $action an action to show in the contacts menu
*/
public function addAction(IAction $action): void;
/**
* Set the (system) contact's user status
*
* @since 28.0
* @param string $status
* @param string $statusMessage
* @param string|null $icon
* @return void
*/
public function setStatus(string $status,
string $statusMessage = null,
int $statusMessageTimestamp = null,
string $icon = null): void;
/**
* Get an arbitrary property from the contact
*
* @since 12.0
* @param string $key
* @return mixed the value of the property or null
*/
public function getProperty(string $key);
}
|