Interface IContentPublishingService
Namespace: Umbraco.Cms.Core.Services
Assembly: Umbraco.Core.dll
Syntax
public interface IContentPublishingServiceMethods
View SourcePublishAsync(Guid, CultureAndScheduleModel, Guid)
Publishes a single content item.
Declaration
Task<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>> PublishAsync(Guid key, CultureAndScheduleModel cultureAndSchedule, Guid userKey)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | key | The key of the root content. |
| CultureAndScheduleModel | cultureAndSchedule | The cultures to publish and their publishing schedules. |
| Guid | userKey | The identifier of the user performing the operation. |
Returns
| Type | Description |
|---|---|
| Task<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>> | Result of the publish operation. |
PublishBranchAsync(Guid, IEnumerable<String>, Boolean, Guid)
Publishes a content branch.
Declaration
Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> PublishBranchAsync(Guid key, IEnumerable<string> cultures, bool force, Guid userKey)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | key | The key of the root content. |
| IEnumerable<System.String> | cultures | The cultures to publish. |
| System.Boolean | force | A value indicating whether to force-publish content that is not already published. |
| Guid | userKey | The identifier of the user performing the operation. |
Returns
| Type | Description |
|---|---|
| Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> | Result of the publish operation. |
UnpublishAsync(Guid, Nullable<ISet<String>>, Guid)
Unpublishes multiple cultures of a single content item.
Declaration
Task<Attempt<ContentPublishingOperationStatus>> UnpublishAsync(Guid key, ISet<string>? cultures, Guid userKey)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | key | The key of the root content. |
| System.Nullable<ISet<System.String>> | cultures | The cultures to unpublish. Use null to unpublish all cultures. |
| Guid | userKey | The identifier of the user performing the operation. |
Returns
| Type | Description |
|---|---|
| Task<Attempt<ContentPublishingOperationStatus>> | Status of the publish operation. |