Class NewsletterModelService
Provides services related to Newsletter models.
Inheritance
Implements
Inherited Members
Namespace: DataWeb.Newsletter
Assembly: DataWeb.Core.dll
Syntax
public class NewsletterModelService : INewsletterModelService
Constructors
NewsletterModelService(IHttpService, ITemplateService, INewsletterModelStore, INewsletterRowStore, INewsletterEventStore)
Initializes a new instance of the NewsletterModelService class.
Declaration
public NewsletterModelService(IHttpService httpService, ITemplateService templateService, INewsletterModelStore newsletterModelStore, INewsletterRowStore newsletterRowStore, INewsletterEventStore newsletterEventStore)
Parameters
Type | Name | Description |
---|---|---|
IHttpService | httpService | The HTTP service. |
ITemplateService | templateService | The template service. |
INewsletterModelStore | newsletterModelStore | The Newsletter model store. |
INewsletterRowStore | newsletterRowStore | The Newsletter row store. |
INewsletterEventStore | newsletterEventStore | The Newsletter event store. |
Methods
GetCreditsAsync(ProvisioningApp)
Gets the credits available for sending Newsletters for a given ProvisioningApp.
Declaration
public Task<NewsletterCredits> GetCreditsAsync(ProvisioningApp app)
Parameters
Type | Name | Description |
---|---|---|
ProvisioningApp | app | The ProvisioningApp. |
Returns
Type | Description |
---|---|
Task<NewsletterCredits> | The Newsletter credits. |
GetModelAsync(NewsletterModelFilter)
Gets the Newsletter model based on filter criteria.
Declaration
public Task<NewsletterModel> GetModelAsync(NewsletterModelFilter filter)
Parameters
Type | Name | Description |
---|---|---|
NewsletterModelFilter | filter |
Returns
Type | Description |
---|---|
Task<NewsletterModel> | The Newsletter model. |
GetModelsAsync(NewsletterModelFilter)
Gets a list of Newsletter models based on filter criteria.
Declaration
public Task<IEnumerable<NewsletterModel>> GetModelsAsync(NewsletterModelFilter filter)
Parameters
Type | Name | Description |
---|---|---|
NewsletterModelFilter | filter |
Returns
Type | Description |
---|---|
Task<IEnumerable<NewsletterModel>> | The list of Newsletter models. |
RenderBodyAsync(NewsletterModel, string)
Service responsible for rendering the body of a newsletter model, replacing placeholders and adding UTM parameters and hit tracking links.
Declaration
public Task<string> RenderBodyAsync(NewsletterModel newsletterModel, string newsletterRowIdMaster = null)
Parameters
Type | Name | Description |
---|---|---|
NewsletterModel | newsletterModel | The newsletter model to render. |
string | newsletterRowIdMaster | The Id of the newsletter row, if rendering for a specific row. |
Returns
Type | Description |
---|---|
Task<string> | The rendered HTML body of the newsletter. |