Five New Optimizely Certifications are Here! Validate your expertise and advance your career with our latest certification exams. Click here to find out more

AI OnAI Off

Class SearchManager

Inheritance
System.Object
SearchManager
Namespace: Mediachase.Search
Assembly: Mediachase.Search.dll
Version: 14.26.0
Syntax
public class SearchManager : Object

Constructors

SearchManager(String, IOptions<SearchOptions>, IServiceProvider, IndexBuilder)

Initializes a new instance of the SearchManager class.

Declaration
public SearchManager(string applicationName, IOptions<SearchOptions> searchOptions, IServiceProvider serviceProvider, IndexBuilder indexBuilder)
Parameters
Type Name Description
System.String applicationName

The name of the application associated with this search manager.
Microsoft.Extensions.Options.IOptions<SearchOptions> searchOptions

The search options.
System.IServiceProvider serviceProvider

The service provider.
IndexBuilder indexBuilder

The index builder.

Methods

add_SearchIndexMessage(SearchIndexHandler)

Declaration
public void add_SearchIndexMessage(SearchIndexHandler value)
Parameters
Type Name Description
SearchIndexHandler value

add_SearchMessage(SearchMessageHandler)

Declaration
public void add_SearchMessage(SearchMessageHandler value)
Parameters
Type Name Description
SearchMessageHandler value

BuildIndex(Boolean)

Updates the index with either an incremental or full build.

Declaration
public void BuildIndex(bool rebuild)
Parameters
Type Name Description
System.Boolean rebuild

If true, rebuilds the entire index; otherwise, incrementally updates the index.

GetIndexBuilders()

Returns an array containing the configured index builders.

Declaration
public IndexBuilder[] GetIndexBuilders()
Returns
Type Description
IndexBuilder[]
Remarks

The IndexBuilder class does not actually build indexes. It exposes some search functionality, and manages the index status file. These classes should not be used directly.

OnSearchIndexMessage(Object, SearchIndexEventArgs)

Declaration
protected virtual void OnSearchIndexMessage(object source, SearchIndexEventArgs args)
Parameters
Type Name Description
System.Object source
SearchIndexEventArgs args

OnSearchMessage(Object, SearchEventArgs)

Declaration
protected virtual void OnSearchMessage(object source, SearchEventArgs args)
Parameters
Type Name Description
System.Object source
SearchEventArgs args

remove_SearchIndexMessage(SearchIndexHandler)

Declaration
public void remove_SearchIndexMessage(SearchIndexHandler value)
Parameters
Type Name Description
SearchIndexHandler value

remove_SearchMessage(SearchMessageHandler)

Declaration
public void remove_SearchMessage(SearchMessageHandler value)
Parameters
Type Name Description
SearchMessageHandler value

Search(ISearchCriteria)

Searches for the specified criteria.

Declaration
public ISearchResults Search(ISearchCriteria criteria)
Parameters
Type Name Description
ISearchCriteria criteria

The criteria.
Returns
Type Description
ISearchResults

UpdateIndex(IEnumerable<Int32>)

Updates the index for the specified items.

Declaration
public bool UpdateIndex(IEnumerable<int> itemIds)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Int32> itemIds
Returns
Type Description
System.Boolean

Events

SearchIndexMessage

Declaration
public event SearchIndexHandler SearchIndexMessage
Event Type
Type Description
SearchIndexHandler

SearchMessage

Declaration
public event SearchMessageHandler SearchMessage
Event Type
Type Description
SearchMessageHandler