IWidgetRequest¶
-
interface
OCP\Dashboard\Model\
IWidgetRequest
¶ - Interface IWidgetRequestWidgetRequest are created by the Dashboard App and used to communicate fromthe frontend to the backend.The object is send to the WidgetClass using IDashboardWidget::requestWidget
Source: lib/public/Dashboard/Model/IWidgetRequest.php#45
Methods¶
-
public
OCP\Dashboard\Model\IWidgetRequest::
getWidgetId
()¶ - Get the widgetId.
Source: lib/public/Dashboard/Model/IWidgetRequest.php#55 Since: 15.0.0 Deprecated: 20.0.0 Returns: string
-
public
OCP\Dashboard\Model\IWidgetRequest::
getWidget
()¶ - Get the WidgetClass.
Source: lib/public/Dashboard/Model/IWidgetRequest.php#66 Since: 15.0.0 Deprecated: 20.0.0 Returns: \OCP\Dashboard\IDashboardWidget
-
public
OCP\Dashboard\Model\IWidgetRequest::
getRequest
()¶ - Get the ‘request’ string sent by the request from the front-end withthe format:net.requestWidget({widget: widgetId,request: request,value: value},callback);
Source: lib/public/Dashboard/Model/IWidgetRequest.php#86 Since: 15.0.0 Deprecated: 20.0.0 Returns: string
-
public
OCP\Dashboard\Model\IWidgetRequest::
getValue
()¶ - Get the ‘value’ string sent by the request from the front-end.
Source: lib/public/Dashboard/Model/IWidgetRequest.php#99 See: \OCP\Dashboard\Model\getRequest
Since: 15.0.0 Deprecated: 20.0.0 Returns: string
-
public
OCP\Dashboard\Model\IWidgetRequest::
getResult
()¶ - Returns the result.
Source: lib/public/Dashboard/Model/IWidgetRequest.php#110 Since: 15.0.0 Deprecated: 20.0.0 Returns: array
-
public
OCP\Dashboard\Model\IWidgetRequest::
addResult
($key, $result)¶ - add a result (as string)
Source: Parameters: - $key (string)
- $result (string)
Since: 15.0.0
Deprecated: 20.0.0
Returns: $this
-
public
OCP\Dashboard\Model\IWidgetRequest::
addResultArray
($key, $result)¶ - add a result (as array)
Source: Parameters: - $key (string)
- $result (array)
Since: 15.0.0
Deprecated: 20.0.0
Returns: $this