IProviderService.php 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
  5. *
  6. * @author Maxence Lange <maxence@artificial-owl.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\FullTextSearch\Service;
  25. /**
  26. * Interface IProviderService
  27. *
  28. * @since 15.0.0
  29. *
  30. */
  31. interface IProviderService {
  32. /**
  33. * Check if the provider $providerId is already indexed.
  34. *
  35. * @since 15.0.0
  36. *
  37. * @param string $providerId
  38. *
  39. * @return bool
  40. */
  41. public function isProviderIndexed(string $providerId);
  42. /**
  43. * Add the Javascript API in the navigation page of an app.
  44. *
  45. * @since 15.0.0
  46. */
  47. public function addJavascriptAPI();
  48. }