SaaS CMS has officially launched! Learn more now.

Interface IEventBroker

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Describes an object that is responsible for managing the sending and receiving of events remotely.

Namespace: EPiServer.Events.Providers.Internal
Assembly: EPiServer.Events.dll
Version: 11.20.7
Syntax
public interface IEventBroker

Properties

Enabled

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets or sets a value indicating whether the IEventBroker is enabled or not.

Declaration
bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

true if the IEventBroker is enabled; otherwise false.

Methods

RaiseEventAsync(Guid, Object)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Raises an event remotely in an asyncrounous manner.

Declaration
Task RaiseEventAsync(Guid eventId, object parameter)
Parameters
Type Name Description
System.Guid eventId

The event id of the event to raise.

System.Object parameter

The event parameter to send with the event.

Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing the work required to raise the event.

Events

EventMissed

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Occurs when it is discovered that a remote event was missed.

Declaration
event EventHandler<EventMissedEventArgs> EventMissed
Event Type
Type Description
System.EventHandler<EventMissedEventArgs>

EventReceived

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Occurs when a remote event has been received and verified.

Declaration
event EventHandler<EventReceivedEventArgs> EventReceived
Event Type
Type Description
System.EventHandler<EventReceivedEventArgs>

Extension Methods