DataWeb
Search Results for

    Show / Hide Table of Contents

    Class AutomationEventStore

    Inheritance
    object
    AutomationEventStore
    Implements
    IAutomationEventStore
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: DataWeb.Automation.AzureCosmosDB
    Assembly: DataWeb.Data.AzureCosmosDB.dll
    Syntax
    public class AutomationEventStore : IAutomationEventStore

    Constructors

    AutomationEventStore(ICosmosHelper, IConfigurationService)

    Declaration
    public AutomationEventStore(ICosmosHelper cosmosHelper, IConfigurationService configurationService)
    Parameters
    Type Name Description
    ICosmosHelper cosmosHelper
    IConfigurationService configurationService

    Properties

    Name

    Gets the name of the store implementation.

    Declaration
    public string Name { get; }
    Property Value
    Type Description
    string

    Methods

    AddTriggeredTaskAsync(string, string, TriggeredTask, CancellationToken)

    Adds a triggered task to an existing automation event.

    Declaration
    public 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

    DeleteExpiredEventsAsync(DateTimeOffset, CancellationToken)

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

    Declaration
    public 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

    EventExistsAsync(AutomationEventFilter, CancellationToken)

    Determines whether an automation event matching the specified filter exists.

    Declaration
    public 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
    public 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)

    Returns the total number of automation events matching the specified filter.

    Declaration
    public Task<long> GetEventCountAsync(AutomationEventFilter filter, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AutomationEventFilter filter

    The filter criteria used to count automation events.

    CancellationToken cancellationToken

    A token to cancel the asynchronous operation.

    Returns
    Type Description
    Task<long>

    The count of matching automation events.

    GetEventsAsync(AutomationEventFilter, CancellationToken)

    Retrieves a collection of automation events matching the specified filter.

    Declaration
    public 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 automation event to the store.

    Declaration
    public Task SetAsync(AutomationEvent automationEvent, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AutomationEvent automationEvent

    The automation event to save.

    CancellationToken cancellationToken

    A token to cancel the asynchronous operation.

    Returns
    Type Description
    Task

    Implements

    IAutomationEventStore
    In this article
    Back to top Generated by DocFX