Interface INewsletterRowStore

Defines the interface for a store that persists newsletter rows.

Namespace: DataWeb.Newsletter

Assembly: DataWeb.Core.dll

Syntax

public interface INewsletterRowStore

Properties

Name

The name of the newsletter row store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetPendingCreditsAsync(CancellationToken)

Gets the number of pending credits for the newsletter row store.

Declaration

Task<long> GetPendingCreditsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	A task representing the asynchronous operation that returns the number of pending credits.

GetRowAsync(NewsletterRowFilter, CancellationToken)

Gets a single newsletter row based on the specified filter.

Declaration

Task<NewsletterRow> GetRowAsync(NewsletterRowFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterRowFilter	filter	The NewsletterRowFilter to use for retrieving the row.
CancellationToken	cancellationToken

Returns

Type	Description
Task<NewsletterRow>	A task representing the asynchronous operation that returns the retrieved newsletter row.

GetRowsAsync(NewsletterRowFilter, CancellationToken)

Gets a collection of newsletter rows based on the specified filter.

Declaration

Task<IEnumerable<NewsletterRow>> GetRowsAsync(NewsletterRowFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterRowFilter	filter	The NewsletterRowFilter to use for retrieving the rows.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<NewsletterRow>>	A task representing the asynchronous operation that returns the retrieved collection of newsletter rows.

SetSendDateTimeAsync(string, CancellationToken)

Sets the send date and time of a newsletter row based on the specified row Id.

Declaration

Task SetSendDateTimeAsync(string rowIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The Id of the newsletter row to update.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.

SetStatusAsync(string, NewsletterRowStatus, CancellationToken)

Sets the status of a newsletter row based on the specified row Id and status.

Declaration

Task SetStatusAsync(string rowIdMaster, NewsletterRowStatus status, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The Id of the newsletter row to update.
NewsletterRowStatus	status	The new NewsletterRowStatus of the newsletter row.
CancellationToken	cancellationToken

Returns

Type	Description
Task	A task representing the asynchronous operation.