Class EmailFolderProvider

EmailFolderProvider gives you the folder hierarchy of a given mail account

Inheritance
object
AnyTableListProviderBase
EmailFolderProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("EmailFolder")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("accountId", "Id of the account for which you want the folders", 0)]
[MDOAdditionalInfo("hierarchy", "Use hierarchy", "true")]
public class EmailFolderProvider : AnyTableListProviderBase, ISoListProvider, ISoList

Constructors

EmailFolderProvider()

EmailFolderProvider gives you the folder hierarchy of a given mail account

Declaration
public EmailFolderProvider()

Fields

ProviderName

EmailFolderProvider gives you the folder hierarchy of a given mail account

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

_accountId

EmailFolderProvider gives you the folder hierarchy of a given mail account

Declaration
protected int _accountId
Field Value
Type Description
int

_associateId

EmailFolderProvider gives you the folder hierarchy of a given mail account

Declaration
protected int _associateId
Field Value
Type Description
int

_hierarchy

EmailFolderProvider gives you the folder hierarchy of a given mail account

Declaration
protected bool _hierarchy
Field Value
Type Description
bool

_tableInfo

EmailFolderProvider gives you the folder hierarchy of a given mail account

Declaration
protected EmailFolderTableInfo _tableInfo
Field Value
Type Description
EmailFolderTableInfo

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