Class SpecifiedMailingsListProvider

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Inheritance
object
AnyTableListProviderBase
SpecifiedMailingsListProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("SpecifiedMailings")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("tracked", "Only mailings with tracked links", "true")]
[MDOAdditionalInfo("configurations", "Specified shipment configurations, default is the most relevant configurations", "")]
[MDOAdditionalInfo("emailFlowId", "If specified, content related to the specified email flow will appear in a special folder near the top, just below history items", "")]
public class SpecifiedMailingsListProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

SpecifiedMailingsListProvider()

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
public SpecifiedMailingsListProvider()

Fields

ProviderName

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
public const string ProviderName = "SpecifiedMailings"
Field Value
Type Description
string

_configurations

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected List<WorkflowHelper.ShipmentConfiguration> _configurations
Field Value
Type Description
List<WorkflowHelper.ShipmentConfiguration>

_emailFlowContentLinkTableInfo

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected EmailFlowContentLinkTableInfo _emailFlowContentLinkTableInfo
Field Value
Type Description
EmailFlowContentLinkTableInfo

_emailFlowId

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected int _emailFlowId
Field Value
Type Description
int

_emailFlowTableInfo

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected EmailFlowTableInfo _emailFlowTableInfo
Field Value
Type Description
EmailFlowTableInfo

_hierarchy

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected bool _hierarchy
Field Value
Type Description
bool

_messageTableInfo

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected SMessageTableInfo _messageTableInfo
Field Value
Type Description
SMessageTableInfo

_shipmentTableInfo

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected SShipmentTableInfo _shipmentTableInfo
Field Value
Type Description
SShipmentTableInfo

_tracked

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected bool _tracked
Field Value
Type Description
bool

_workflowTableInfo

Create a list of mailings (flow, form, regular mailing/shipment...), hierarchy optional

Declaration
protected WorkflowTableInfo _workflowTableInfo
Field Value
Type Description
WorkflowTableInfo

Properties

TableInfo

The table info of the query. This is used by subclasses (e.g. this class) when restricting history data.

Declaration
protected override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo
Overrides

Methods

GetMainQueryAsync(CancellationToken)

Get the main query for the list.

Declaration
protected override Task<Select> GetMainQueryAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<Select>
Overrides

InitAsync(CancellationToken)

Initiate the provider after the ConstructAsync(string, string, int[], bool, string, bool, CancellationToken) method is called.

Declaration
protected override Task InitAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

OnPostGetRootItemsAsync(List<ISoListItem>)

Make the tree structure if necessary

Declaration
protected override Task OnPostGetRootItemsAsync(List<ISoListItem> items)
Parameters
Type Name Description
List<ISoListItem> items
Returns
Type Description
Task
Overrides

OnRead(SoDataReader, short)

Raised every time a new row has been read from the database.
The implementation should read the results from the reader and populate an object implementing ISoListItem.

Declaration
protected override ISoListItem OnRead(SoDataReader reader, short lastRank)
Parameters
Type Name Description
SoDataReader reader

Reader to reaf from.
short lastRank

Value of the last rank populated.
Returns
Type Description
ISoListItem

Data read from the reader.
Overrides

SetSearchRestrictionAsync(Select, string)

Set the search restriction on the list.

Declaration
protected override Task SetSearchRestrictionAsync(Select sql, string searchValue)
Parameters
Type Name Description
Select sql

Query to set the search restriction on.
string searchValue

The value of the search restriction.
Returns
Type Description
Task
Overrides

Implements

Extension Methods