Interface IServerEventRouter
Routes server events to the correct users.
Namespace: Umbraco.Cms.Core.ServerEvents
Assembly: Umbraco.Core.dll
Syntax
public interface IServerEventRouterMethods
View SourceBroadcastEventAsync(ServerEvent)
Broadcast a server event to all users, regardless of authorization.
Declaration
Task BroadcastEventAsync(ServerEvent serverEvent)Parameters
| Type | Name | Description |
|---|---|---|
| ServerEvent | serverEvent | The event to broadcast. |
Returns
| Type | Description |
|---|---|
| Task |
NotifyUserAsync(ServerEvent, Guid)
Notify a specific user about a server event.
Declaration
Task NotifyUserAsync(ServerEvent serverEvent, Guid userKey)Parameters
| Type | Name | Description |
|---|---|---|
| ServerEvent | serverEvent | The server event to send to the user. |
| Guid | userKey | Key of the user. |
Returns
| Type | Description |
|---|---|
| Task |
RouteEventAsync(ServerEvent)
Route a server event the users that has permissions to see it.
Declaration
Task RouteEventAsync(ServerEvent serverEvent)Parameters
| Type | Name | Description |
|---|---|---|
| ServerEvent | serverEvent | The server event to route. |
Returns
| Type | Description |
|---|---|
| Task |
RouteEventAsync(ServerEvent, ServerEventRoutingContext)
Route a server event to the users that have permission to see it, using the supplied routing context to gate delivery per recipient (e.g. by start-node access for document and media events).
Declaration
Task RouteEventAsync(ServerEvent serverEvent, ServerEventRoutingContext context)Parameters
| Type | Name | Description |
|---|---|---|
| ServerEvent | serverEvent | The server event to route. |
| ServerEventRoutingContext | context | Server-side routing context. Not sent to clients. |
Returns
| Type | Description |
|---|---|
| Task | A task that represents the asynchronous routing operation. |