aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Contacts/ContactsMenu/IActionFactory.php
blob: 69e6030e95b061e004651049961b4b14311a913c (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
<?php

/**
 * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Contacts\ContactsMenu;

/**
 * @since 12.0
 */
interface IActionFactory {
	/**
	 * Construct and return a new link action for the contacts menu
	 *
	 * @since 12.0
	 *
	 * @param string $icon full path to the action's icon
	 * @param string $name localized name of the action
	 * @param string $href target URL
	 * @param string $appId the app ID registering the action
	 * @return ILinkAction
	 */
	public function newLinkAction(string $icon, string $name, string $href, string $appId = ''): ILinkAction;

	/**
	 * Construct and return a new email action for the contacts menu
	 *
	 * @since 12.0
	 *
	 * @param string $icon full path to the action's icon
	 * @param string $name localized name of the action
	 * @param string $email target e-mail address
	 * @param string $appId the appName registering the action
	 * @return ILinkAction
	 */
	public function newEMailAction(string $icon, string $name, string $email, string $appId = ''): ILinkAction;
}