mirror of
https://github.com/nextcloud/server.git
synced 2025-02-24 17:06:50 +00:00
8330825f3e
Sorting the events by the start date leads to more predictable results for the search API consumers. Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
84 lines
2.5 KiB
PHP
84 lines
2.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
|
|
*
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
* @author Georg Ehrke <oc.list@georgehrke.com>
|
|
*
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
namespace OCP\Calendar;
|
|
|
|
/**
|
|
* Interface ICalendar
|
|
*
|
|
* @since 13.0.0
|
|
*/
|
|
interface ICalendar {
|
|
/**
|
|
* @return string defining the technical unique key
|
|
* @since 13.0.0
|
|
*/
|
|
public function getKey(): string;
|
|
|
|
/**
|
|
* In comparison to getKey() this function returns a unique uri within the scope of the principal
|
|
* @since 24.0.0
|
|
*/
|
|
public function getUri(): string;
|
|
|
|
/**
|
|
* In comparison to getKey() this function returns a human readable (maybe translated) name
|
|
* @return null|string
|
|
* @since 13.0.0
|
|
*/
|
|
public function getDisplayName(): ?string;
|
|
|
|
/**
|
|
* Calendar color
|
|
* @return null|string
|
|
* @since 13.0.0
|
|
*/
|
|
public function getDisplayColor(): ?string;
|
|
|
|
/**
|
|
* @param string $pattern which should match within the $searchProperties
|
|
* @param array $searchProperties defines the properties within the query pattern should match
|
|
* @param array $options - optional parameters:
|
|
* ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]]
|
|
* @param int|null $limit - limit number of search results
|
|
* @param int|null $offset - offset for paging of search results
|
|
* @return array an array of events/journals/todos which are arrays of key-value-pairs. the events are sorted by start date (closest first, furthest last)
|
|
* @since 13.0.0
|
|
*/
|
|
public function search(string $pattern, array $searchProperties = [], array $options = [], ?int $limit = null, ?int $offset = null): array;
|
|
|
|
/**
|
|
* @return int build up using \OCP\Constants
|
|
* @since 13.0.0
|
|
*/
|
|
public function getPermissions(): int;
|
|
|
|
/**
|
|
* Whether the calendar is deleted
|
|
* @since 26.0.0
|
|
*/
|
|
public function isDeleted(): bool;
|
|
}
|