blob: 0ae4cad50a9a6bf8d7a527f942777141ab635dfb (
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
|
<?php
declare(strict_types=1);
/**
* Nextcloud - Dashboard App
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2018, Maxence Lange <maxence@artificial-owl.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\Dashboard\Model;
use OCP\Dashboard\IDashboardWidget;
/**
* Interface IWidgetConfig
*
* This object contains the configuration of a widget for a userId
*
* @see IDashboardWidget::loadWidget
*
* @since 15.0.0
*
* @package OCP\Dashboard\Model
*/
interface IWidgetConfig {
/**
* Returns the userId
*
* @since 15.0.0
*
* @return string
*/
public function getUserId(): string;
/**
* Returns the widgetId
*
* @since 15.0.0
*
* @return string
*/
public function getWidgetId(): string;
/**
* Returns the current position and the current size of the widget as
* displayed on the user's dashboard
*
* The returned value is an array:
* [
* 'x' => (int) position on the X axis,
* 'y' => (int) position on the Y axis,
* 'width' => (int) width of the widget,
* 'height' => (int) height of the widget
* ]
*
* @since 15.0.0
*
* @return array
*/
public function getPosition(): array;
/**
* Returns an array with the settings defined by the user for the widget.
* The returned value is an array, with setting used as keys:
*
* [
* 'setting1' => 'any value',
* 'setting2' => 'other value'
* ]
*
* Each setting that can be edited by a user should be defined in a
* WidgetSetting.
*
* @see WidgetSetting
*
* Those WidgetSetting are in the WidgetTemplate defined during the setup
* of the widget in the IDashboardWidget.
*
* @see IDashboardWidget::getWidgetTemplate
* @see WidgetTemplate
*
* When using this framework, the settings interface is generated by the
* Dashboard app.
*
* @since 15.0.0
*
* @return array
*/
public function getSettings(): array;
/**
* Returns if the widget is enabled/displayed in this user's dashboard.
*
* @since 15.0.0
*
* @return bool
*/
public function isEnabled(): bool;
}
|
