Class BackOfficeExamineSearcher

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Examine

Assembly: Umbraco.Examine.Lucene.dll

Syntax

public class BackOfficeExamineSearcher : IBackOfficeExamineSearcher

Constructors

View Source

BackOfficeExamineSearcher(IExamineManager, ILanguageService, IBackOfficeSecurityAccessor, IEntityService, IUmbracoTreeSearcherFields, AppCaches)

Declaration

public BackOfficeExamineSearcher(IExamineManager examineManager, ILanguageService languageService, IBackOfficeSecurityAccessor backOfficeSecurityAccessor, IEntityService entityService, IUmbracoTreeSearcherFields treeSearcherFields, AppCaches appCaches)

Parameters

Type	Name	Description
IExamineManager	examineManager
ILanguageService	languageService
IBackOfficeSecurityAccessor	backOfficeSecurityAccessor
IEntityService	entityService
IUmbracoTreeSearcherFields	treeSearcherFields
AppCaches	appCaches

Methods

View Source

Search(string, UmbracoEntityTypes, int, long, out long, string[]?, bool?, string?, bool)

Searches the back office Examine index using the specified query and parameters.

Declaration

public IEnumerable<ISearchResult> Search(string query, UmbracoEntityTypes entityType, int pageSize, long pageIndex, out long totalFound, string[]? contentTypeAliases, bool? trashed, string? searchFrom = null, bool ignoreUserStartNodes = false)

Parameters

Type	Name	Description
string	query	The search query string.
UmbracoEntityTypes	entityType	The type of Umbraco entity to search for.
int	pageSize	The maximum number of results to return per page.
long	pageIndex	The zero-based index of the results page to return.
long	totalFound	When this method returns, contains the total number of results matching the query.
string[]	contentTypeAliases	An optional array of content type aliases to filter the search results; pass `null` to include all types.
bool?	trashed	Optional filter to include only trashed (`true`), only non-trashed (`false`), or all (`null`) items.
string	searchFrom	An optional starting point (node ID or path) for the search; pass `null` to search from the root.
bool	ignoreUserStartNodes	If `true`, ignores user start nodes when searching; otherwise, respects user permissions.

Returns

Type	Description
IEnumerable<ISearchResult>	An enumerable collection of Examine.ISearchResult objects matching the query and filters.

Remarks

default implementation to avoid breaking changes falls back to old behaviour