Interface IPublishStatusRepository
Represents a repository for querying document publish status.
Namespace: Umbraco.Cms.Core.Persistence.Repositories
Assembly: Umbraco.Core.dll
Syntax
public interface IPublishStatusRepositoryMethods
View SourceGetAllPublishStatusAsync(CancellationToken)
Gets the publish status for all documents.
Declaration
Task<IDictionary<Guid, ISet<string>>> GetAllPublishStatusAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A cancellation token to observe. |
Returns
| Type | Description |
|---|---|
| Task<IDictionary<Guid, ISet<string>>> | A dictionary mapping document keys to their published culture codes. |
GetDescendantsOrSelfPublishStatusAsync(Guid, CancellationToken)
Gets the publish status for a document and all its descendants.
Declaration
Task<IDictionary<Guid, ISet<string>>> GetDescendantsOrSelfPublishStatusAsync(Guid rootDocumentKey, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | rootDocumentKey | The unique key of the root document. |
| CancellationToken | cancellationToken | A cancellation token to observe. |
Returns
| Type | Description |
|---|---|
| Task<IDictionary<Guid, ISet<string>>> | A dictionary mapping document keys to their published culture codes. |
GetPublishStatusAsync(Guid, CancellationToken)
Gets the publish status for a specific document.
Declaration
Task<ISet<string>> GetPublishStatusAsync(Guid documentKey, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | documentKey | The unique key of the document. |
| CancellationToken | cancellationToken | A cancellation token to observe. |
Returns
| Type | Description |
|---|---|
| Task<ISet<string>> | A set of culture codes for which the document is published. |