Interface IAutomationProfileStore

Represents a store for automation profiles.

Namespace: DataWeb.Automation

Assembly: DataWeb.Core.dll

Syntax

public interface IAutomationProfileStore

Properties

Name

Gets the name of the automation profile store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

DeleteAsync(string, string, CancellationToken)

Asynchronously deletes an automation profile.

Declaration

Task DeleteAsync(string automationProfileId, string email, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationProfileId	The unique identifier of the automation profile.
string	email
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.

GetProfileAsync(AutomationProfileFilter, CancellationToken)

Asynchronously retrieves an automation profile that match the specified filter.

Declaration

Task<AutomationProfile> GetProfileAsync(AutomationProfileFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationProfileFilter	filter	The AutomationProfileFilter used to retrieve the automation profiles.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

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

GetProfileCountAsync(AutomationProfileFilter, CancellationToken)

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

Declaration

Task<long> GetProfileCountAsync(AutomationProfileFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationProfileFilter	filter	The filter used to query automation profiles.
CancellationToken	cancellationToken	A token to cancel the asynchronous operation (optional).

Returns

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

GetProfilesAsync(AutomationProfileFilter, CancellationToken)

Asynchronously retrieves automation profiles that match the specified filter.

Declaration

Task<IEnumerable<AutomationProfile>> GetProfilesAsync(AutomationProfileFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationProfileFilter	filter	The AutomationProfileFilter used to retrieve the automation profiles.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

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

ProfileExistsAsync(AutomationProfileFilter, CancellationToken)

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

Declaration

Task<bool> ProfileExistsAsync(AutomationProfileFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationProfileFilter	filter	The AutomationProfileFilter used to retrieve the automation profile.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

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

SetAsync(AutomationProfile, CancellationToken)

Asynchronously adds an automation profile to the store.

Declaration

Task SetAsync(AutomationProfile automationProfile, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationProfile	automationProfile	The AutomationProfile to add to the store.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetModificationDateAsync(string, string, DateTimeOffset, CancellationToken)

Asynchronously sets the modification date of an automation profile.

Declaration

Task SetModificationDateAsync(string automationProfileId, string automationProfileEmail, DateTimeOffset modificationDate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationProfileId	The unique identifier of the automation profile.
string	automationProfileEmail	The email associated with the automation profile, used for partitioning or tracking.
DateTimeOffset	modificationDate	The new date to be set for the automation profile.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetNewsletterStatusAsync(string, string, AutomationProfileNotificationStatus, CancellationToken)

Asynchronously sets the newsletter status of an automation profile.

Declaration

Task SetNewsletterStatusAsync(string automationProfileId, string automationProfileEmail, AutomationProfileNotificationStatus status, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationProfileId	The unique identifier of the automation profile.
string	automationProfileEmail	The email associated with the automation profile, used for partitioning or tracking.
AutomationProfileNotificationStatus	status	The new newsletter status to be set for the automation profile.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetNewsletterSubscriptionDateAsync(string, string, DateTimeOffset, CancellationToken)

Asynchronously sets the newsletter subscription date of an automation profile.

Declaration

Task SetNewsletterSubscriptionDateAsync(string automationProfileId, string automationProfileEmail, DateTimeOffset newsletterSubscriptionDate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationProfileId	The unique identifier of the automation profile.
string	automationProfileEmail	The email associated with the automation profile, used for partitioning or tracking.
DateTimeOffset	newsletterSubscriptionDate	The new date to be set for the automation profile.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetNotificationAppStatusAsync(string, string, AutomationProfileNotificationStatus, CancellationToken)

Asynchronously sets the app notification status of an automation profile.

Declaration

Task SetNotificationAppStatusAsync(string automationProfileId, string automationProfileEmail, AutomationProfileNotificationStatus status, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationProfileId	The unique identifier of the automation profile.
string	automationProfileEmail	The email associated with the automation profile, used for partitioning or tracking.
AutomationProfileNotificationStatus	status	The new notification status to be set for the automation profile.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetNotificationEmailStatusAsync(string, string, AutomationProfileNotificationStatus, CancellationToken)

Asynchronously sets the email notification status of an automation profile.

Declaration

Task SetNotificationEmailStatusAsync(string automationProfileId, string automationProfileEmail, AutomationProfileNotificationStatus status, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationProfileId	The unique identifier of the automation profile.
string	automationProfileEmail	The email associated with the automation profile, used for partitioning or tracking.
AutomationProfileNotificationStatus	status	The new notification status to be set for the automation profile.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetNotificationPhoneStatusAsync(string, string, AutomationProfileNotificationStatus, CancellationToken)

Asynchronously sets the phone notification status of an automation profile.

Declaration

Task SetNotificationPhoneStatusAsync(string automationProfileId, string automationProfileEmail, AutomationProfileNotificationStatus status, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationProfileId	The unique identifier of the automation profile.
string	automationProfileEmail	The email associated with the automation profile, used for partitioning or tracking.
AutomationProfileNotificationStatus	status	The new notification status to be set for the automation profile.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetStatusAsync(string, string, AutomationProfileStatus, CancellationToken)

Asynchronously sets the status of an automation profile.

Declaration

Task SetStatusAsync(string automationProfileId, string automationProfileEmail, AutomationProfileStatus status, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	automationProfileId	The unique identifier of the automation profile.
string	automationProfileEmail	The email associated with the automation profile, used for partitioning or tracking.
AutomationProfileStatus	status	The new status to be set for the automation profile.
CancellationToken	cancellationToken	A token to observe while waiting for the task to complete (optional).

Returns

Type	Description
Task	A task that represents the asynchronous operation.