Class SearchManager
Inheritance
System.Object
SearchManager
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: Mediachase.Search
Assembly: Mediachase.Search.dll
Version: 10.8.0Syntax
public class SearchManager
Constructors
SearchManager(String)
Initializes a new instance of the SearchManager class.
Declaration
public SearchManager(string applicationName)
Parameters
Type | Name | Description |
---|---|---|
System.String | applicationName | The name of the application associated with this search manager. |
Properties
SyncObject
Declaration
[Obsolete("The search manager no longer exposes an external sync object. Will remain at least until November 2016.", true)]
public object SyncObject { get; }
Property Value
Type | Description |
---|---|
System.Object |
Methods
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 |
RaiseSearchEvent(Object, SearchEventArgs)
Declaration
[Obsolete("Use OnSearchMessage. External objects should not be able to raise events from this object. Will remain at least until November 2016.")]
public void RaiseSearchEvent(object source, SearchEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
System.Object | source | |
SearchEventArgs | args |
RaiseSearchIndexEvent(Object, SearchIndexEventArgs)
Declaration
[Obsolete("Use OnSearchIndexMessage. External objects should not be able to raise events from this object. Will remain at least until November 2016.")]
public void RaiseSearchIndexEvent(object source, SearchIndexEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
System.Object | source | |
SearchIndexEventArgs | args |
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 |