2014-11-07 13:26:12 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-06-25 09:43:55 +00:00
|
|
|
* @author Lukas Reschke <lukas@owncloud.com>
|
2015-03-26 10:44:34 +00:00
|
|
|
* @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/>
|
|
|
|
*
|
2014-11-07 13:26:12 +00:00
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2014-11-07 13:26:12 +00:00
|
|
|
namespace OCP\App;
|
|
|
|
|
2015-02-02 13:47:29 +00:00
|
|
|
use OCP\IUser;
|
|
|
|
|
2015-04-16 15:00:08 +00:00
|
|
|
/**
|
|
|
|
* Interface IAppManager
|
|
|
|
*
|
|
|
|
* @package OCP\App
|
|
|
|
* @since 8.0.0
|
|
|
|
*/
|
2014-11-07 13:26:12 +00:00
|
|
|
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
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 8.0.0
|
2014-11-07 13:26:12 +00:00
|
|
|
*/
|
|
|
|
public function isEnabledForUser($appId, $user = null);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check if an app is installed in the instance
|
|
|
|
*
|
|
|
|
* @param string $appId
|
|
|
|
* @return bool
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 8.0.0
|
2014-11-07 13:26:12 +00:00
|
|
|
*/
|
|
|
|
public function isInstalled($appId);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Enable an app for every user
|
|
|
|
*
|
|
|
|
* @param string $appId
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 8.0.0
|
2014-11-07 13:26:12 +00:00
|
|
|
*/
|
|
|
|
public function enableApp($appId);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Enable an app only for specific groups
|
|
|
|
*
|
|
|
|
* @param string $appId
|
|
|
|
* @param \OCP\IGroup[] $groups
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 8.0.0
|
2014-11-07 13:26:12 +00:00
|
|
|
*/
|
|
|
|
public function enableAppForGroups($appId, $groups);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Disable an app for every user
|
|
|
|
*
|
|
|
|
* @param string $appId
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 8.0.0
|
2014-11-07 13:26:12 +00:00
|
|
|
*/
|
|
|
|
public function disableApp($appId);
|
2015-02-02 13:47:29 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* List all apps enabled for a user
|
|
|
|
*
|
|
|
|
* @param \OCP\IUser $user
|
|
|
|
* @return string[]
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 8.1.0
|
2015-02-02 13:47:29 +00:00
|
|
|
*/
|
2015-02-05 14:11:07 +00:00
|
|
|
public function getEnabledAppsForUser(IUser $user);
|
2015-02-02 13:47:29 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* List all installed apps
|
|
|
|
*
|
|
|
|
* @return string[]
|
2015-06-04 13:19:04 +00:00
|
|
|
* @since 8.1.0
|
2015-02-02 13:47:29 +00:00
|
|
|
*/
|
|
|
|
public function getInstalledApps();
|
2015-03-30 13:58:20 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Clear the cached list of apps when enabling/disabling an app
|
2015-04-16 15:00:08 +00:00
|
|
|
* @since 8.1.0
|
2015-03-30 13:58:20 +00:00
|
|
|
*/
|
|
|
|
public function clearAppsCache();
|
2014-11-07 13:26:12 +00:00
|
|
|
}
|