Table of Contents

Class ExamineManagementController

Namespace
Umbraco.Cms.Web.BackOffice.Controllers
Assembly
Umbraco.Web.BackOffice.dll
[Authorize(Policy = "SectionAccessSettings")]
public class ExamineManagementController : UmbracoAuthorizedJsonController
Inheritance
ExamineManagementController
Inherited Members

Constructors

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

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

Parameters

examineManager IExamineManager
logger ILogger<ExamineManagementController>
indexDiagnosticsFactory IIndexDiagnosticsFactory
appCaches AppCaches
indexRebuilder IIndexRebuilder

Methods

GetIndexerDetails()

Get the details for indexers

public IEnumerable<ExamineIndexModel> GetIndexerDetails()

Returns

IEnumerable<ExamineIndexModel>

GetSearchResults(string, string?, int, int) 

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

Parameters

searcherName string
query string
pageIndex int
pageSize int

Returns

ActionResult<SearchResults>

GetSearcherDetails()

Get the details for searchers

public IEnumerable<ExamineSearcherModel> GetSearcherDetails()

Returns

IEnumerable<ExamineSearcherModel>

PostCheckRebuildIndex(string)

Check if the index has been rebuilt

public ActionResult<ExamineIndexModel?> PostCheckRebuildIndex(string indexName)

Parameters

indexName string

Returns

ActionResult<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

public IActionResult PostRebuildIndex(string indexName)

Parameters

indexName string

Returns

IActionResult