Interface INewsletterEventStore

Represents a store for newsletter events.

Namespace: DataWeb.Newsletter

Assembly: DataWeb.Core.dll

Syntax

public interface INewsletterEventStore

Properties

Name

Gets the name of the newsletter event store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

BatchInsertAsync(string, List<NewsletterEventBatchInsert>, CancellationToken)

Adds a collection of newsletter events to the store in a single batch.

Declaration

Task BatchInsertAsync(string rowIdMaster, List<NewsletterEventBatchInsert> events, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The IdMaster associated with the newsletter events.
List<NewsletterEventBatchInsert>	events	The NewsletterEventBatchInsert events to add to the store.
CancellationToken	cancellationToken

Returns

Type	Description
Task

ConvertStringToEventType(string)

Converts a string representation of a newsletter event type into a corresponding NewsletterEventType value.

Declaration

NewsletterEventType ConvertStringToEventType(string value)

Parameters

Type	Name	Description
string	value	The string representation of the newsletter event type.

Returns

Type	Description
NewsletterEventType	The corresponding NewsletterEventType value.

GetEventAsync(NewsletterEventFilter, CancellationToken)

Gets the first newsletter event that matches the specified filter criteria.

Declaration

Task<NewsletterEvent> GetEventAsync(NewsletterEventFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterEventFilter	filter	The NewsletterEventFilter used to search for a newsletter event.
CancellationToken	cancellationToken

Returns

Type	Description
Task<NewsletterEvent>	The first newsletter event that matches the filter criteria.

GetEventsAsync(NewsletterEventFilter, CancellationToken)

Gets a collection of newsletter events that match the specified filter criteria.

Declaration

Task<IEnumerable<NewsletterEvent>> GetEventsAsync(NewsletterEventFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterEventFilter	filter	The NewsletterEventFilter used to search for newsletter events.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<NewsletterEvent>>	A collection of newsletter events.

GetEventsCountAsync(NewsletterEventFilter, CancellationToken)

Gets the number of newsletter events that match the specified filter criteria.

Declaration

Task<long> GetEventsCountAsync(NewsletterEventFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterEventFilter	filter	The NewsletterEventFilter used to count newsletter events.
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	The number of newsletter events that match the filter criteria.

GetRowLinksAsync(string, CancellationToken)

Gets a collection of row links associated with the specified IdMaster.

Declaration

Task<IEnumerable<string>> GetRowLinksAsync(string rowIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The IdMaster used to search for row links.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<string>>	A collection of row links associated with the specified IdMaster.

GetWorkedCountAsync(string, CancellationToken)

Gets the number of newsletter events that have the specified IdMaster.

Declaration

Task<long> GetWorkedCountAsync(string rowIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The IdMaster used to count newsletter events.
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	The number of newsletter events that have the specified IdMaster.

IsMailInSendListAsync(string, string, CancellationToken)

Determines whether the specified email address is in the newsletter send list.

Declaration

Task<bool> IsMailInSendListAsync(string email, string rowIdMaster = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	email	The email address to check.
string	rowIdMaster	The IdMaster used to check the email address.
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>	True if the email address is in the newsletter send list; otherwise, false.

RemoveOldEventsAsync(CancellationToken)

Removes newsletter events from the store that are older than a certain time period.

Declaration

Task RemoveOldEventsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetAsync(string, NewsletterEventType, string, string, CancellationToken)

Adds a new newsletter event to the store.

Declaration

Task<string> SetAsync(string email, NewsletterEventType eventType, string description = null, string rowIdMaster = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	email	The email address associated with the newsletter event.
NewsletterEventType	eventType	The NewsletterEventType of newsletter event.
string	description	The description of the newsletter event.
string	rowIdMaster	The IdMaster associated with the newsletter event.
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>	The id or the event.