nextcloud/lib/public/Contacts/ContactsMenu/IAction.php

66 lines
1.7 KiB
PHP

<?php
/**
* @copyright 2017 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author 2017 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @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;
/**
* 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($icon);
/**
* @return string localized action name, e.g. 'Call'
* @since 12.0
*/
public function getName();
/**
* @param string $name localized action name, e.g. 'Call'
* @since 12.0
*/
public function setName($name);
/**
* @param int $priority priorize actions, high order ones are shown on top
* @since 12.0
*/
public function setPriority($priority);
/**
* @return int priority to priorize actions, high order ones are shown on top
* @since 12.0
*/
public function getPriority();
}