View Source

Class HelpController

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

UmbracoAuthorizedJsonController

Namespace: Umbraco.Cms.Web.BackOffice.Controllers

Assembly: Umbraco.Web.BackOffice.dll

Syntax

[PluginController("UmbracoApi")]
public class HelpController : UmbracoAuthorizedJsonController, IUmbracoFeature, IDiscoverable

Constructors

HelpController(ILogger<HelpController>)

Declaration

public HelpController(ILogger<HelpController> logger)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger<HelpController>	logger

HelpController(ILogger<HelpController>, IOptionsMonitor<HelpPageSettings>)

Declaration

[ActivatorUtilitiesConstructor]
public HelpController(ILogger<HelpController> logger, IOptionsMonitor<HelpPageSettings> helpPageSettings)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger<HelpController>	logger
Microsoft.Extensions.Options.IOptionsMonitor<HelpPageSettings>	helpPageSettings

Methods

GetContextHelpForPage(String, String, String)

Declaration

public async Task<List<HelpPage>> GetContextHelpForPage(string section, string tree, string baseUrl = "https://our.umbraco.com")

Parameters

Type	Name	Description
System.String	section
System.String	tree
System.String	baseUrl

Returns

Type	Description
Task<List<HelpPage>>