Class UmbracoTreeSearcher

Used for internal Umbraco implementations of ISearchableTree

Inheritance

System.Object

Namespace: Umbraco.Web.Search

Assembly: Umbraco.Web.dll

Syntax

public class UmbracoTreeSearcher

Constructors

View Source

UmbracoTreeSearcher(IExamineManager, UmbracoContext, ILocalizationService, IEntityService, UmbracoMapper, ISqlContext, IUmbracoTreeSearcherFields)

Declaration

[Obsolete("Use constructor specifying all dependencies instead")]
public UmbracoTreeSearcher(IExamineManager examineManager, UmbracoContext umbracoContext, ILocalizationService languageService, IEntityService entityService, UmbracoMapper mapper, ISqlContext sqlContext, IUmbracoTreeSearcherFields umbracoTreeSearcherFields)

Parameters

Type	Name	Description
IExamineManager	examineManager
UmbracoContext	umbracoContext
ILocalizationService	languageService
IEntityService	entityService
UmbracoMapper	mapper
ISqlContext	sqlContext
IUmbracoTreeSearcherFields	umbracoTreeSearcherFields

View Source

UmbracoTreeSearcher(IExamineManager, UmbracoContext, ILocalizationService, IEntityService, UmbracoMapper, ISqlContext, IUmbracoTreeSearcherFields, AppCaches)

Declaration

public UmbracoTreeSearcher(IExamineManager examineManager, UmbracoContext umbracoContext, ILocalizationService languageService, IEntityService entityService, UmbracoMapper mapper, ISqlContext sqlContext, IUmbracoTreeSearcherFields umbracoTreeSearcherFields, AppCaches appCaches)

Parameters

Type	Name	Description
IExamineManager	examineManager
UmbracoContext	umbracoContext
ILocalizationService	languageService
IEntityService	entityService
UmbracoMapper	mapper
ISqlContext	sqlContext
IUmbracoTreeSearcherFields	umbracoTreeSearcherFields
AppCaches	appCaches

Methods

View Source

EntitySearch(UmbracoObjectTypes, String, Int32, Int64, out Int64, String)

Searches with the IEntityService for results based on the entity type

Declaration

public IEnumerable<SearchResultEntity> EntitySearch(UmbracoObjectTypes objectType, string query, int pageSize, long pageIndex, out long totalFound, string searchFrom = null)

Parameters

Type	Name	Description
UmbracoObjectTypes	objectType
System.String	query
System.Int32	pageSize
System.Int64	pageIndex
System.Int64	totalFound
System.String	searchFrom

Returns

Type	Description
System.Collections.Generic.IEnumerable<SearchResultEntity>

View Source

ExamineSearch(String, UmbracoEntityTypes, Int32, Int64, out Int64, String, Boolean)

Searches Examine for results based on the entity type

Declaration

public IEnumerable<SearchResultEntity> ExamineSearch(string query, UmbracoEntityTypes entityType, int pageSize, long pageIndex, out long totalFound, string searchFrom = null, bool ignoreUserStartNodes = false)

Parameters

Type	Name	Description
System.String	query
UmbracoEntityTypes	entityType
System.Int32	pageSize
System.Int64	pageIndex
System.Int64	totalFound
System.String	searchFrom	A starting point for the search, generally a node id, but for members this is a member type alias
System.Boolean	ignoreUserStartNodes	If set to true, user and group start node permissions will be ignored.

Returns

Type	Description
System.Collections.Generic.IEnumerable<SearchResultEntity>

View Source

ExamineSearch(String, UmbracoEntityTypes, Int32, Int64, String, out Int64, String, Boolean)

Declaration

public IEnumerable<SearchResultEntity> ExamineSearch(string query, UmbracoEntityTypes entityType, int pageSize, long pageIndex, string culture, out long totalFound, string searchFrom = null, bool ignoreUserStartNodes = false)

Parameters

Type	Name	Description
System.String	query
UmbracoEntityTypes	entityType
System.Int32	pageSize
System.Int64	pageIndex
System.String	culture
System.Int64	totalFound
System.String	searchFrom
System.Boolean	ignoreUserStartNodes

Returns

Type	Description
System.Collections.Generic.IEnumerable<SearchResultEntity>