server/lib/public/app/iappmanager.php
Morris Jobke 7644950b48 Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the
  method introduction right inside the code without searching
  via git blame
* easier to write apps for multiple versions
2015-04-16 17:00:08 +02:00

100 lines
2.2 KiB
PHP

<?php
/**
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCP\App;
use OCP\IUser;
/**
* Interface IAppManager
*
* @package OCP\App
* @since 8.0.0
*/
interface IAppManager {
/**
* Check if an app is enabled for user
*
* @param string $appId
* @param \OCP\IUser $user (optional) if not defined, the currently loggedin user will be used
* @return bool
* @since 8.0.0
*/
public function isEnabledForUser($appId, $user = null);
/**
* Check if an app is installed in the instance
*
* @param string $appId
* @return bool
* @since 8.0.0
*/
public function isInstalled($appId);
/**
* Enable an app for every user
*
* @param string $appId
* @since 8.0.0
*/
public function enableApp($appId);
/**
* Enable an app only for specific groups
*
* @param string $appId
* @param \OCP\IGroup[] $groups
* @since 8.0.0
*/
public function enableAppForGroups($appId, $groups);
/**
* Disable an app for every user
*
* @param string $appId
* @since 8.0.0
*/
public function disableApp($appId);
/**
* List all apps enabled for a user
*
* @param \OCP\IUser $user
* @return string[]
* @since 8.1.0
*/
public function getEnabledAppsForUser(IUser $user);
/**
* List all installed apps
*
* @return string[]
* @since 8.0.0
*/
public function getInstalledApps();
/**
* Clear the cached list of apps when enabling/disabling an app
* @since 8.1.0
*/
public function clearAppsCache();
}