IEventsService

interface OCP\Dashboard\Service\IEventsService
Interface IEventsService
The Service is provided by the Dashboard app. The method in this interface
are used by the IDashboardManager when creating push event.
Source:lib/public/Dashboard/Service/IEventsService.php#42

Methods

public OCP\Dashboard\Service\IEventsService::createUsersEvent($widgetId, $users, $payload, $uniqueId)
Create an event for a widget and an array of users.
Source:

lib/public/Dashboard/Service/IEventsService.php#58

Parameters:
  • $widgetId (string)
  • $users (array)
  • $payload (array)
  • $uniqueId (string)
See:

\OCP\Dashboard\Service\IDashboardManager::createUsersEvent

Since:

15.0.0

Deprecated:

20.0.0

public OCP\Dashboard\Service\IEventsService::createGroupsEvent($widgetId, $groups, $payload, $uniqueId)
Create an event for a widget and an array of groups.
Source:

lib/public/Dashboard/Service/IEventsService.php#74

Parameters:
  • $widgetId (string)
  • $groups (array)
  • $payload (array)
  • $uniqueId (string)
See:

\OCP\Dashboard\Service\IDashboardManager::createGroupsEvent

Since:

15.0.0

Deprecated:

20.0.0

public OCP\Dashboard\Service\IEventsService::createGlobalEvent($widgetId, $payload, $uniqueId)
Create a global event for all users that use a specific widget.
Source:

lib/public/Dashboard/Service/IEventsService.php#89

Parameters:
  • $widgetId (string)
  • $payload (array)
  • $uniqueId (string)
See:

\OCP\Dashboard\Service\IDashboardManager::createGlobalEvent

Since:

15.0.0

Deprecated:

20.0.0