IWidgetConfig

interface OCP\Dashboard\Model\IWidgetConfig

Interface IWidgetConfig

This object contains the configuration of a widget for a userId

Source:lib/public/Dashboard/Model/IWidgetConfig.php#43

Methods

public OCP\Dashboard\Model\IWidgetConfig::getUserId()

Returns the userId

Source:lib/public/Dashboard/Model/IWidgetConfig.php#54 Since:15.0.0 Deprecated:20.0.0 Returns:string

public OCP\Dashboard\Model\IWidgetConfig::getWidgetId()

Returns the widgetId

Source:lib/public/Dashboard/Model/IWidgetConfig.php#65 Since:15.0.0 Deprecated:20.0.0 Returns:string

public OCP\Dashboard\Model\IWidgetConfig::getPosition()

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

]

Source:lib/public/Dashboard/Model/IWidgetConfig.php#85 Since:15.0.0 Deprecated:20.0.0 Returns:array

public OCP\Dashboard\Model\IWidgetConfig::getSettings()

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.

Source:lib/public/Dashboard/Model/IWidgetConfig.php#116 See:\OCP\Dashboard\Model\WidgetSetting Those WidgetSetting are in the WidgetTemplate defined during the setup of the widget in the IDashboardWidget. See:\OCP\Dashboard\Model\WidgetSetting Those WidgetSetting are in the WidgetTemplate defined during the setup of the widget in the IDashboardWidget. See:\OCP\Dashboard\Model\WidgetSetting Those WidgetSetting are in the WidgetTemplate defined during the setup of the widget in the IDashboardWidget. Since:15.0.0 Deprecated:20.0.0 Returns:array

public OCP\Dashboard\Model\IWidgetConfig::isEnabled()

Returns if the widget is enabled/displayed in this user’s dashboard.

Source:lib/public/Dashboard/Model/IWidgetConfig.php#127 Since:15.0.0 Deprecated:20.0.0 Returns:bool