Interface IAutomationEventStore

Represents a store for automation events.

Namespace: DataWeb.Automation

Assembly: DataWeb.Core.dll

Syntax

public interface IAutomationEventStore

Properties

Name

Gets the name of the automation event store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

AddTriggeredTaskAsync(string, string, TriggeredTask, CancellationToken)

Asynchronously adds a triggered event to the automation event.

Declaration

Task AddTriggeredTaskAsync(string automationEventId, string automationEventEmail, AutomationEvent.TriggeredTask triggeredTask, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationEventId	The id of the automation event.
string	automationEventEmail	The email of the automation event.
AutomationEvent.TriggeredTask	triggeredTask	The triggered task to add.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task that represents the asynchronous operation.

DeleteExpiredEventsAsync(DateTimeOffset, CancellationToken)

Asynchronously removes expired entries.

Declaration

Task DeleteExpiredEventsAsync(DateTimeOffset expirationDate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DateTimeOffset	expirationDate	The entries with ExpirationDate older than this value will be deleted.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task that represents the asynchronous operation.

EventExistsAsync(AutomationEventFilter, CancellationToken)

Asynchronously check if an automation event that match the specified filter exists.

Declaration

Task<bool> EventExistsAsync(AutomationEventFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationEventFilter	filter	The AutomationEventFilter used to retrieve the automation event.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>	A task that represents the asynchronous operation.

GetEventAsync(AutomationEventFilter, CancellationToken)

Asynchronously retrieves an automation event that match the specified filter.

Declaration

Task<AutomationEvent> GetEventAsync(AutomationEventFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationEventFilter	filter	The AutomationEventFilter used to retrieve the automation event.
CancellationToken	cancellationToken

Returns

Type	Description
Task<AutomationEvent>	A task that represents the asynchronous operation. The task result contains the automation events.

GetEventCountAsync(AutomationEventFilter, CancellationToken)

Asynchronously retrieves the count of automation events that match the specified filter.

Declaration

Task<long> GetEventCountAsync(AutomationEventFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationEventFilter	filter	The filter criteria used to query the automation events.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.

Returns

Type	Description
Task<long>	The total number of matching automation events as a long.

GetEventsAsync(AutomationEventFilter, CancellationToken)

Asynchronously retrieves automation events that match the specified filter.

Declaration

Task<IEnumerable<AutomationEvent>> GetEventsAsync(AutomationEventFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationEventFilter	filter	The AutomationEventFilter used to retrieve the automation events.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<AutomationEvent>>	A task that represents the asynchronous operation. The task result contains the automation events.

SetAsync(AutomationEvent, CancellationToken)

Asynchronously adds an automation event to the store.

Declaration

Task SetAsync(AutomationEvent automationEvent, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationEvent	automationEvent	The AutomationEvent to add to the store.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task that represents the asynchronous operation.