View Source

Class ModelsBuilderDashboardController

API controller for use in the Umbraco back office with Angular resources

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

Namespace: Umbraco.Cms.Web.BackOffice.ModelsBuilder

Assembly: Umbraco.Web.BackOffice.dll

Syntax

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

Remarks

We've created a different controller for the backoffice/angular specifically this is to ensure that the correct CSRF security is adhered to for angular and it also ensures that this controller is not subseptipal to global WebApi formatters being changed since this is always forced to only return Angular JSON Specific formats.

Constructors

ModelsBuilderDashboardController(IOptions<ModelsBuilderSettings>, IModelsGenerator, OutOfDateModelsStatus, ModelsGenerationError)

Declaration

[ActivatorUtilitiesConstructor]
public ModelsBuilderDashboardController(IOptions<ModelsBuilderSettings> config, IModelsGenerator modelsGenerator, OutOfDateModelsStatus outOfDateModels, ModelsGenerationError mbErrors)

Parameters

Type	Name	Description
Microsoft.Extensions.Options.IOptions<ModelsBuilderSettings>	config
IModelsGenerator	modelsGenerator
OutOfDateModelsStatus	outOfDateModels
ModelsGenerationError	mbErrors

ModelsBuilderDashboardController(IOptions<ModelsBuilderSettings>, ModelsGenerator, IModelsGenerator, OutOfDateModelsStatus, ModelsGenerationError)

Declaration

[Browsable(false)]
public ModelsBuilderDashboardController(IOptions<ModelsBuilderSettings> config, ModelsGenerator concreteModelGenerator, IModelsGenerator modelsGenerator, OutOfDateModelsStatus outOfDateModels, ModelsGenerationError mbErrors)

Parameters

Type	Name	Description
Microsoft.Extensions.Options.IOptions<ModelsBuilderSettings>	config
ModelsGenerator	concreteModelGenerator
IModelsGenerator	modelsGenerator
OutOfDateModelsStatus	outOfDateModels
ModelsGenerationError	mbErrors

ModelsBuilderDashboardController(IOptions<ModelsBuilderSettings>, ModelsGenerator, OutOfDateModelsStatus, ModelsGenerationError)

Declaration

[Browsable(false)]
public ModelsBuilderDashboardController(IOptions<ModelsBuilderSettings> config, ModelsGenerator modelsGenerator, OutOfDateModelsStatus outOfDateModels, ModelsGenerationError mbErrors)

Parameters

Type	Name	Description
Microsoft.Extensions.Options.IOptions<ModelsBuilderSettings>	config
ModelsGenerator	modelsGenerator
OutOfDateModelsStatus	outOfDateModels
ModelsGenerationError	mbErrors

Methods

BuildModels()

Declaration

[HttpPost]
public IActionResult BuildModels()

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

GetDashboard()

Declaration

[HttpGet]
public ActionResult<ModelsBuilderDashboardController.Dashboard> GetDashboard()

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<ModelsBuilderDashboardController.Dashboard>

GetModelsOutOfDateStatus()

Declaration

[HttpGet]
public ActionResult<ModelsBuilderDashboardController.OutOfDateStatus> GetModelsOutOfDateStatus()

Returns

Type	Description
Microsoft.AspNetCore.Mvc.ActionResult<ModelsBuilderDashboardController.OutOfDateStatus>