View Source

Class ExamineManagementController

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

Namespace: Umbraco.Cms.Web.BackOffice.Controllers

Assembly: Umbraco.Web.BackOffice.dll

Syntax

[Authorize(Policy = "SectionAccessSettings")]
public class ExamineManagementController : UmbracoAuthorizedJsonController

Constructors

ExamineManagementController(IExamineManager, ILogger<ExamineManagementController>, IIndexDiagnosticsFactory, AppCaches, IIndexRebuilder)

Declaration

public ExamineManagementController(IExamineManager examineManager, ILogger<ExamineManagementController> logger, IIndexDiagnosticsFactory indexDiagnosticsFactory, AppCaches appCaches, IIndexRebuilder indexRebuilder)

Parameters

Type	Name	Description
IExamineManager	examineManager
Microsoft.Extensions.Logging.ILogger<ExamineManagementController>	logger
IIndexDiagnosticsFactory	indexDiagnosticsFactory
AppCaches	appCaches
IIndexRebuilder	indexRebuilder

Methods

GetIndexerDetails()

Get the details for indexers

Declaration

public IEnumerable<ExamineIndexModel> GetIndexerDetails()

Returns

Type	Description
IEnumerable<ExamineIndexModel>

GetSearcherDetails()

Get the details for searchers

Declaration

public IEnumerable<ExamineSearcherModel> GetSearcherDetails()

Returns

Type	Description
IEnumerable<ExamineSearcherModel>

GetSearchResults(String, String, Int32, Int32)

Declaration

public ActionResult<SearchResults> GetSearchResults(string searcherName, string query, int pageIndex = 0, int pageSize = 20)

Parameters

Type	Name	Description
System.String	searcherName
System.String	query
System.Int32	pageIndex
System.Int32	pageSize

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<SearchResults>

PostCheckRebuildIndex(String)

Check if the index has been rebuilt

Declaration

public ActionResult<ExamineIndexModel?> PostCheckRebuildIndex(string indexName)

Parameters

Type	Name	Description
System.String	indexName

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<System.Nullable<ExamineIndexModel>>

Remarks

This is kind of rudimentary since there's no way we can know that the index has rebuilt, we have a listener for the index op complete so we'll just check if that key is no longer there in the runtime cache

PostRebuildIndex(String)

Rebuilds the index

Declaration

public IActionResult PostRebuildIndex(string indexName)

Parameters

Type	Name	Description
System.String	indexName

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult