View Source

Class DashboardController

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

Namespace: Umbraco.Cms.Web.BackOffice.Controllers

Assembly: Umbraco.Web.BackOffice.dll

Syntax

[PluginController("UmbracoApi")]
[AngularJsonOnlyConfiguration]
[Authorize(Policy = "BackOfficeAccess")]
public class DashboardController : UmbracoApiController, IUmbracoFeature, IDiscoverable

Constructors

DashboardController(IBackOfficeSecurityAccessor, AppCaches, ILogger<DashboardController>, IDashboardService, IUmbracoVersion, IShortStringHelper, IOptionsSnapshot<ContentDashboardSettings>, ISiteIdentifierService)

Initializes a new instance of the DashboardController with all its dependencies.

Declaration

[ActivatorUtilitiesConstructor]
public DashboardController(IBackOfficeSecurityAccessor backOfficeSecurityAccessor, AppCaches appCaches, ILogger<DashboardController> logger, IDashboardService dashboardService, IUmbracoVersion umbracoVersion, IShortStringHelper shortStringHelper, IOptionsSnapshot<ContentDashboardSettings> dashboardSettings, ISiteIdentifierService siteIdentifierService)

Parameters

Type	Name	Description
IBackOfficeSecurityAccessor	backOfficeSecurityAccessor
AppCaches	appCaches
Microsoft.Extensions.Logging.ILogger<DashboardController>	logger
IDashboardService	dashboardService
IUmbracoVersion	umbracoVersion
IShortStringHelper	shortStringHelper
Microsoft.Extensions.Options.IOptionsSnapshot<ContentDashboardSettings>	dashboardSettings
ISiteIdentifierService	siteIdentifierService

Methods

GetDashboard(String)

Declaration

[ValidateAngularAntiForgeryToken]
public IEnumerable<Tab<IDashboardSlim>> GetDashboard(string section)

Parameters

Type	Name	Description
System.String	section

Returns

Type	Description
IEnumerable<Tab<IDashboardSlim>>

GetRemoteDashboardContent(String, String)

Declaration

[ValidateAngularAntiForgeryToken]
public async Task<JObject> GetRemoteDashboardContent(string section, string baseUrl)

Parameters

Type	Name	Description
System.String	section
System.String	baseUrl

Returns

Type	Description
Task<JObject>

GetRemoteDashboardCss(String, String)

Declaration

public async Task<IActionResult> GetRemoteDashboardCss(string section, string baseUrl)

Parameters

Type	Name	Description
System.String	section
System.String	baseUrl

Returns

Type	Description
Task<Microsoft.AspNetCore.Mvc.IActionResult>

GetRemoteXml(String, String)

Declaration

public async Task<IActionResult> GetRemoteXml(string site, string url)

Parameters

Type	Name	Description
System.String	site
System.String	url

Returns

Type	Description
Task<Microsoft.AspNetCore.Mvc.IActionResult>