IWidget¶
-
interface
OCP\Dashboard\
IWidget
¶ - Interface IWidget
Source: lib/public/Dashboard/IWidget.php#34
Methods¶
-
public
OCP\Dashboard\IWidget::
getId
()¶ Source: lib/public/Dashboard/IWidget.php#40 Returns: string Unique id that identifies the widget, e.g. the app id Since: 20.0.0
-
public
OCP\Dashboard\IWidget::
getTitle
()¶ Source: lib/public/Dashboard/IWidget.php#46 Returns: string User facing title of the widget Since: 20.0.0
-
public
OCP\Dashboard\IWidget::
getOrder
()¶ Source: lib/public/Dashboard/IWidget.php#52 Returns: int Initial order for widget sorting Since: 20.0.0
-
public
OCP\Dashboard\IWidget::
getIconClass
()¶ Source: lib/public/Dashboard/IWidget.php#58 Returns: string css class that displays an icon next to the widget title Since: 20.0.0
-
public
OCP\Dashboard\IWidget::
getUrl
()¶ Source: lib/public/Dashboard/IWidget.php#64 Returns: string | null The absolute url to the apps own view Since: 20.0.0
-
public
OCP\Dashboard\IWidget::
load
()¶ - Execute widget bootstrap code like loading scripts and providing initial state
Source: lib/public/Dashboard/IWidget.php#70 Since: 20.0.0