Class MailFolderProvider
Provides list of subscribed and unsubscribed mail folders available for an account
Implements
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
[ArchiveProvider("MailFolder", 1073741823)]
public class MailFolderProvider : IArchiveProvider, IArchiveProviderHasRows, IArchiveProviderHasColumns, IArchiveProviderHasEntitiesConstructors
MailFolderProvider()
Default constructor
Declaration
public MailFolderProvider()Methods
Close()
Call this method after the last desired row has been read; this gives the provider the chance to close and free any underlying queries
Declaration
public void Close()GetAvailableColumns()
Get a list of available columns for this provider
Declaration
public List<ArchiveColumnInfo> GetAvailableColumns()Returns
| Type | Description |
|---|---|
| List<ArchiveColumnInfo> |
GetAvailableEntities()
Get available entities for this provider
Declaration
public List<ArchiveRowTypeInfo> GetAvailableEntities()Returns
| Type | Description |
|---|---|
| List<ArchiveRowTypeInfo> |
GetReader(string)
Start the provider, returning an IDataReader compatible object to the client for row enumeration and data access
Declaration
public virtual IDataReader GetReader(string options)Parameters
| Type | Name | Description |
|---|---|---|
| string | options | Options, passed to the internal GetRows method |
Returns
| Type | Description |
|---|---|
| IDataReader | IDataReader primed to provide results |
GetResultInformation()
Get additional information about the result, such as row count or other optional items. This method should be called some time after GetRows, but before Close. Delaying calls to this method as long as possible will give its (asynchronous) internal counterpart more time to complete and lessen the response-time impact of calling it.
Declaration
public virtual ArchiveResultInformation GetResultInformation()Returns
| Type | Description |
|---|---|
| ArchiveResultInformation |
GetRows(string)
Iterator over all rows in the archive, suitable for a foreach access. It is typically implemented using the yield keyword.
Declaration
public IEnumerable<ArchiveRow> GetRows(string options)Parameters
| Type | Name | Description |
|---|---|---|
| string | options |
Returns
| Type | Description |
|---|---|
| IEnumerable<ArchiveRow> |
MapColumnToDbId(string)
Map a named column (usually a restriction column) to a database field id.
Declaration
public int MapColumnToDbId(string columnName)Parameters
| Type | Name | Description |
|---|---|---|
| string | columnName | Name of column to map |
Returns
| Type | Description |
|---|---|
| int | Database field id if available, otherwise 0 |
Remarks
In some cases we may need to map a column of an archive list provider to a unique database field. This is mostly required in order to fetch and store search criteria, both for Dynamic Selections and for other kinds of searches. Columns that are not mappable through this interface cannot be saved and restored, and are therefore not available as criteria for search functions (dynamic selection)
MapDbIdToColumn(int)
Map an integer database field id to a qualified column name
Declaration
public string MapDbIdToColumn(int columnId)Parameters
| Type | Name | Description |
|---|---|---|
| int | columnId | Field id of column to map |
Returns
| Type | Description |
|---|---|
| string | Name of column that matches the given field id, or a blank string if there is no match |
SetDesiredColumns(params string[])
Set which columns should actually be returned, must be a subset of the GetAvailableColumns result
Declaration
public void SetDesiredColumns(params string[] columnIds)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | columnIds | Array of column ID's representing the desired columns |
SetDesiredEntities(params string[])
Provides list of subscribed and unsubscribed mail folders available for an account
Declaration
public void SetDesiredEntities(params string[] entities)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | entities | Array of entity names, semantically equivalent to ArchiveEntityInfo.Name fields. |
SetOrderBy(params ArchiveOrderByInfo[])
Provides list of subscribed and unsubscribed mail folders available for an account
Declaration
public void SetOrderBy(params ArchiveOrderByInfo[] orderBy)Parameters
| Type | Name | Description |
|---|---|---|
| ArchiveOrderByInfo[] | orderBy | Array of order by items |
SetPagingInfo(int, int)
Set the paging properties of the provider. The default is to fetch page zero, of one thousand (1000) rows. A more reasonable page size is probably around 100. Note that the query processing strategy may change for very large pages (more than 1000) and give significantly longer response times. Performance is improved by setting the page size low, as long as you don't set it lower than what you realistically expect to need (fetching multiple pages is more expensive than fetching one).
Declaration
public void SetPagingInfo(int pageSize, int pageNumber)Parameters
| Type | Name | Description |
|---|---|---|
| int | pageSize | Desired page size |
| int | pageNumber | Desired page number to return |
SetRestriction(params ArchiveRestrictionInfo[])
Set restrictions used to fetch desired columns/entities.
Declaration
public bool SetRestriction(params ArchiveRestrictionInfo[] restrictions)Parameters
| Type | Name | Description |
|---|---|---|
| ArchiveRestrictionInfo[] | restrictions |
Returns
| Type | Description |
|---|---|
| bool |