Interface IPublishStatusManagementService
Provides management operations for the in-memory publish status cache.
Namespace: Umbraco.Cms.Core.Services.Navigation
Assembly: Umbraco.Core.dll
Syntax
public interface IPublishStatusManagementServiceRemarks
This service is responsible for maintaining the publish status cache that tracks which documents are published and in which cultures.
Methods
View SourceAddOrUpdateStatusAsync(Guid, CancellationToken)
Adds or updates the publish status for a specific document in the cache.
Declaration
Task AddOrUpdateStatusAsync(Guid documentKey, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | documentKey | The unique key of the document to update. |
| CancellationToken | cancellationToken | A token to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task | A task that represents the asynchronous operation. |
AddOrUpdateStatusWithDescendantsAsync(Guid, CancellationToken)
Adds or updates the publish status for a document and all its descendants in the cache.
Declaration
Task AddOrUpdateStatusWithDescendantsAsync(Guid rootDocumentKey, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | rootDocumentKey | The unique key of the root document. |
| CancellationToken | cancellationToken | A token to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task | A task that represents the asynchronous operation. |
InitializeAsync(CancellationToken)
Initializes the publish status cache by loading all published document statuses from the database.
Declaration
Task InitializeAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A token to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task | A task that represents the asynchronous initialization operation. |
RemoveAsync(Guid, CancellationToken)
Removes a document from the publish status cache.
Declaration
Task RemoveAsync(Guid documentKey, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | documentKey | The unique key of the document to remove. |
| CancellationToken | cancellationToken | A token to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task | A task that represents the asynchronous operation. |