fixup! Add docs for new dashboard api

Author: juliusknorr

developer_manual/digging_deeper/dashboard.rst

@@ -2,18 +2,19 @@
 Dashboard
 =========
 
-The dashboard app aims to provide the user with a general overview of their 
-Nextcloud and show information that is currently important.
+The dashboard app aims to provide the user with a general overview of their
+Nextcloud and shows information that is currently important.
 
 App developers can integrate into the dashboard app and provide their own panels.
 
 
 Register a dashboard panels
-===========================
+---------------------------
 
-A dashboard panel is represented by a class implementing the `OCP\\Dashboard\\IPanel` 
-interface. This class will be instantiated whenever the dashboard is loaded, so 
-scripts and initial state that your panel needs can be added in the constructor.
+A dashboard panel is represented by a class implementing the `OCP\\Dashboard\\IPanel`
+interface. This class will be instantiated whenever the dashboard is loaded.
+Any bootstrap code that is needed for the panel can be implemented inside
+of the `load` method and will be called when the dashboard is loaded.
 
 .. code-block:: php
 
@@ -34,32 +35,57 @@ scripts and initial state that your panel needs can be added in the constructor.
             IL10N $l10n,
             IURLGenerator $urlGenerator
         ) {
+            $this->initialStateService = $initialStateService;
             $this->l10n = $l10n;
             $this->urlGenerator = $urlGenerator;
-
-            $initialStateService->provideInitialState('myapp', 'myData', []);
-            \OCP\Util::addScript('myapp', 'dashboard');
         }
 
-        public function getId(): string {
+        /**
+         * @return string Unique id that identifies the panel, e.g. the app id
+         * @since 20.0.0
+         */        public function getId(): string {
             return 'myapppanelid';
         }
 
+        /**
+         * @return string User facing title of the panel
+         * @since 20.0.0
+         */
         public function getTitle(): string {
             return $this->l10n->t('My app');
         }
 
+        /**
+         * @return int Initial order for panel sorting
+         * @since 20.0.0
+         */
         public function getOrder(): int {
             return 0;
         }
 
+        /**
+         * @return string css class that displays an icon next to the panel title
+         * @since 20.0.0
+         */
         public function getIconClass(): string {
             return 'icon-class';
         }
 
+        /**
+         * @return string|null The absolute url to the apps own view
+         * @since 20.0.0
+         */
         public function getUrl(): string {
             return $this->urlGenerator->linkToRouteAbsolute('myapp.view.index');
         }
+
+        /**
+         * Execute panel bootstrap code like loading scripts and providing initial state
+         */
+        public function load(): void {
+            $initialStateService->provideInitialState('myapp', 'myData', []);
+            \OCP\Util::addScript('myapp', 'dashboard');
+        }
     }
 
 
@@ -95,16 +121,16 @@ The class needs to be registered during the app bootstrap.
         }
     }
 
-For compatibility reasons the panel registration can also be performed by 
-listening to the `OCP\\Dashboard\\RegisterPanelEvent` for apps that still 
+For compatibility reasons the panel registration can also be performed by
+listening to the `OCP\\Dashboard\\RegisterPanelEvent` for apps that still
 need to support older versions where the new app boostrap flow is not available,
 however this method is deprecated and will be removed once Nextcloud 19 is EOL.
 
 .. code-block:: php
 
     use OCP\Dashboard\RegisterPanelEvent;
     use OCP\EventDispatcher\IEventDispatcher;
-    
+
     class Application extends App {
         public function __construct(array $urlParams = []) {
             parent::__construct(self::APP_ID, $urlParams);
@@ -121,15 +147,15 @@ however this method is deprecated and will be removed once Nextcloud 19 is EOL.
 
 
 Provide a user interface
-========================
+------------------------
 
-The user interface can be registered though the public `OCA.Dashboard.register` 
-JavaScript method. The first parameter represents the panel id that has already 
-been specified in the `IPanel` implementation. The callback parameter will be 
+The user interface can be registered though the public `OCA.Dashboard.register`
+JavaScript method. The first parameter represents the panel id that has already
+been specified in the `IPanel` implementation. The callback parameter will be
 called to render the panel in the frontend. The user interface can be added to
 the provided DOM element `el`.
 
-The following example shows how a Vue.js component could be used to render the 
+The following example shows how a Vue.js component could be used to render the
 panel user interface, however this approach works for any other framework as well
 as plain JavaScript as well: