Interface IUmbracoIndex
A Marker interface for defining an Umbraco indexer
Namespace: Umbraco.Cms.Infrastructure.Examine
Assembly: Umbraco.Infrastructure.dll
Syntax
public interface IUmbracoIndex : IIndex, IIndexStatsProperties
View SourceEnableDefaultEventHandler
When set to true Umbraco will keep the index in sync with Umbraco data automatically
Declaration
bool EnableDefaultEventHandler { get; }Property Value
| Type | Description |
|---|---|
| bool |
PublishedValuesOnly
When set to true the index will only retain published values
Declaration
bool PublishedValuesOnly { get; }Property Value
| Type | Description |
|---|---|
| bool |
Remarks
Any non-published values will not be put or kept in the index:
- Deleted, Trashed, non-published Content items
- non-published Variants
SupportProtectedContent
Whether the index can contain protected content
Declaration
bool SupportProtectedContent { get; }Property Value
| Type | Description |
|---|---|
| bool |
Remarks
To retain backwards compatability, the default value is true
UniqueKeyFieldName
The name of the index field that contains the unique entity key (GUID). Used by the backoffice Examine dashboard to construct edit links for search results.
Declaration
string UniqueKeyFieldName { get; }Property Value
| Type | Description |
|---|---|
| string |