blob: 96199d90b929f4abc59d0cc438577df0966ab4bc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<?php
/**
* ownCloud - App Framework
*
* @author Bernhard Posselt
* @copyright 2012 Bernhard Posselt <dev@bernhard-posselt.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Public interface of ownCloud for apps to use.
* AppFramework/IApi interface
*/
namespace OCP\AppFramework;
/**
* A few very basic and frequently used API functions are combined in here
* @deprecated
*/
interface IApi {
/**
* Gets the userid of the current user
* @return string the user id of the current user
* @deprecated Use \OC::$server->getUserSession()->getUser()->getUID()
*/
function getUserId();
/**
* Adds a new javascript file
* @deprecated include javascript and css in template files
* @param string $scriptName the name of the javascript in js/ without the suffix
* @param string $appName the name of the app, defaults to the current one
* @return void
*/
function addScript($scriptName, $appName = null);
/**
* Adds a new css file
* @deprecated include javascript and css in template files
* @param string $styleName the name of the css file in css/without the suffix
* @param string $appName the name of the app, defaults to the current one
* @return void
*/
function addStyle($styleName, $appName = null);
/**
* @deprecated include javascript and css in template files
* shorthand for addScript for files in the 3rdparty directory
* @param string $name the name of the file without the suffix
* @return void
*/
function add3rdPartyScript($name);
/**
* @deprecated include javascript and css in template files
* shorthand for addStyle for files in the 3rdparty directory
* @param string $name the name of the file without the suffix
* @return void
*/
function add3rdPartyStyle($name);
/**
* Checks if an app is enabled
* @deprecated communication between apps should happen over built in
* callbacks or interfaces (check the contacts and calendar managers)
* Checks if an app is enabled
* also use \OC::$server->getAppManager()->isEnabledForUser($appName)
* @param string $appName the name of an app
* @return bool true if app is enabled
*/
public function isAppEnabled($appName);
}
|
