Table of Contents

Class ServicesCollectionExtensions

Namespace
Examine
Assembly
Examine.dll

Extensions for IServiceCollection

public static class ServicesCollectionExtensions
Inheritance
ServicesCollectionExtensions
Inherited Members

Methods

AddExamine(IServiceCollection, DirectoryInfo?)

Adds the Examine core services

public static IServiceCollection AddExamine(this IServiceCollection services, DirectoryInfo? appRootDirectory = null)

Parameters

services IServiceCollection
appRootDirectory DirectoryInfo

Returns

IServiceCollection

AddExamineLuceneIndex(IServiceCollection, string, FieldDefinitionCollection?, Analyzer?, IValueSetValidator?, IReadOnlyDictionary<string, IFieldValueTypeFactory>?)

Registers a file system based Lucene Examine index

[Obsolete("Use the overload accepting Action<LuceneDirectoryIndexOptions> instead.")]
public static IServiceCollection AddExamineLuceneIndex(this IServiceCollection serviceCollection, string name, FieldDefinitionCollection? fieldDefinitions, Analyzer? analyzer, IValueSetValidator? validator, IReadOnlyDictionary<string, IFieldValueTypeFactory>? indexValueTypesFactory)

Parameters

serviceCollection IServiceCollection
name string
fieldDefinitions FieldDefinitionCollection
analyzer Analyzer
validator IValueSetValidator
indexValueTypesFactory IReadOnlyDictionary<string, IFieldValueTypeFactory>

Returns

IServiceCollection

AddExamineLuceneIndex(IServiceCollection, string, Action<LuceneDirectoryIndexOptions>?)

Registers a file system based Lucene Examine index

public static IServiceCollection AddExamineLuceneIndex(this IServiceCollection serviceCollection, string name, Action<LuceneDirectoryIndexOptions>? configuration = null)

Parameters

serviceCollection IServiceCollection
name string
configuration Action<LuceneDirectoryIndexOptions>

Returns

IServiceCollection

AddExamineLuceneIndex<TIndex>(IServiceCollection, string, FieldDefinitionCollection?, Analyzer?, IValueSetValidator?, IReadOnlyDictionary<string, IFieldValueTypeFactory>?)

Registers a file system based Lucene Examine index

[Obsolete("Use the overload accepting Action<LuceneDirectoryIndexOptions> instead.")]
public static IServiceCollection AddExamineLuceneIndex<TIndex>(this IServiceCollection serviceCollection, string name, FieldDefinitionCollection? fieldDefinitions, Analyzer? analyzer, IValueSetValidator? validator, IReadOnlyDictionary<string, IFieldValueTypeFactory>? indexValueTypesFactory) where TIndex : LuceneIndex

Parameters

serviceCollection IServiceCollection
name string
fieldDefinitions FieldDefinitionCollection
analyzer Analyzer
validator IValueSetValidator
indexValueTypesFactory IReadOnlyDictionary<string, IFieldValueTypeFactory>

Returns

IServiceCollection

Type Parameters

TIndex

AddExamineLuceneIndex<TIndex>(IServiceCollection, string, Action<LuceneDirectoryIndexOptions>?)

Registers a file system based Lucene Examine index

public static IServiceCollection AddExamineLuceneIndex<TIndex>(this IServiceCollection serviceCollection, string name, Action<LuceneDirectoryIndexOptions>? configuration = null) where TIndex : LuceneIndex

Parameters

serviceCollection IServiceCollection
name string
configuration Action<LuceneDirectoryIndexOptions>

Returns

IServiceCollection

Type Parameters

TIndex

AddExamineLuceneIndex<TIndex, TDirectoryFactory>(IServiceCollection, string, FieldDefinitionCollection?, Analyzer?, IValueSetValidator?, IReadOnlyDictionary<string, IFieldValueTypeFactory>?)

Registers an Examine index

[Obsolete("Use the overload accepting Action<LuceneDirectoryIndexOptions> instead.")]
public static IServiceCollection AddExamineLuceneIndex<TIndex, TDirectoryFactory>(this IServiceCollection serviceCollection, string name, FieldDefinitionCollection? fieldDefinitions, Analyzer? analyzer, IValueSetValidator? validator, IReadOnlyDictionary<string, IFieldValueTypeFactory>? indexValueTypesFactory) where TIndex : LuceneIndex where TDirectoryFactory : class, IDirectoryFactory

Parameters

serviceCollection IServiceCollection
name string
fieldDefinitions FieldDefinitionCollection
analyzer Analyzer
validator IValueSetValidator
indexValueTypesFactory IReadOnlyDictionary<string, IFieldValueTypeFactory>

Returns

IServiceCollection

Type Parameters

TIndex
TDirectoryFactory

AddExamineLuceneIndex<TIndex, TDirectoryFactory>(IServiceCollection, string, Action<LuceneDirectoryIndexOptions>?)

Registers an Examine index

public static IServiceCollection AddExamineLuceneIndex<TIndex, TDirectoryFactory>(this IServiceCollection serviceCollection, string name, Action<LuceneDirectoryIndexOptions>? configuration = null) where TIndex : LuceneIndex where TDirectoryFactory : class, IDirectoryFactory

Parameters

serviceCollection IServiceCollection
name string
configuration Action<LuceneDirectoryIndexOptions>

Returns

IServiceCollection

Type Parameters

TIndex
TDirectoryFactory

AddExamineLuceneMultiSearcher(IServiceCollection, string, string[], Analyzer?)

Registers a Lucene multi index searcher

[Obsolete("Use the overload accepting Action<LuceneMultiSearcherOptions> instead.")]
public static IServiceCollection AddExamineLuceneMultiSearcher(this IServiceCollection serviceCollection, string name, string[] indexNames, Analyzer? analyzer)

Parameters

serviceCollection IServiceCollection
name string
indexNames string[]
analyzer Analyzer

Returns

IServiceCollection

AddExamineLuceneMultiSearcher(IServiceCollection, string, string[], Action<LuceneMultiSearcherOptions>?)

Registers a Lucene multi index searcher

public static IServiceCollection AddExamineLuceneMultiSearcher(this IServiceCollection serviceCollection, string name, string[] indexNames, Action<LuceneMultiSearcherOptions>? configuration = null)

Parameters

serviceCollection IServiceCollection
name string
indexNames string[]
configuration Action<LuceneMultiSearcherOptions>

Returns

IServiceCollection

AddExamineSearcher<TSearcher>(IServiceCollection, string, Func<IServiceProvider, IList<object>>)

Registers a standalone Examine searcher

[Obsolete("Use AddExamineLuceneMultiSearcher or register ISearcher directly.")]
public static IServiceCollection AddExamineSearcher<TSearcher>(this IServiceCollection serviceCollection, string name, Func<IServiceProvider, IList<object>> parameterFactory) where TSearcher : ISearcher

Parameters

serviceCollection IServiceCollection
name string
parameterFactory Func<IServiceProvider, IList<object>>

Returns

IServiceCollection

Type Parameters

TSearcher