mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Deprecate old dashboard API 

Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl 2020-05-27 09:10:40 +02:00
parent 673d70dfc5
commit 544fcdb549
No known key found for this signature in database
GPG Key ID: 4C614C6ED2CDE6DF
9 changed files with 79 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/public/Dashboard/IDashboardManager.php
View File

@ -38,6 +38,7 @@ use OCP\Dashboard\Service\IWidgetsService;
* The call can be done from any Service. * The call can be done from any Service.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard * @package OCP\Dashboard
*/ */
@ -48,6 +49,7 @@ interface IDashboardManager {
* Register a IWidgetsService. * Register a IWidgetsService.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param IWidgetsService $widgetsService * @param IWidgetsService $widgetsService
*/ */
@ -58,6 +60,7 @@ interface IDashboardManager {
* Register a IEventsService. * Register a IEventsService.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param IEventsService $eventsService * @param IEventsService $eventsService
*/ */
@ -70,6 +73,7 @@ interface IDashboardManager {
* @see IWidgetConfig * @see IWidgetConfig
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $widgetId * @param string $widgetId
* @param string $userId * @param string $userId
@ -92,6 +96,7 @@ interface IDashboardManager {
* that are running dashboard. * that are running dashboard.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $widgetId * @param string $widgetId
* @param array $users * @param array $users
@ -106,6 +111,7 @@ interface IDashboardManager {
* Create push notifications for groups. (ie. createUsersEvent()) * Create push notifications for groups. (ie. createUsersEvent())
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $widgetId * @param string $widgetId
* @param array $groups * @param array $groups
@ -120,6 +126,7 @@ interface IDashboardManager {
* Create push notifications for everyone. (ie. createUsersEvent()) * Create push notifications for everyone. (ie. createUsersEvent())
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $widgetId * @param string $widgetId
* @param array $payload * @param array $payload

8
lib/public/Dashboard/IDashboardWidget.php
View File

@ -45,6 +45,7 @@ use OCP\Dashboard\Model\WidgetTemplate;
* Multiple widget can be defined in the same appinfo/info.xml. * Multiple widget can be defined in the same appinfo/info.xml.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard * @package OCP\Dashboard
*/ */
@ -54,6 +55,7 @@ interface IDashboardWidget {
* Should returns the (unique) Id of the widget. * Should returns the (unique) Id of the widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -64,6 +66,7 @@ interface IDashboardWidget {
* Should returns the [display] name of the widget. * Should returns the [display] name of the widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -75,6 +78,7 @@ interface IDashboardWidget {
* This description is displayed in the listing of the available widgets. * This description is displayed in the listing of the available widgets.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -88,6 +92,7 @@ interface IDashboardWidget {
* @see WidgetTemplate * @see WidgetTemplate
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return WidgetTemplate * @return WidgetTemplate
*/ */
@ -101,6 +106,7 @@ interface IDashboardWidget {
* @see WidgetSetup * @see WidgetSetup
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return WidgetSetup * @return WidgetSetup
*/ */
@ -119,6 +125,7 @@ interface IDashboardWidget {
* @see IWidgetConfig * @see IWidgetConfig
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param IWidgetConfig $settings * @param IWidgetConfig $settings
*/ */
@ -134,6 +141,7 @@ interface IDashboardWidget {
* @see IWidgetRequest * @see IWidgetRequest
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param IWidgetRequest $request * @param IWidgetRequest $request
*/ */

6
lib/public/Dashboard/Model/IWidgetConfig.php
View File

@ -36,6 +36,7 @@ use OCP\Dashboard\IDashboardWidget;
* @see IDashboardWidget::loadWidget * @see IDashboardWidget::loadWidget
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard\Model * @package OCP\Dashboard\Model
*/ */
@ -46,6 +47,7 @@ interface IWidgetConfig {
* Returns the userId * Returns the userId
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -56,6 +58,7 @@ interface IWidgetConfig {
* Returns the widgetId * Returns the widgetId
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -75,6 +78,7 @@ interface IWidgetConfig {
* ] * ]
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -105,6 +109,7 @@ interface IWidgetConfig {
* Dashboard app. * Dashboard app.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -115,6 +120,7 @@ interface IWidgetConfig {
* Returns if the widget is enabled/displayed in this user's dashboard. * Returns if the widget is enabled/displayed in this user's dashboard.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return bool * @return bool
*/ */

8
lib/public/Dashboard/Model/IWidgetRequest.php
View File

@ -38,6 +38,7 @@ use OCP\Dashboard\IDashboardWidget;
* @see IDashboardWidget::requestWidget * @see IDashboardWidget::requestWidget
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard\Model * @package OCP\Dashboard\Model
*/ */
@ -47,6 +48,7 @@ interface IWidgetRequest {
* Get the widgetId. * Get the widgetId.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -57,6 +59,7 @@ interface IWidgetRequest {
* Get the WidgetClass. * Get the WidgetClass.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return IDashboardWidget * @return IDashboardWidget
*/ */
@ -76,6 +79,7 @@ interface IWidgetRequest {
* callback); * callback);
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -88,6 +92,7 @@ interface IWidgetRequest {
* @see getRequest * @see getRequest
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -98,6 +103,7 @@ interface IWidgetRequest {
* Returns the result. * Returns the result.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -108,6 +114,7 @@ interface IWidgetRequest {
* add a result (as string) * add a result (as string)
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $key * @param string $key
* @param string $result * @param string $result
@ -120,6 +127,7 @@ interface IWidgetRequest {
* add a result (as array) * add a result (as array)
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $key * @param string $key
* @param array $result * @param array $result

13
lib/public/Dashboard/Model/WidgetSetting.php
View File

@ -45,6 +45,7 @@ use JsonSerializable;
* @see WidgetTemplate::addSetting * @see WidgetTemplate::addSetting
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard\Model * @package OCP\Dashboard\Model
*/ */
@ -73,6 +74,7 @@ final class WidgetSetting implements JsonSerializable {
* WidgetSetting constructor. * WidgetSetting constructor.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $type * @param string $type
*/ */
@ -85,6 +87,7 @@ final class WidgetSetting implements JsonSerializable {
* Set the name of the setting (full string, no space) * Set the name of the setting (full string, no space)
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $name * @param string $name
* *
@ -100,6 +103,7 @@ final class WidgetSetting implements JsonSerializable {
* Get the name of the setting * Get the name of the setting
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -112,6 +116,7 @@ final class WidgetSetting implements JsonSerializable {
* Set the title/display name of the setting. * Set the title/display name of the setting.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $title * @param string $title
* *
@ -127,6 +132,7 @@ final class WidgetSetting implements JsonSerializable {
* Get the title of the setting * Get the title of the setting
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -139,6 +145,7 @@ final class WidgetSetting implements JsonSerializable {
* Set the type of the setting (input, checkbox, ...) * Set the type of the setting (input, checkbox, ...)
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $type * @param string $type
* *
@ -154,6 +161,7 @@ final class WidgetSetting implements JsonSerializable {
* Get the type of the setting. * Get the type of the setting.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -166,6 +174,7 @@ final class WidgetSetting implements JsonSerializable {
* Set the placeholder (in case of type=input) * Set the placeholder (in case of type=input)
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $text * @param string $text
* *
@ -181,6 +190,7 @@ final class WidgetSetting implements JsonSerializable {
* Get the placeholder. * Get the placeholder.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -193,6 +203,7 @@ final class WidgetSetting implements JsonSerializable {
* Set the default value of the setting. * Set the default value of the setting.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $value * @param string $value
* *
@ -208,6 +219,7 @@ final class WidgetSetting implements JsonSerializable {
* Get the default value. * Get the default value.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -218,6 +230,7 @@ final class WidgetSetting implements JsonSerializable {
/** /**
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */

13
lib/public/Dashboard/Model/WidgetSetup.php
View File

@ -38,6 +38,7 @@ use JsonSerializable;
* @see IDashboardWidget::getWidgetSetup * @see IDashboardWidget::getWidgetSetup
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard\Model * @package OCP\Dashboard\Model
*/ */
@ -73,6 +74,7 @@ final class WidgetSetup implements JsonSerializable {
* *
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $type * @param string $type
* *
@ -90,6 +92,7 @@ final class WidgetSetup implements JsonSerializable {
* Returns all sizes defined for the widget. * Returns all sizes defined for the widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -101,6 +104,7 @@ final class WidgetSetup implements JsonSerializable {
* Add a new size to the setup. * Add a new size to the setup.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $type * @param string $type
* @param int $width * @param int $width
@ -121,6 +125,7 @@ final class WidgetSetup implements JsonSerializable {
* Returns menu entries. * Returns menu entries.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -136,6 +141,7 @@ final class WidgetSetup implements JsonSerializable {
* $text is the display name of the menu entry. * $text is the display name of the menu entry.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $function * @param string $function
* @param string $icon * @param string $icon
@ -161,6 +167,7 @@ final class WidgetSetup implements JsonSerializable {
* $delay is the time in seconds between each call. * $delay is the time in seconds between each call.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $function * @param string $function
* @param int $delay * @param int $delay
@ -180,6 +187,7 @@ final class WidgetSetup implements JsonSerializable {
* Get delayed jobs. * Get delayed jobs.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -192,6 +200,7 @@ final class WidgetSetup implements JsonSerializable {
* Get the push function, called when an event is send to the front-end * Get the push function, called when an event is send to the front-end
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -204,6 +213,7 @@ final class WidgetSetup implements JsonSerializable {
* frontend. * frontend.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $function * @param string $function
* *
@ -220,6 +230,7 @@ final class WidgetSetup implements JsonSerializable {
* Returns the default settings for a widget. * Returns the default settings for a widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -235,6 +246,7 @@ final class WidgetSetup implements JsonSerializable {
* @see WidgetSetting * @see WidgetSetting
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param array $settings * @param array $settings
* *
@ -249,6 +261,7 @@ final class WidgetSetup implements JsonSerializable {
/** /**
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */

18
lib/public/Dashboard/Model/WidgetTemplate.php
View File

@ -37,6 +37,7 @@ use JsonSerializable;
* @see IDashboardWidget::getWidgetTemplate * @see IDashboardWidget::getWidgetTemplate
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard\Model * @package OCP\Dashboard\Model
*/ */
@ -66,6 +67,7 @@ final class WidgetTemplate implements JsonSerializable {
* Get the icon class of the widget. * Get the icon class of the widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -80,6 +82,7 @@ final class WidgetTemplate implements JsonSerializable {
* @see addCss * @see addCss
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $icon * @param string $icon
* *
@ -95,6 +98,7 @@ final class WidgetTemplate implements JsonSerializable {
* Get CSS files to be included when displaying a widget * Get CSS files to be included when displaying a widget
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -106,6 +110,7 @@ final class WidgetTemplate implements JsonSerializable {
* path and name of CSS files * path and name of CSS files
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param array $css * @param array $css
* *
@ -121,6 +126,7 @@ final class WidgetTemplate implements JsonSerializable {
* Add a CSS file to be included when displaying a widget. * Add a CSS file to be included when displaying a widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $css * @param string $css
* *
@ -136,6 +142,7 @@ final class WidgetTemplate implements JsonSerializable {
* Get JS files to be included when loading a widget * Get JS files to be included when loading a widget
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */
@ -147,6 +154,7 @@ final class WidgetTemplate implements JsonSerializable {
* Set an array of JS files to be included when loading a widget. * Set an array of JS files to be included when loading a widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param array $js * @param array $js
* *
@ -162,6 +170,7 @@ final class WidgetTemplate implements JsonSerializable {
* Add a JS file to be included when loading a widget. * Add a JS file to be included when loading a widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $js * @param string $js
* *
@ -177,6 +186,7 @@ final class WidgetTemplate implements JsonSerializable {
* Get the HTML file that contains the content of the widget. * Get the HTML file that contains the content of the widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -188,6 +198,7 @@ final class WidgetTemplate implements JsonSerializable {
* Set the HTML file that contains the content of the widget. * Set the HTML file that contains the content of the widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $content * @param string $content
* *
@ -203,6 +214,7 @@ final class WidgetTemplate implements JsonSerializable {
* Get the JS function to be called when loading the widget. * Get the JS function to be called when loading the widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return string * @return string
*/ */
@ -215,6 +227,7 @@ final class WidgetTemplate implements JsonSerializable {
* dashboard * dashboard
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $function * @param string $function
* *
@ -232,6 +245,7 @@ final class WidgetTemplate implements JsonSerializable {
* @see WidgetSetting * @see WidgetSetting
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return WidgetSetting[] * @return WidgetSetting[]
*/ */
@ -243,6 +257,7 @@ final class WidgetTemplate implements JsonSerializable {
* Define all WidgetSetting for the widget. * Define all WidgetSetting for the widget.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @see WidgetSetting * @see WidgetSetting
* *
@ -262,6 +277,7 @@ final class WidgetTemplate implements JsonSerializable {
* @see WidgetSetting * @see WidgetSetting
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param WidgetSetting $setting * @param WidgetSetting $setting
* *
@ -279,6 +295,7 @@ final class WidgetTemplate implements JsonSerializable {
* @see WidgetSetting::setName * @see WidgetSetting::setName
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $key * @param string $key
* *
@ -295,6 +312,7 @@ final class WidgetTemplate implements JsonSerializable {
/** /**
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @return array * @return array
*/ */

4
lib/public/Dashboard/Service/IEventsService.php
View File

@ -35,6 +35,7 @@ use OCP\Dashboard\IDashboardManager;
* are used by the IDashboardManager when creating push event. * are used by the IDashboardManager when creating push event.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard\Service * @package OCP\Dashboard\Service
*/ */
@ -47,6 +48,7 @@ interface IEventsService {
* @see IDashboardManager::createUsersEvent * @see IDashboardManager::createUsersEvent
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $widgetId * @param string $widgetId
* @param array $users * @param array $users
@ -62,6 +64,7 @@ interface IEventsService {
* @see IDashboardManager::createGroupsEvent * @see IDashboardManager::createGroupsEvent
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $widgetId * @param string $widgetId
* @param array $groups * @param array $groups
@ -77,6 +80,7 @@ interface IEventsService {
* @see IDashboardManager::createGlobalEvent * @see IDashboardManager::createGlobalEvent
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $widgetId * @param string $widgetId
* @param array $payload * @param array $payload

2
lib/public/Dashboard/Service/IWidgetsService.php
View File

@ -36,6 +36,7 @@ use OCP\Dashboard\Model\IWidgetConfig;
* configuration of a widget for a user. * configuration of a widget for a user.
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @package OCP\Dashboard\Service * @package OCP\Dashboard\Service
*/ */
@ -45,6 +46,7 @@ interface IWidgetsService {
* Returns the IWidgetConfig for a widgetId and userId * Returns the IWidgetConfig for a widgetId and userId
* *
* @since 15.0.0 * @since 15.0.0
* @deprecated 20.0.0
* *
* @param string $widgetId * @param string $widgetId
* @param string $userId * @param string $userId