ICalendarProvider.php 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. <?php
  2. /**
  3. * @copyright 2020, Georg Ehrke <oc.list@georgehrke.com>
  4. *
  5. * @author Georg Ehrke <oc.list@georgehrke.com>
  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 OCA\DAV\CalDAV\Integration;
  24. /**
  25. * Interface ICalendarProvider
  26. *
  27. * @package OCA\DAV\CalDAV\Integration
  28. * @since 19.0.0
  29. */
  30. interface ICalendarProvider {
  31. /**
  32. * Provides the appId of the plugin
  33. *
  34. * @since 19.0.0
  35. * @return string AppId
  36. */
  37. public function getAppId(): string;
  38. /**
  39. * Fetches all calendars for a given principal uri
  40. *
  41. * @since 19.0.0
  42. * @param string $principalUri E.g. principals/users/user1
  43. * @return ExternalCalendar[] Array of all calendars
  44. */
  45. public function fetchAllForCalendarHome(string $principalUri): array;
  46. /**
  47. * Checks whether plugin has a calendar for a given principalUri and calendarUri
  48. *
  49. * @since 19.0.0
  50. * @param string $principalUri E.g. principals/users/user1
  51. * @param string $calendarUri E.g. personal
  52. * @return bool True if calendar for principalUri and calendarUri exists, false otherwise
  53. */
  54. public function hasCalendarInCalendarHome(string $principalUri, string $calendarUri): bool;
  55. /**
  56. * Fetches a calendar for a given principalUri and calendarUri
  57. * Returns null if calendar does not exist
  58. *
  59. * @since 19.0.0
  60. * @param string $principalUri E.g. principals/users/user1
  61. * @param string $calendarUri E.g. personal
  62. * @return ExternalCalendar|null Calendar if it exists, null otherwise
  63. */
  64. public function getCalendarInCalendarHome(string $principalUri, string $calendarUri): ?ExternalCalendar;
  65. }