View Source

Class ApiContentRouteBuilder

Default implementation of IApiContentRouteBuilder that builds content routes for the Delivery API.

Inheritance

object

Namespace: Umbraco.Cms.Core.DeliveryApi

Assembly: Umbraco.Core.dll

Syntax

public sealed class ApiContentRouteBuilder : IApiContentRouteBuilder

Constructors

ApiContentRouteBuilder(IApiContentPathProvider, IOptions<GlobalSettings>, IVariationContextAccessor, IRequestPreviewService, IOptionsMonitor<RequestHandlerSettings>, IPublishedContentCache, IDocumentNavigationQueryService, IDocumentPublishStatusQueryService, IDocumentUrlService)

Declaration

public ApiContentRouteBuilder(IApiContentPathProvider apiContentPathProvider, IOptions<GlobalSettings> globalSettings, IVariationContextAccessor variationContextAccessor, IRequestPreviewService requestPreviewService, IOptionsMonitor<RequestHandlerSettings> requestSettings, IPublishedContentCache contentCache, IDocumentNavigationQueryService navigationQueryService, IDocumentPublishStatusQueryService publishStatusQueryService, IDocumentUrlService documentUrlService)

Parameters

Type	Name	Description
IApiContentPathProvider	apiContentPathProvider
IOptions<GlobalSettings>	globalSettings
IVariationContextAccessor	variationContextAccessor
IRequestPreviewService	requestPreviewService
IOptionsMonitor<RequestHandlerSettings>	requestSettings
IPublishedContentCache	contentCache
IDocumentNavigationQueryService	navigationQueryService
IDocumentPublishStatusQueryService	publishStatusQueryService
IDocumentUrlService	documentUrlService

ApiContentRouteBuilder(IApiContentPathProvider, IOptions<GlobalSettings>, IVariationContextAccessor, IRequestPreviewService, IOptionsMonitor<RequestHandlerSettings>, IPublishedContentCache, IDocumentNavigationQueryService, IPublishStatusQueryService, IDocumentUrlService)

Initializes a new instance of the ApiContentRouteBuilder class.

Declaration

[Obsolete("Please use the non-obsolete constructor instead. Scheduled for removal in Umbraco 19.")]
public ApiContentRouteBuilder(IApiContentPathProvider apiContentPathProvider, IOptions<GlobalSettings> globalSettings, IVariationContextAccessor variationContextAccessor, IRequestPreviewService requestPreviewService, IOptionsMonitor<RequestHandlerSettings> requestSettings, IPublishedContentCache contentCache, IDocumentNavigationQueryService navigationQueryService, IPublishStatusQueryService publishStatusQueryService, IDocumentUrlService documentUrlService)

Parameters

Type	Name	Description
IApiContentPathProvider	apiContentPathProvider	The API content path provider.
IOptions<GlobalSettings>	globalSettings	The global settings.
IVariationContextAccessor	variationContextAccessor	The variation context accessor.
IRequestPreviewService	requestPreviewService	The request preview service.
IOptionsMonitor<RequestHandlerSettings>	requestSettings	The request handler settings.
IPublishedContentCache	contentCache	The published content cache.
IDocumentNavigationQueryService	navigationQueryService	The document navigation query service.
IPublishStatusQueryService	publishStatusQueryService	The publish status query service.
IDocumentUrlService	documentUrlService	The document URL service.

ApiContentRouteBuilder(IApiContentPathProvider, IOptions<GlobalSettings>, IVariationContextAccessor, IRequestPreviewService, IOptionsMonitor<RequestHandlerSettings>, IPublishedContentCache, IDocumentNavigationQueryService, IPublishStatusQueryService, IDocumentPublishStatusQueryService, IDocumentUrlService)

Initializes a new instance of the ApiContentRouteBuilder class.

Declaration

[Obsolete("Please use the non-obsolete constructor instead. Scheduled for removal in Umbraco 19.")]
public ApiContentRouteBuilder(IApiContentPathProvider apiContentPathProvider, IOptions<GlobalSettings> globalSettings, IVariationContextAccessor variationContextAccessor, IRequestPreviewService requestPreviewService, IOptionsMonitor<RequestHandlerSettings> requestSettings, IPublishedContentCache contentCache, IDocumentNavigationQueryService navigationQueryService, IPublishStatusQueryService publishStatusQueryService, IDocumentPublishStatusQueryService documentPublishStatusQueryService, IDocumentUrlService documentUrlService)

Parameters

Type	Name	Description
IApiContentPathProvider	apiContentPathProvider	The API content path provider.
IOptions<GlobalSettings>	globalSettings	The global settings.
IVariationContextAccessor	variationContextAccessor	The variation context accessor.
IRequestPreviewService	requestPreviewService	The request preview service.
IOptionsMonitor<RequestHandlerSettings>	requestSettings	The request handler settings.
IPublishedContentCache	contentCache	The published content cache.
IDocumentNavigationQueryService	navigationQueryService	The document navigation query service.
IPublishStatusQueryService	publishStatusQueryService	The publish status query service.
IDocumentPublishStatusQueryService	documentPublishStatusQueryService
IDocumentUrlService	documentUrlService	The document URL service.

Methods

Build(IPublishedContent, string?)

Builds an IApiContentRoute instance from the specified published content.

Declaration

public IApiContentRoute? Build(IPublishedContent content, string? culture = null)

Parameters

Type	Name	Description
IPublishedContent	content	The published content to build from.
string	culture	The culture to use for the route, or null for the default culture.

Returns

Type	Description
IApiContentRoute	An IApiContentRoute instance, or null if the route cannot be built.