You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

57 lines
1.6 KiB

3 years ago
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
  5. *
  6. * @author Julius Härtl <jus@bitgrid.net>
  7. * @author Maxence Lange <maxence@artificial-owl.com>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\Dashboard\Service;
  26. use OCP\Dashboard\Model\IWidgetConfig;
  27. /**
  28. * Interface IWidgetsService
  29. *
  30. * The Service is provided by the Dashboard app. The method in this interface
  31. * are used by the IDashboardManager when a widget needs to access the current
  32. * configuration of a widget for a user.
  33. *
  34. * @since 15.0.0
  35. * @deprecated 20.0.0
  36. *
  37. */
  38. interface IWidgetsService {
  39. /**
  40. * Returns the IWidgetConfig for a widgetId and userId
  41. *
  42. * @since 15.0.0
  43. * @deprecated 20.0.0
  44. *
  45. * @param string $widgetId
  46. * @param string $userId
  47. *
  48. * @return IWidgetConfig
  49. */
  50. public function getWidgetConfig(string $widgetId, string $userId): IWidgetConfig;
  51. }