IDiscoverableReferenceProvider.php 949 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
  5. * SPDX-License-Identifier: AGPL-3.0-or-later
  6. */
  7. namespace OCP\Collaboration\Reference;
  8. /**
  9. * @since 26.0.0
  10. */
  11. interface IDiscoverableReferenceProvider extends IReferenceProvider {
  12. /**
  13. * @return string Unique id that identifies the reference provider
  14. * @since 26.0.0
  15. */
  16. public function getId(): string;
  17. /**
  18. * @return string User facing title of the widget
  19. * @since 26.0.0
  20. */
  21. public function getTitle(): string;
  22. /**
  23. * @return int Initial order for reference provider sorting
  24. * @since 26.0.0
  25. */
  26. public function getOrder(): int;
  27. /**
  28. * @return string url to an icon that can be displayed next to the reference provider title
  29. * @since 26.0.0
  30. */
  31. public function getIconUrl(): string;
  32. /**
  33. * @return array representation of the provider
  34. * @since 26.0.0
  35. */
  36. public function jsonSerialize(): array;
  37. }