ResponseDefinitions.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
  5. *
  6. * @author Kate Döen <kate.doeen@nextcloud.com>
  7. * @author Richard Steinmetz <richard@steinmetz.cloud>
  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 OCA\Dashboard;
  26. /**
  27. * @psalm-type DashboardWidget = array{
  28. * id: string,
  29. * title: string,
  30. * order: int,
  31. * icon_class: string,
  32. * icon_url: string,
  33. * widget_url: ?string,
  34. * item_icons_round: bool,
  35. * item_api_versions: int[],
  36. * reload_interval: int,
  37. * buttons?: array{
  38. * type: string,
  39. * text: string,
  40. * link: string,
  41. * }[],
  42. * }
  43. *
  44. * @psalm-type DashboardWidgetItem = array{
  45. * subtitle: string,
  46. * title: string,
  47. * link: string,
  48. * iconUrl: string,
  49. * overlayIconUrl: string,
  50. * sinceId: string,
  51. * }
  52. *
  53. * @psalm-type DashboardWidgetItems = array{
  54. * items: DashboardWidgetItem[],
  55. * emptyContentMessage: string,
  56. * halfEmptyContentMessage: string,
  57. * }
  58. */
  59. class ResponseDefinitions {
  60. }