1<?php
2/**
3 * @copyright 2017 Christoph Wurst <christoph@winzerhof-wurst.at>
4 *
5 * @author Christoph Wurst <christoph@winzerhof-wurst.at>
6 * @author Roeland Jago Douma <roeland@famdouma.nl>
7 *
8 * @license GNU AGPL version 3 or any later version
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Affero General Public License as
12 * published by the Free Software Foundation, either version 3 of the
13 * License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Affero General Public License for more details.
19 *
20 * You should have received a copy of the GNU Affero General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 *
23 */
24namespace OCP\Contacts\ContactsMenu;
25
26use JsonSerializable;
27
28/**
29 * @since 12.0
30 */
31interface IEntry extends JsonSerializable {
32
33	/**
34	 * @since 12.0
35	 * @return string
36	 */
37	public function getFullName(): string;
38
39	/**
40	 * @since 12.0
41	 * @return string[]
42	 */
43	public function getEMailAddresses(): array;
44
45	/**
46	 * @since 12.0
47	 * @return string|null image URI
48	 */
49	public function getAvatar(): ?string;
50
51	/**
52	 * @since 12.0
53	 * @param IAction $action an action to show in the contacts menu
54	 */
55	public function addAction(IAction $action): void;
56
57	/**
58	 * Get an arbitrary property from the contact
59	 *
60	 * @since 12.0
61	 * @param string $key
62	 * @return mixed the value of the property or null
63	 */
64	public function getProperty(string $key);
65}
66