View Source

Class DocumentUrlService

Inheritance
System.Object
Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public class DocumentUrlService : IDocumentUrlService

Constructors

View Source

DocumentUrlService(ILogger<DocumentUrlService>, IDocumentUrlRepository, IDocumentRepository, ICoreScopeProvider, IOptions<GlobalSettings>, UrlSegmentProviderCollection, IContentService, IShortStringHelper, ILanguageService, IKeyValueService, IIdKeyMap, IDocumentNavigationQueryService, IPublishStatusQueryService, IDomainCacheService)

Declaration
public DocumentUrlService(ILogger<DocumentUrlService> logger, IDocumentUrlRepository documentUrlRepository, IDocumentRepository documentRepository, ICoreScopeProvider coreScopeProvider, IOptions<GlobalSettings> globalSettings, UrlSegmentProviderCollection urlSegmentProviderCollection, IContentService contentService, IShortStringHelper shortStringHelper, ILanguageService languageService, IKeyValueService keyValueService, IIdKeyMap idKeyMap, IDocumentNavigationQueryService documentNavigationQueryService, IPublishStatusQueryService publishStatusQueryService, IDomainCacheService domainCacheService)
Parameters
Type Name Description
ILogger<DocumentUrlService> logger
IDocumentUrlRepository documentUrlRepository
IDocumentRepository documentRepository
ICoreScopeProvider coreScopeProvider
IOptions<GlobalSettings> globalSettings
UrlSegmentProviderCollection urlSegmentProviderCollection
IContentService contentService
IShortStringHelper shortStringHelper
ILanguageService languageService
IKeyValueService keyValueService
IIdKeyMap idKeyMap
IDocumentNavigationQueryService documentNavigationQueryService
IPublishStatusQueryService publishStatusQueryService
IDomainCacheService domainCacheService

Methods

View Source

CreateOrUpdateUrlSegmentsAsync(Guid)

Declaration
public async Task CreateOrUpdateUrlSegmentsAsync(Guid key)
Parameters
Type Name Description
Guid key
Returns
Type Description
Task
View Source

CreateOrUpdateUrlSegmentsAsync(IEnumerable<IContent>)

Declaration
public async Task CreateOrUpdateUrlSegmentsAsync(IEnumerable<IContent> documentsEnumerable)
Parameters
Type Name Description
IEnumerable<IContent> documentsEnumerable
Returns
Type Description
Task
View Source

CreateOrUpdateUrlSegmentsWithDescendantsAsync(Guid)

Declaration
public async Task CreateOrUpdateUrlSegmentsWithDescendantsAsync(Guid key)
Parameters
Type Name Description
Guid key
Returns
Type Description
Task
View Source

DeleteUrlsFromCacheAsync(IEnumerable<Guid>)

Declaration
public async Task DeleteUrlsFromCacheAsync(IEnumerable<Guid> documentKeysEnumerable)
Parameters
Type Name Description
IEnumerable<Guid> documentKeysEnumerable
Returns
Type Description
Task
View Source

GetDocumentKeyByRoute(String, String, Nullable<Int32>, Boolean)

Declaration
public Guid? GetDocumentKeyByRoute(string route, string culture, int? documentStartNodeId, bool isDraft)
Parameters
Type Name Description
System.String route
System.String culture
System.Nullable<System.Int32> documentStartNodeId
System.Boolean isDraft
Returns
Type Description
System.Nullable<Guid>
View Source

GetLegacyRouteFormat(Guid, String, Boolean)

Declaration
public string GetLegacyRouteFormat(Guid documentKey, string culture, bool isDraft)
Parameters
Type Name Description
Guid documentKey
System.String culture
System.Boolean isDraft
Returns
Type Description
System.String
View Source

GetUrlSegment(Guid, String, Boolean)

Declaration
public string GetUrlSegment(Guid documentKey, string culture, bool isDraft)
Parameters
Type Name Description
Guid documentKey
System.String culture
System.Boolean isDraft
Returns
Type Description
System.String
View Source

HasAny()

Declaration
public bool HasAny()
Returns
Type Description
System.Boolean
View Source

InitAsync(Boolean, CancellationToken)

Declaration
public async Task InitAsync(bool forceEmpty, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Boolean forceEmpty
CancellationToken cancellationToken
Returns
Type Description
Task
View Source

ListUrlsAsync(Guid)

Declaration
public async Task<IEnumerable<UrlInfo>> ListUrlsAsync(Guid contentKey)
Parameters
Type Name Description
Guid contentKey
Returns
Type Description
Task<IEnumerable<UrlInfo>>
View Source

RebuildAllUrlsAsync()

Declaration
public async Task RebuildAllUrlsAsync()
Returns
Type Description
Task