IActionFactory.php 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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. /**
  25. * @since 12.0
  26. */
  27. interface IActionFactory {
  28. /**
  29. * Construct and return a new link action for the contacts menu
  30. *
  31. * @since 12.0
  32. *
  33. * @param string $icon full path to the action's icon
  34. * @param string $name localized name of the action
  35. * @param string $href target URL
  36. * @param string $appId the app ID registering the action
  37. * @return ILinkAction
  38. */
  39. public function newLinkAction(string $icon, string $name, string $href, string $appId = ''): ILinkAction;
  40. /**
  41. * Construct and return a new email action for the contacts menu
  42. *
  43. * @since 12.0
  44. *
  45. * @param string $icon full path to the action's icon
  46. * @param string $name localized name of the action
  47. * @param string $email target e-mail address
  48. * @param string $appId the appName registering the action
  49. * @return ILinkAction
  50. */
  51. public function newEMailAction(string $icon, string $name, string $email, string $appId = ''): ILinkAction;
  52. }