View Source

Class DeliveryApiContentIndex

Inheritance

object

UmbracoExamineIndex

Namespace: Umbraco.Cms.Infrastructure.Examine

Assembly: Umbraco.Examine.Lucene.dll

Syntax

public class DeliveryApiContentIndex : UmbracoExamineIndex, IUmbracoIndex, IIndex, IIndexDiagnostics, IIndexStats

Constructors

DeliveryApiContentIndex(ILoggerFactory, string, IOptionsMonitor<LuceneDirectoryIndexOptions>, IHostingEnvironment, IRuntimeState, IDeliveryApiCompositeIdHandler)

Declaration

public DeliveryApiContentIndex(ILoggerFactory loggerFactory, string name, IOptionsMonitor<LuceneDirectoryIndexOptions> indexOptions, IHostingEnvironment hostingEnvironment, IRuntimeState runtimeState, IDeliveryApiCompositeIdHandler deliveryApiCompositeIdHandler)

Parameters

Type	Name	Description
ILoggerFactory	loggerFactory
string	name
IOptionsMonitor<LuceneDirectoryIndexOptions>	indexOptions
IHostingEnvironment	hostingEnvironment
IRuntimeState	runtimeState
IDeliveryApiCompositeIdHandler	deliveryApiCompositeIdHandler

Properties

ApplySpecialValueTransformations

Performs special __Path and __Icon value transformations to all deriving indexes when set to true.

Declaration

protected override bool ApplySpecialValueTransformations { get; }

Property Value

Type	Description
bool

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

public override string UniqueKeyFieldName { get; }

Property Value

Type	Description
string

Methods

PerformDeleteFromIndex(IEnumerable<string>, Action<IndexOperationEventArgs>?)

override to check if we can actually initialize.

Declaration

protected override void PerformDeleteFromIndex(IEnumerable<string> itemIds, Action<IndexOperationEventArgs>? onComplete)

Parameters

Type	Name	Description
IEnumerable<string>	itemIds	ID of the node to delete
Action<IndexOperationEventArgs>	onComplete

Remarks

This check is required since the base examine lib will try to rebuild on startup