aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Calendar/ICalendarProvider.php
blob: 95090b1c377d8e3d3d500af73db9d371d9e7ba77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Calendar;

/**
 * This interface defines a lazy loading mechanism for
 * calendars for Public Consumption
 *
 * @since 23.0.0
 */
interface ICalendarProvider {
	/**
	 * @param string $principalUri URI of the principal
	 * @param string[] $calendarUris optionally specify which calendars to load, or all if this array is empty
	 * @return ICalendar[]
	 * @since 23.0.0
	 */
	public function getCalendars(string $principalUri, array $calendarUris = []): array;
}