View Source

Class RedirectUrlManagementController

Inheritance

System.Object

Microsoft.AspNetCore.Mvc.ControllerBase

UmbracoApiControllerBase

UmbracoApiController

UmbracoAuthorizedApiController

Namespace: Umbraco.Cms.Web.BackOffice.Controllers

Assembly: Umbraco.Web.BackOffice.dll

Syntax

[PluginController("UmbracoApi")]
[Authorize(Policy = "SectionAccessContent")]
public class RedirectUrlManagementController : UmbracoAuthorizedApiController, IUmbracoFeature, IDiscoverable

Constructors

View Source

RedirectUrlManagementController(ILogger<RedirectUrlManagementController>, IOptionsMonitor<WebRoutingSettings>, IBackOfficeSecurityAccessor, IRedirectUrlService, IUmbracoMapper, IConfigManipulator)

Declaration

public RedirectUrlManagementController(ILogger<RedirectUrlManagementController> logger, IOptionsMonitor<WebRoutingSettings> webRoutingSettings, IBackOfficeSecurityAccessor backofficeSecurityAccessor, IRedirectUrlService redirectUrlService, IUmbracoMapper umbracoMapper, IConfigManipulator configManipulator)

Parameters

Type	Name	Description
Microsoft.Extensions.Logging.ILogger<RedirectUrlManagementController>	logger
Microsoft.Extensions.Options.IOptionsMonitor<WebRoutingSettings>	webRoutingSettings
IBackOfficeSecurityAccessor	backofficeSecurityAccessor
IRedirectUrlService	redirectUrlService
IUmbracoMapper	umbracoMapper
IConfigManipulator	configManipulator

Methods

View Source

DeleteRedirectUrl(Guid)

Declaration

[HttpPost]
public IActionResult DeleteRedirectUrl(Guid id)

Parameters

Type	Name	Description
Guid	id

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

View Source

GetEnableState()

Returns true/false of whether redirect tracking is enabled or not

Declaration

[HttpGet]
public IActionResult GetEnableState()

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult

View Source

RedirectUrlsForContentItem(String)

This lists the RedirectUrls for a particular content item Do we need to consider paging here?

Declaration

[HttpGet]
public RedirectUrlSearchResult RedirectUrlsForContentItem(string contentUdi)

Parameters

Type	Name	Description
System.String	contentUdi	Udi of content item to retrieve RedirectUrls for

Returns

Type	Description
RedirectUrlSearchResult

View Source

SearchRedirectUrls(String, Int32, Int32)

Declaration

[HttpGet]
public RedirectUrlSearchResult SearchRedirectUrls(string searchTerm, int page = 0, int pageSize = 10)

Parameters

Type	Name	Description
System.String	searchTerm
System.Int32	page
System.Int32	pageSize

Returns

Type	Description
RedirectUrlSearchResult

View Source

ToggleUrlTracker(Boolean)

Declaration

[HttpPost]
public IActionResult ToggleUrlTracker(bool disable)

Parameters

Type	Name	Description
System.Boolean	disable

Returns

Type	Description
Microsoft.AspNetCore.Mvc.IActionResult