IDashboardManager¶
-
interface
OCP\Dashboard\
IDashboardManager
¶ - Interface IDashboardManagerIDashboardManager should be used to manage widget from the backend.The call can be done from any Service.
Implemented by: OC\Dashboard\DashboardManager
Source: lib/public/Dashboard/IDashboardManager.php#45
Methods¶
-
public
OCP\Dashboard\IDashboardManager::
registerWidgetsService
($widgetsService)¶ - Register a IWidgetsService.
Source: Parameters: - $widgetsService (
OCP\Dashboard\Service\IWidgetsService
)
Since: 15.0.0
Deprecated: 20.0.0
- $widgetsService (
-
public
OCP\Dashboard\IDashboardManager::
registerEventsService
($eventsService)¶ - Register a IEventsService.
Source: Parameters: - $eventsService (
OCP\Dashboard\Service\IEventsService
)
Since: 15.0.0
Deprecated: 20.0.0
- $eventsService (
-
public
OCP\Dashboard\IDashboardManager::
getWidgetConfig
($widgetId, $userId)¶ - returns the OCP\Dashboard\Model\IWidgetConfig for a widgetId and userId.
Source: Parameters: - $widgetId (string)
- $userId (string)
See: Since: 15.0.0
Deprecated: 20.0.0
Throws: Returns:
-
public
OCP\Dashboard\IDashboardManager::
createUsersEvent
($widgetId, $users, $payload, $uniqueId="")¶ - Create push notifications for users.$payload is an array that will be send to the Javascript methodcalled on push.$uniqueId needs to be used if you send the push to multiples usersand multiples groups so that one user does not have duplicatenotifications.Push notifications are created in database and broadcast to userthat are running dashboard.
Source: Parameters: - $widgetId (string)
- $users (array)
- $payload (array)
- $uniqueId (string)
Since: 15.0.0
Deprecated: 20.0.0
Throws:
-
public
OCP\Dashboard\IDashboardManager::
createGroupsEvent
($widgetId, $groups, $payload, $uniqueId="")¶ - Create push notifications for groups. (ie. createUsersEvent())
Source: Parameters: - $widgetId (string)
- $groups (array)
- $payload (array)
- $uniqueId (string)
Since: 15.0.0
Deprecated: 20.0.0
Throws:
-
public
OCP\Dashboard\IDashboardManager::
createGlobalEvent
($widgetId, $payload, $uniqueId="")¶ - Create push notifications for everyone. (ie. createUsersEvent())
Source: Parameters: - $widgetId (string)
- $payload (array)
- $uniqueId (string)
Since: 15.0.0
Deprecated: 20.0.0
Throws: