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)

Adds a triggered task to an existing automation event.

Declaration

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

Parameters

Type	Name	Description
string	automationEventId	The unique identifier of the automation event.
string	automationEventEmail	The email address associated with the automation event.
AutomationEvent.TriggeredTask	triggeredTask	The triggered task to add.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

Exceptions

Type	Condition
ArgumentException	Thrown when automationEventId is null or empty.

DeleteExpiredEventsAsync(DateTimeOffset, CancellationToken)

Deletes all automation events whose expiration date is earlier than the specified date.

Declaration

Task DeleteExpiredEventsAsync(DateTimeOffset expirationDate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DateTimeOffset	expirationDate	The cutoff date; entries with an expiration date before this value will be deleted.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

EventExistsAsync(AutomationEventFilter, CancellationToken)

Determines whether an automation event matching the specified filter exists.

Declaration

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

Parameters

Type	Name	Description
AutomationEventFilter	filter	The filter criteria used to check for an existing automation event.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task<bool>	true if a matching automation event exists; otherwise false.

GetEventAsync(AutomationEventFilter, CancellationToken)

Retrieves the first automation event matching the specified filter, or null if none is found.

Declaration

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

Parameters

Type	Name	Description
AutomationEventFilter	filter	The filter criteria used to query the automation event.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task<AutomationEvent>	The first matching AutomationEvent, or null.

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 filter criteria used to query automation events.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task<IEnumerable<AutomationEvent>>	A collection of AutomationEvent matching the filter.

SetAsync(AutomationEvent, CancellationToken)

Persists a new or updated automation event to the store.

Declaration

Task SetAsync(AutomationEvent automationEvent, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationEvent	automationEvent	The AutomationEvent to save.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

Exceptions

Type	Condition
ArgumentNullException	Thrown when automationEvent is null.
ArgumentException	Thrown when Id, Email is null or empty, or EventDate is not set.