Interface IIndexedEntitySearchService
Performs entity search against search indexes.
Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IIndexedEntitySearchServiceRemarks
Note that this service only supports entity types that are included in search indexes. By default this means documents, media and members.
Methods
View SourceSearchAsync(UmbracoObjectTypes, string, Guid?, IEnumerable<Guid>?, bool?, string?, int, int, bool)
Searches for entities using the search index with support for filtering and pagination.
Declaration
Task<PagedModel<IEntitySlim>> SearchAsync(UmbracoObjectTypes objectType, string query, Guid? parentId, IEnumerable<Guid>? contentTypeIds, bool? trashed, string? culture = null, int skip = 0, int take = 100, bool ignoreUserStartNodes = false)Parameters
| Type | Name | Description |
|---|---|---|
| UmbracoObjectTypes | objectType | The type of entities to search for. |
| string | query | The search query string. |
| Guid? | parentId | Optional parent ID to restrict the search to descendants of a specific node. |
| IEnumerable<Guid> | contentTypeIds | Optional collection of content type IDs to filter results by. |
| bool? | trashed | Optional filter for trashed state. If null, all items are included. |
| string | culture | Optional culture code to filter results by language variant. |
| int | skip | The number of results to skip for pagination. |
| int | take | The maximum number of results to return. |
| bool | ignoreUserStartNodes | If true, ignores user start node restrictions when searching. |
Returns
| Type | Description |
|---|---|
| Task<PagedModel<IEntitySlim>> | A paged model containing the matching entities. |