View Source

Interface IContentPublishingService

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IContentPublishingService

Methods

GetPublishBranchResultAsync(Guid)

Retrieves the result of a background task that has published a content branch.

Declaration

Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> GetPublishBranchResultAsync(Guid taskId)

Parameters

Type	Name	Description
Guid	taskId	The task Id.

Returns

Type	Description
Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>>	Result of the publish operation.

IsPublishingBranchAsync(Guid)

Gets the status of a background task that is publishing a content branch.

Declaration

Task<bool> IsPublishingBranchAsync(Guid taskId)

Parameters

Type	Name	Description
Guid	taskId	The task Id.

Returns

Type	Description
Task<bool>	True if the requested publish branch tag is still in process.

PublishAsync(Guid, ICollection<CulturePublishScheduleModel>, Guid)

Publishes a single content item.

Declaration

Task<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>> PublishAsync(Guid key, ICollection<CulturePublishScheduleModel> culturesToPublishOrSchedule, Guid userKey)

Parameters

Type	Name	Description
Guid	key	The key of the root content.
ICollection<CulturePublishScheduleModel>	culturesToPublishOrSchedule	The cultures to publish or schedule.
Guid	userKey	The identifier of the user performing the operation.

Returns

Type	Description
Task<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>>

PublishBranchAsync(Guid, IEnumerable<string>, PublishBranchFilter, Guid, bool)

Publishes a content branch.

Declaration

Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> PublishBranchAsync(Guid key, IEnumerable<string> cultures, PublishBranchFilter publishBranchFilter, Guid userKey, bool useBackgroundThread)

Parameters

Type	Name	Description
Guid	key	The key of the root content.
IEnumerable<string>	cultures	The cultures to publish.
PublishBranchFilter	publishBranchFilter	A value indicating options for force publishing unpublished or re-publishing unchanged content.
Guid	userKey	The identifier of the user performing the operation.
bool	useBackgroundThread	Flag indicating whether to use a background thread for the operation and immediately return to the caller.

Returns

Type	Description
Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>>	Result of the publish operation.

UnpublishAsync(Guid, 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.
ISet<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.