Show / Hide Table of Contents

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".

Inheritance
object
AnyTableListProviderBase
PhoneSearchProvider
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("phonesearch")]
[MDOAdditionalInfo("Person only search", "P")]
[MDOAdditionalInfo("Company only search", "C")]
public class PhoneSearchProvider : AnyTableListProviderBase, ISoListProvider, ISoList
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"

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 _contactTable
Field 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 _personContactTable
Field 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 _personTable
Field 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 _phoneTable
Field 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
AnyTableListProviderBase.TableInfo
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
AnyTableListProviderBase.GetMainQueryAsync(CancellationToken)
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
AnyTableListProviderBase.InitAsync(CancellationToken)
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
AnyTableListProviderBase.OnRead(SoDataReader, short)
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
AnyTableListProviderBase.SetSearchRestrictionAsync(Select, 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"

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