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.
Tags
Table of Contents
- createGlobalEvent() : mixed
- Create a global event for all users that use a specific widget.
- createGroupsEvent() : mixed
- Create an event for a widget and an array of groups.
- createUsersEvent() : mixed
- Create an event for a widget and an array of users.
Methods
createGlobalEvent()
Create a global event for all users that use a specific widget.
public
createGlobalEvent(string $widgetId, array $payload, string $uniqueId) : mixed
Parameters
- $widgetId : string
- $payload : array
- $uniqueId : string
Tags
Return values
mixed —createGroupsEvent()
Create an event for a widget and an array of groups.
public
createGroupsEvent(string $widgetId, array $groups, array $payload, string $uniqueId) : mixed
Parameters
- $widgetId : string
- $groups : array
- $payload : array
- $uniqueId : string
Tags
Return values
mixed —createUsersEvent()
Create an event for a widget and an array of users.
public
createUsersEvent(string $widgetId, array $users, array $payload, string $uniqueId) : mixed
Parameters
- $widgetId : string
- $users : array
- $payload : array
- $uniqueId : string