Class SearchProvidersManager

Search providers manager class.

Inheritance

System.Object

SearchProvidersManager

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Shell.Search

Assembly: EPiServer.Shell.dll

Version: 8.11.0

Syntax

public class SearchProvidersManager

Constructors

SearchProvidersManager(IEnumerable<ISearchProvider>, DynamicDataStoreFactory)

Initalizes a new instance of SearchProvidersManager.

Declaration

public SearchProvidersManager(IEnumerable<ISearchProvider> searchProviders, DynamicDataStoreFactory storeFactory)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ISearchProvider>	searchProviders	All available providers
DynamicDataStoreFactory	storeFactory	A repository used for the actual data reading and manipulation.

Properties

Store

The dynamic data store used in search provider manager.

Declaration

public DynamicDataStore Store { get; }

Property Value

Type	Description
DynamicDataStore

Methods

GetEnabledProvidersByPriority(String, Boolean)

Use this method to get the available providers prioritizing those in the specified search area.

Declaration

public IList<ISearchProvider> GetEnabledProvidersByPriority(string searchArea, bool filterOnArea)

Parameters

Type	Name	Description
System.String	searchArea	Area to search in
System.Boolean	filterOnArea

Returns

Type	Description
System.Collections.Generic.IList<ISearchProvider>	A list of search providers.

GetProviderPairs()

Gets the provider pairs.

Declaration

public IEnumerable<SearchProviderPair> GetProviderPairs()

Returns

Type	Description
System.Collections.Generic.IEnumerable<SearchProviderPair>

Reset()

Reset to default

Declaration

public void Reset()

Save(IEnumerable<SearchProviderSetting>)

Saves the changes to the Database in the given order

Declaration

public void Save(IEnumerable<SearchProviderSetting> settings)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<SearchProviderSetting>	settings

TryGetProvider(String, out ISearchProvider)

Tries to the get provider with the provided key (provider's type.FullName).

Declaration

public bool TryGetProvider(string providerFullName, out ISearchProvider provider)

Parameters

Type	Name	Description
System.String	providerFullName	The provider key.
ISearchProvider	provider	The provider.

Returns

Type	Description
System.Boolean