Class IndexPopulator
Provides functionality to populate and manage Examine indexes with data in Umbraco.
Inheritance
object
Namespace: Umbraco.Cms.Infrastructure.Examine
Assembly: Umbraco.Infrastructure.dll
Syntax
public abstract class IndexPopulator : IIndexPopulatorConstructors
View SourceIndexPopulator()
Declaration
protected IndexPopulator()Methods
View SourceIsRegistered(IIndex)
Determines whether the specified index is registered.
Declaration
public virtual bool IsRegistered(IIndex index)Parameters
| Type | Name | Description |
|---|---|---|
| IIndex | index | The index to check for registration. |
Returns
| Type | Description |
|---|---|
| bool | True if the index is registered; otherwise, false. |
Populate(params IIndex[])
Populates the specified indexes by initializing or updating their contents as required. Only indexes that are registered will be populated.
Declaration
public void Populate(params IIndex[] indexes)Parameters
| Type | Name | Description |
|---|---|---|
| IIndex[] | indexes | The indexes to populate. |
PopulateIndexes(IReadOnlyList<IIndex>)
Declaration
protected abstract void PopulateIndexes(IReadOnlyList<IIndex> indexes)Parameters
| Type | Name | Description |
|---|---|---|
| IReadOnlyList<IIndex> | indexes |
RegisterIndex(string)
Registers an index for this populator
Declaration
public void RegisterIndex(string indexName)Parameters
| Type | Name | Description |
|---|---|---|
| string | indexName |