You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
1.7 KiB
70 lines
1.7 KiB
<?php |
|
/** |
|
* @copyright 2018, Georg Ehrke <oc.list@georgehrke.com> |
|
* |
|
* @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\Room; |
|
use OCP\Calendar\BackendTemporarilyUnavailableException; |
|
|
|
/** |
|
* Interface IBackend |
|
* |
|
* @package OCP\Calendar\Room |
|
* @since 14.0.0 |
|
*/ |
|
interface IBackend { |
|
|
|
/** |
|
* get a list of all rooms in this backend |
|
* |
|
* @throws BackendTemporarilyUnavailableException |
|
* @return IRoom[] |
|
* @since 14.0.0 |
|
*/ |
|
public function getAllRooms():array; |
|
|
|
/** |
|
* get a list of all room identifiers in this backend |
|
* |
|
* @throws BackendTemporarilyUnavailableException |
|
* @return string[] |
|
* @since 14.0.0 |
|
*/ |
|
public function listAllRooms():array; |
|
|
|
/** |
|
* get a room by it's id |
|
* |
|
* @param string $id |
|
* @throws BackendTemporarilyUnavailableException |
|
* @return IRoom|null |
|
* @since 14.0.0 |
|
*/ |
|
public function getRoom($id); |
|
|
|
/** |
|
* Get unique identifier of the backend |
|
* |
|
* @return string |
|
* @since 14.0.0 |
|
*/ |
|
public function getBackendIdentifier():string; |
|
}
|
|
|