View Source

Class MediaIndexPopulator

Performs the data lookups required to rebuild a media index

Inheritance

object

IndexPopulator

IndexPopulator<IUmbracoContentIndex>

Namespace: Umbraco.Cms.Infrastructure.Examine

Assembly: Umbraco.Infrastructure.dll

Syntax

public class MediaIndexPopulator : IndexPopulator<IUmbracoContentIndex>, IIndexPopulator

Constructors

MediaIndexPopulator(ILogger<MediaIndexPopulator>, int?, IMediaService, IValueSetBuilder<IMedia>)

Initializes a new instance of the MediaIndexPopulator class, which is responsible for populating the media index in Examine.

Declaration

[Obsolete("Please use the non-obsolete constructor. Scheduled for removal in Umbraco 19.")]
public MediaIndexPopulator(ILogger<MediaIndexPopulator> logger, int? parentId, IMediaService mediaService, IValueSetBuilder<IMedia> mediaValueSetBuilder)

Parameters

Type	Name	Description
ILogger<MediaIndexPopulator>	logger	The logger used for logging operations within the populator.
int?	parentId	An optional parent ID to filter which media items are indexed. If null, all media items are considered.
IMediaService	mediaService	The service used to access and manage media data.
IValueSetBuilder<IMedia>	mediaValueSetBuilder	The builder used to create value sets for media items to be indexed.

MediaIndexPopulator(ILogger<MediaIndexPopulator>, int?, IMediaService, IValueSetBuilder<IMedia>, IOptionsMonitor<IndexingSettings>)

Initializes a new instance of the MediaIndexPopulator class, allowing specification of custom query parameters for media indexing.

Declaration

public MediaIndexPopulator(ILogger<MediaIndexPopulator> logger, int? parentId, IMediaService mediaService, IValueSetBuilder<IMedia> mediaValueSetBuilder, IOptionsMonitor<IndexingSettings> indexingSettings)

Parameters

Type	Name	Description
ILogger<MediaIndexPopulator>	logger	The logger used for logging operations within the media index populator.
int?	parentId	An optional parent media item ID to filter which media items are indexed.
IMediaService	mediaService	The service used to access and manage media items.
IValueSetBuilder<IMedia>	mediaValueSetBuilder	Builds value sets for media items to be indexed.
IOptionsMonitor<IndexingSettings>	indexingSettings	Monitors configuration settings related to indexing.

MediaIndexPopulator(ILogger<MediaIndexPopulator>, IMediaService, IValueSetBuilder<IMedia>)

Initializes a new instance of the MediaIndexPopulator class, which is responsible for populating the media index in Examine.

Declaration

[Obsolete("Please use the non-obsolete constructor. Scheduled for removal in Umbraco 19.")]
public MediaIndexPopulator(ILogger<MediaIndexPopulator> logger, IMediaService mediaService, IValueSetBuilder<IMedia> mediaValueSetBuilder)

Parameters

Type	Name	Description
ILogger<MediaIndexPopulator>	logger	The logger used to record diagnostic and operational information for the media index population process.
IMediaService	mediaService	The service used to access and manage media items in Umbraco.
IValueSetBuilder<IMedia>	mediaValueSetBuilder	The builder that constructs value sets from media items for indexing.

MediaIndexPopulator(ILogger<MediaIndexPopulator>, IMediaService, IValueSetBuilder<IMedia>, IOptionsMonitor<IndexingSettings>)

Initializes a new instance of the MediaIndexPopulator class, used to index all media content data.

Declaration

public MediaIndexPopulator(ILogger<MediaIndexPopulator> logger, IMediaService mediaService, IValueSetBuilder<IMedia> mediaValueSetBuilder, IOptionsMonitor<IndexingSettings> indexingSettings)

Parameters

Type	Name	Description
ILogger<MediaIndexPopulator>	logger	The logger instance used for logging operations.
IMediaService	mediaService	The media service used to access media items.
IValueSetBuilder<IMedia>	mediaValueSetBuilder	The value set builder for constructing indexable values from media items.
IOptionsMonitor<IndexingSettings>	indexingSettings	The indexing settings configuration.

Methods

PopulateIndexes(IReadOnlyList<IIndex>)

Declaration

protected override void PopulateIndexes(IReadOnlyList<IIndex> indexes)

Parameters

Type	Name	Description
IReadOnlyList<IIndex>	indexes