centersl/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-03-27 13:38:39 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9280 from nextcloud/feature/noid/document-IConditionalWidget

Browse Source 
Document the IConditionalWidget dashboard interface
This commit is contained in:
Christoph Wurst
2022-11-02 12:37:45 +01:00
committed by GitHub
parent 3f9d58260f 1b8182567f
commit 99f2be21c6
1 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
developer_manual/digging_deeper/dashboard.rst
View File

@@ -147,6 +147,20 @@ however this method is deprecated and will be removed once Nextcloud 19 is EOL.
}
}
The IConditionalWidget interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The IConditionalWidget interface adds the **isEnabled** method to provide the option for a widget to opt-out later.
While registering the widget the information whether or not a widget should be displayed to the specific user might
not be available or to complex to calculate up front. In this case the IConditionalWidget allows you to check the
conditions only when really needed.
.. code-block:: php
public function isEnabled(): bool {
return false;
}
Provide a user interface
------------------------
@@ -188,9 +202,8 @@ those additional interfaces:
* IOptionWidget to set additional options
* IAPIWidget to actually provide the widget content (the item list)
+++++++++++++++++++++++++++
The IButtonWidget interface
+++++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The IButtonWidget interface adds the **getWidgetButtons** method to provide a list of buttons
@@ -225,9 +238,8 @@ There are 3 types of buttons:
];
}
+++++++++++++++++++++++++++
The IIconWidget interface
+++++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^^
The IIconWidget interface adds the **getIconUrl** method to provide the URL to the widget icon. In the following example
it returns the URL to the img/app.svg file in your app.
@@ -240,9 +252,8 @@ it returns the URL to the img/app.svg file in your app.
);
}
+++++++++++++++++++++++++++
The IOptionWidget interface
+++++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The IOptionWidget interface adds the **getWidgetOptions** method to provide additional widget options. It returns
a WidgetOptions object which only contains the **roundItemIcons** boolean value for now. This tells the clients if
@@ -254,9 +265,8 @@ the widget item icons should be rounded or kept as squares.
return new WidgetOptions(true);
}
+++++++++++++++++++++++++++
The IAPIWidget interface
+++++++++++++++++++++++++++
^^^^^^^^^^^^^^^^^^^^^^^^
If you want your widget content to be accessible with the dashboard API for Nextcloud clients,
it must implement the `OCP\\Dashboard\\IAPIWidget` interface rather than `OCP\\Dashboard\\IWidget`.
@@ -289,9 +299,8 @@ This interface contains an extra `getItems` method which returns an array of `OC
* iconUrl: URL to a square icon (svg or jpg/png of at least 44x44px)
* sinceId: Item ID or timestamp. The client will then send the latest known sinceId in next dashboard API request.
+++++++++++
Use the API
+++++++++++
^^^^^^^^^^^
The list of enabled widgets can be requested like that: