aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Contacts/ContactsMenu/IAction.php
blob: 4a7133a999b87a5bf9370dbf5974005c230da050 (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
<?php
/**
 * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Contacts\ContactsMenu;

use JsonSerializable;

/**
 * Apps should use the IActionFactory to create new action objects
 *
 * @since 12.0
 */
interface IAction extends JsonSerializable {
	/**
	 * @param string $icon absolute URI to an icon
	 * @since 12.0
	 */
	public function setIcon(string $icon);

	/**
	 * @return string localized action name, e.g. 'Call'
	 * @since 12.0
	 */
	public function getName(): string;

	/**
	 * @param string $name localized action name, e.g. 'Call'
	 * @since 12.0
	 */
	public function setName(string $name);

	/**
	 * @param int $priority priorize actions, high order ones are shown on top
	 * @since 12.0
	 */
	public function setPriority(int $priority);

	/**
	 * @return int priority to priorize actions, high order ones are shown on top
	 * @since 12.0
	 */
	public function getPriority(): int;

	/**
	 * @param string $appId
	 * @since 23.0.0
	 */
	public function setAppId(string $appId);

	/**
	 * @return string
	 * @since 23.0.0
	 */
	public function getAppId(): string;
}