IAction.php 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <?php
  2. /**
  3. * @copyright 2017 Christoph Wurst <christoph@winzerhof-wurst.at>
  4. *
  5. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\Contacts\ContactsMenu;
  24. use JsonSerializable;
  25. /**
  26. * Apps should use the IActionFactory to create new action objects
  27. *
  28. * @since 12.0
  29. */
  30. interface IAction extends JsonSerializable {
  31. /**
  32. * @param string $icon absolute URI to an icon
  33. * @since 12.0
  34. */
  35. public function setIcon(string $icon);
  36. /**
  37. * @return string localized action name, e.g. 'Call'
  38. * @since 12.0
  39. */
  40. public function getName(): string;
  41. /**
  42. * @param string $name localized action name, e.g. 'Call'
  43. * @since 12.0
  44. */
  45. public function setName(string $name);
  46. /**
  47. * @param int $priority priorize actions, high order ones are shown on top
  48. * @since 12.0
  49. */
  50. public function setPriority(int $priority);
  51. /**
  52. * @return int priority to priorize actions, high order ones are shown on top
  53. * @since 12.0
  54. */
  55. public function getPriority(): int;
  56. /**
  57. * @param string $appId
  58. * @since 23.0.0
  59. */
  60. public function setAppId(string $appId);
  61. /**
  62. * @return string
  63. * @since 23.0.0
  64. */
  65. public function getAppId(): string;
  66. }