Show / Hide Table of Contents

Class PersonEmailAddressProvider

List of e-mail addresses matching the search value, possibly restricted to a given company or person.

Inheritance
object
AnyTableListProviderBase
PersonEmailAddressProvider
Implements
ISoListProvider
ISoList
Inherited Members
AnyTableListProviderBase._historyListSize
AnyTableListProviderBase.ConstructAsync(string, string, int[], bool, string, bool, CancellationToken)
AnyTableListProviderBase.GetHistoryItemsAsync(CancellationToken)
AnyTableListProviderBase.ClearHistoryItems()
AnyTableListProviderBase.GetRootItemsAsync(CancellationToken)
AnyTableListProviderBase.GetHeadingItemsAsync(CancellationToken)
AnyTableListProviderBase.GetHistoryItemsFromDbAsync(CancellationToken)
AnyTableListProviderBase.GetRootItemsAsync()
AnyTableListProviderBase.OnPreGetRootItemsAsync(List<ISoListItem>)
AnyTableListProviderBase.OnPostGetRootItemsAsync(List<ISoListItem>)
AnyTableListProviderBase.SetHistoryRestriction(Select)
AnyTableListProviderBase.SetHistoryListSizeFromPreference()
AnyTableListProviderBase.ExecuteQueryAsync(Select, List<ISoListItem>, CancellationToken)
AnyTableListProviderBase.ExecuteReaderAsync(SoCommand, CancellationToken)
AnyTableListProviderBase.ListName
AnyTableListProviderBase.AdditionalInfo
AnyTableListProviderBase.HistoryIDs
AnyTableListProviderBase.OnlyReadHistory
AnyTableListProviderBase.ExcludeHistory
AnyTableListProviderBase.SearchValue
AnyTableListProviderBase.ForceFlatList
AnyTableListProviderBase.HistoryInfo
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("personemailaddress")]
[MDOAdditionalInfoSeparator("&")]
[MDOAdditionalInfo("itemId", "Person id", 23)]
[MDOAdditionalInfo("extraId", "Company id", 23)]
public class PersonEmailAddressProvider : AnyTableListProviderBase, ISoListProvider, ISoList
Remarks

AdditionalInfo: itemId= person id extraId= contact-id

Constructors

PersonEmailAddressProvider()

Constructor

Declaration
public PersonEmailAddressProvider()
Remarks

AdditionalInfo: itemId= person id extraId= contact-id

Fields

ProviderName

List of e-mail addresses matching the search value, possibly restricted to a given company or person.

Declaration
public const string ProviderName = "personemailaddress"
Field Value
Type Description
string
Remarks

AdditionalInfo: itemId= person id extraId= contact-id

_emailTableInfo

List of e-mail addresses matching the search value, possibly restricted to a given company or person.

Declaration
protected EmailTableInfo _emailTableInfo
Field Value
Type Description
EmailTableInfo
Remarks

AdditionalInfo: itemId= person id extraId= contact-id

Properties

TableInfo

The main table info for the query.

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

AdditionalInfo: itemId= person id extraId= contact-id

Methods

GetMainQueryAsync(CancellationToken)

Obtain the main query for the Document

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

Query for the Document

Overrides
AnyTableListProviderBase.GetMainQueryAsync(CancellationToken)
Remarks

AdditionalInfo: itemId= person id extraId= contact-id

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
AnyTableListProviderBase.InitAsync(CancellationToken)
Remarks

AdditionalInfo: itemId= person id extraId= contact-id

OnRead(SoDataReader, short)

Raised every time a new row has been read from the database.
The implementation should read tthe 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
AnyTableListProviderBase.OnRead(SoDataReader, short)
Remarks

AdditionalInfo: itemId= person id extraId= contact-id

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
AnyTableListProviderBase.SetSearchRestrictionAsync(Select, string)
Remarks

AdditionalInfo: itemId= person id extraId= contact-id

Implements

ISoListProvider
ISoList

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top