70 lines
1.6 KiB
PHP
70 lines
1.6 KiB
PHP
<?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;
|
|
|
|
/**
|
|
* Interface IRoom
|
|
*
|
|
* @package OCP\Calendar\Room
|
|
* @since 14.0.0
|
|
*/
|
|
interface IRoom {
|
|
|
|
/**
|
|
* get the room id
|
|
*
|
|
* This id has to be unique within the backend
|
|
*
|
|
* @return string
|
|
* @since 14.0.0
|
|
*/
|
|
public function getId();
|
|
|
|
/**
|
|
* get the display name for a room
|
|
*
|
|
* @return string
|
|
* @since 14.0.0
|
|
*/
|
|
public function getDisplayName();
|
|
|
|
/**
|
|
* Get a list of groupIds that are allowed to access this room
|
|
*
|
|
* If an empty array is returned, no group restrictions are
|
|
* applied.
|
|
*
|
|
* @return string[]
|
|
* @since 14.0.0
|
|
*/
|
|
public function getGroupRestrictions();
|
|
|
|
/**
|
|
* Get the name of the backend class the room is connected with
|
|
*
|
|
* @return string
|
|
* @since 14.0.0
|
|
*/
|
|
public function getBackendClassName();
|
|
}
|