View Source

Class PublishStatusService

Implements IPublishStatusManagementService and IPublishStatusQueryService verifying the published status of documents.

Inheritance
System.Object
Namespace: Umbraco.Cms.Core.Services.Navigation
Assembly: Umbraco.Core.dll
Syntax
public class PublishStatusService : IPublishStatusManagementService, IPublishStatusQueryService

Constructors

View Source

PublishStatusService(ILogger<PublishStatusService>, IPublishStatusRepository, ICoreScopeProvider)

Initializes a new instance of the PublishStatusService class.

Declaration
public PublishStatusService(ILogger<PublishStatusService> logger, IPublishStatusRepository publishStatusRepository, ICoreScopeProvider coreScopeProvider)
Parameters
Type Name Description
ILogger<PublishStatusService> logger
IPublishStatusRepository publishStatusRepository
ICoreScopeProvider coreScopeProvider
View Source

PublishStatusService(ILogger<PublishStatusService>, IPublishStatusRepository, ICoreScopeProvider, ILanguageService)

Initializes a new instance of the PublishStatusService class.

Declaration
public PublishStatusService(ILogger<PublishStatusService> logger, IPublishStatusRepository publishStatusRepository, ICoreScopeProvider coreScopeProvider, ILanguageService languageService)
Parameters
Type Name Description
ILogger<PublishStatusService> logger
IPublishStatusRepository publishStatusRepository
ICoreScopeProvider coreScopeProvider
ILanguageService languageService
View Source

PublishStatusService(ILogger<PublishStatusService>, IPublishStatusRepository, ICoreScopeProvider, ILanguageService, IDocumentNavigationQueryService)

Initializes a new instance of the PublishStatusService class.

Declaration
public PublishStatusService(ILogger<PublishStatusService> logger, IPublishStatusRepository publishStatusRepository, ICoreScopeProvider coreScopeProvider, ILanguageService languageService, IDocumentNavigationQueryService documentNavigationQueryService)
Parameters
Type Name Description
ILogger<PublishStatusService> logger
IPublishStatusRepository publishStatusRepository
ICoreScopeProvider coreScopeProvider
ILanguageService languageService
IDocumentNavigationQueryService documentNavigationQueryService

Methods

View Source

AddOrUpdateStatusAsync(Guid, CancellationToken)

Declaration
public async Task AddOrUpdateStatusAsync(Guid documentKey, CancellationToken cancellationToken)
Parameters
Type Name Description
Guid documentKey
CancellationToken cancellationToken
Returns
Type Description
Task
View Source

AddOrUpdateStatusWithDescendantsAsync(Guid, CancellationToken)

Declaration
public async Task AddOrUpdateStatusWithDescendantsAsync(Guid rootDocumentKey, CancellationToken cancellationToken)
Parameters
Type Name Description
Guid rootDocumentKey
CancellationToken cancellationToken
Returns
Type Description
Task
View Source

HasPublishedAncestorPath(Guid)

Verifies if a document has a published ancestor path (i.e. all ancestors are themselves published in at least one culture).

Declaration
public bool HasPublishedAncestorPath(Guid contentKey)
Parameters
Type Name Description
Guid contentKey
Returns
Type Description
System.Boolean

True if document has a published ancestor path.
View Source

InitializeAsync(CancellationToken)

Declaration
public async Task InitializeAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
View Source

IsDocumentPublished(Guid, String)

Checks if a document is published in a specific culture.

Declaration
public bool IsDocumentPublished(Guid documentKey, string culture)
Parameters
Type Name Description
Guid documentKey

The document's key.
System.String culture

The culture.
Returns
Type Description
System.Boolean

True if document is published in the specified culture.
View Source

IsDocumentPublishedInAnyCulture(Guid)

Checks if a document is published in any culture.

Declaration
public bool IsDocumentPublishedInAnyCulture(Guid documentKey)
Parameters
Type Name Description
Guid documentKey

The document's key.
Returns
Type Description
System.Boolean

True if document has any published culture.
View Source

RemoveAsync(Guid, CancellationToken)

Declaration
public Task RemoveAsync(Guid documentKey, CancellationToken cancellationToken)
Parameters
Type Name Description
Guid documentKey
CancellationToken cancellationToken
Returns
Type Description
Task