Interface INewsletterRowService

Defines the interface for a service that manages newsletter rows.

Namespace: DataWeb.Newsletter

Assembly: DataWeb.Core.dll

Syntax

public interface INewsletterRowService

Methods

GetReportAsync(NewsletterRow, CancellationToken)

Gets a report for the specified newsletter row.

Declaration

Task<NewsletterRowReport> GetReportAsync(NewsletterRow newsletterRow, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterRow	newsletterRow	The NewsletterRow for which to generate the report.
CancellationToken	cancellationToken

Returns

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

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.

SetRowFromModelAsync(NewsletterModel, CancellationToken)

Sets a newsletter row based on the specified newsletter model.

Declaration

Task<string> SetRowFromModelAsync(NewsletterModel newsletterModel, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NewsletterModel	newsletterModel	The NewsletterModel to use for generating the newsletter row.
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>	A task representing the asynchronous operation that returns the Id of the newly created newsletter row.

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.