blob: 8532a8700a1b0b0cfbd4efa56ba3382ef627c5bc (
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
<?php
declare(strict_types=1);
/**
* @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @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\Dashboard;
use OCP\Dashboard\Model\IWidgetConfig;
use OCP\Dashboard\Model\IWidgetRequest;
use OCP\Dashboard\Model\WidgetSetup;
use OCP\Dashboard\Model\WidgetTemplate;
/**
* Interface IDashboardWidget
*
* This interface is used to create a widget: the widget must implement this
* interface and be defined in appinfo/info.xml:
*
* <dashboard>
* <widget>OCA\YourApp\YourWidget</widget>
* </dashboard>
*
* Multiple widget can be defined in the same appinfo/info.xml.
*
* @since 15.0.0
*
* @package OCP\Dashboard
*/
interface IDashboardWidget {
/**
* Should returns the (unique) Id of the widget.
*
* @since 15.0.0
*
* @return string
*/
public function getId(): string;
/**
* Should returns the [display] name of the widget.
*
* @since 15.0.0
*
* @return string
*/
public function getName(): string;
/**
* Should returns some text describing the widget.
* This description is displayed in the listing of the available widgets.
*
* @since 15.0.0
*
* @return string
*/
public function getDescription(): string;
/**
* Must generate and return a WidgetTemplate that define important stuff
* about the Widget: icon, content, css or javascript.
*
* @see WidgetTemplate
*
* @since 15.0.0
*
* @return WidgetTemplate
*/
public function getWidgetTemplate(): WidgetTemplate;
/**
* Must create and return a WidgetSetup containing the general setup of
* the widget
*
* @see WidgetSetup
*
* @since 15.0.0
*
* @return WidgetSetup
*/
public function getWidgetSetup(): WidgetSetup;
/**
* This method is called when a widget is loaded on the dashboard.
* A widget is 'loaded on the dashboard' when one of these conditions
* occurs:
*
* - the user is adding the widget on his dashboard,
* - the user already added the widget on his dashboard and he is opening
* the dashboard app.
*
* @see IWidgetConfig
*
* @since 15.0.0
*
* @param IWidgetConfig $settings
*/
public function loadWidget(IWidgetConfig $settings);
/**
* This method s executed when the widget call the net.requestWidget()
* from the Javascript API.
*
* This is used by the frontend to communicate with the backend.
*
* @see IWidgetRequest
*
* @since 15.0.0
*
* @param IWidgetRequest $request
*/
public function requestWidget(IWidgetRequest $request);
}
|
