Class NewsletterMailingList

Base class for newsletter mailing lists.

Inheritance

object

NewsletterMailingList

NewsletterMailingListBasic

NewsletterMailingListOneTime

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Newsletter

Assembly: DataWeb.Core.dll

Syntax

public abstract class NewsletterMailingList

Remarks

Creates a new instance of the NewsletterMailingList class.

Constructors

NewsletterMailingList(IServiceProvider)

Base class for newsletter mailing lists.

Declaration

protected NewsletterMailingList(IServiceProvider serviceProvider)

Parameters

Type	Name	Description
IServiceProvider	serviceProvider	The service provider.

Remarks

Creates a new instance of the NewsletterMailingList class.

Fields

serviceProvider

Declaration

protected readonly IServiceProvider serviceProvider

Field Value

Type	Description
IServiceProvider

Properties

Countries

The countries of the subscribers in the mailing list.

Declaration

public IEnumerable<string> Countries { get; set; }

Property Value

Type	Description
IEnumerable<string>

Cultures

The cultures of the subscribers in the mailing list.

Declaration

public IEnumerable<string> Cultures { get; set; }

Property Value

Type	Description
IEnumerable<string>

Groups

The groups of the subscribers in the mailing list.

Declaration

public IEnumerable<string> Groups { get; set; }

Property Value

Type	Description
IEnumerable<string>

IdMaster

Gets or sets the unique identifier.

Declaration

public string IdMaster { get; set; }

Property Value

Type	Description
string

Interests

The interests of the subscribers in the mailing list.

Declaration

public IEnumerable<string> Interests { get; set; }

Property Value

Type	Description
IEnumerable<string>

MailingListClass

The class of the mailing list.

Declaration

public string MailingListClass { get; set; }

Property Value

Type	Description
string

Name

The name of the mailing list.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Zones

The zones of the subscribers in the mailing list.

Declaration

public IEnumerable<string> Zones { get; set; }

Property Value

Type	Description
IEnumerable<string>

Methods

ProcessOnRowSendCompleteAsync(string, CancellationToken)

This method is called after the mailing list is sent to all subscribers in a row.

Declaration

public virtual Task ProcessOnRowSendCompleteAsync(string rowIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The Id of the row in the database.
CancellationToken	cancellationToken

Returns

Type	Description
Task

ProcessOnRowSendStartAsync(string, CancellationToken)

This method is called before the mailing list is sent to all subscribers in a row.

Declaration

public virtual Task ProcessOnRowSendStartAsync(string rowIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The Id of the row in the database.
CancellationToken	cancellationToken

Returns

Type	Description
Task

ProcessOnSubscriberSendCompleteAsync(string, string, CancellationToken)

This method is called after the mailing list is sent to a subscriber.

Declaration

public virtual Task ProcessOnSubscriberSendCompleteAsync(string rowIdMaster, string subscriberId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The Id of the row in the database.
string	subscriberId	The Id of the subscriber.
CancellationToken	cancellationToken

Returns

Type	Description
Task

ProcessOnSubscriberSendStartAsync(string, string, CancellationToken)

This method is called before the mailing list is sent to a subscriber.

Declaration

public virtual Task ProcessOnSubscriberSendStartAsync(string rowIdMaster, string subscriberId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	rowIdMaster	The Id of the row in the database.
string	subscriberId	The Id of the subscriber.
CancellationToken	cancellationToken

Returns

Type	Description
Task