Class PhoneSearchProvider
Search phone numbers for matching stripped numbers, across person and contacts. Return company name + department, or person name. Use AdditionInfo to restrict search to just Person or Contact phone numbers using "P" or "C".
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("phonesearch")]
[MDOAdditionalInfo("Person only search", "P")]
[MDOAdditionalInfo("Company only search", "C")]
public class PhoneSearchProvider : AnyTableListProviderBase, ISoListProvider, ISoListRemarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"Constructors
PhoneSearchProvider()
Constructor
Declaration
public PhoneSearchProvider()Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"Fields
ProviderName
Search phone numbers for matching stripped numbers, across person and contacts. Return company name + department, or person name. Use AdditionInfo to restrict search to just Person or Contact phone numbers using "P" or "C".
Declaration
public const string ProviderName = "phonesearch"Field Value
| Type | Description |
|---|---|
| string |
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"_contactTable
Search phone numbers for matching stripped numbers, across person and contacts. Return company name + department, or person name. Use AdditionInfo to restrict search to just Person or Contact phone numbers using "P" or "C".
Declaration
protected ContactTableInfo _contactTableField Value
| Type | Description |
|---|---|
| ContactTableInfo |
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"_personContactTable
Search phone numbers for matching stripped numbers, across person and contacts. Return company name + department, or person name. Use AdditionInfo to restrict search to just Person or Contact phone numbers using "P" or "C".
Declaration
protected ContactTableInfo _personContactTableField Value
| Type | Description |
|---|---|
| ContactTableInfo |
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"_personTable
Search phone numbers for matching stripped numbers, across person and contacts. Return company name + department, or person name. Use AdditionInfo to restrict search to just Person or Contact phone numbers using "P" or "C".
Declaration
protected PersonTableInfo _personTableField Value
| Type | Description |
|---|---|
| PersonTableInfo |
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"_phoneTable
Search phone numbers for matching stripped numbers, across person and contacts. Return company name + department, or person name. Use AdditionInfo to restrict search to just Person or Contact phone numbers using "P" or "C".
Declaration
protected PhoneTableInfo _phoneTableField Value
| Type | Description |
|---|---|
| PhoneTableInfo |
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"Properties
TableInfo
The main table info for the query.
Declaration
protected override TableInfo TableInfo { get; }Property Value
| Type | Description |
|---|---|
| TableInfo |
Overrides
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"Methods
GetMainQueryAsync(CancellationToken)
Obtain the main query for the Phone search
Declaration
protected override Task<Select> GetMainQueryAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<Select> | Query for the Phone |
Overrides
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"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
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"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
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"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
Remarks
Returns: list item with
id = person or contact id Name = company name + phone number or person name + company name + phone number ExtraInfo + Tooltip = GSM formatted phone number (with country prefix) Full Name = person name or company name Type = "Person" or "Contact" IconHint = "Person" or "Contact"