public interface IContentPublishingService
Methods View Source GetPublishBranchResultAsync(Guid)
Retrieves the result of a background task that has published a content branch.
Declarationvirtual Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> GetPublishBranchResultAsync(Guid taskId)
Parameters Type Name Description Guid taskId
The task Id.
Returns View Source IsPublishingBranchAsync(Guid)Gets the status of a background task that is publishing a content branch.
Declarationvirtual Task<bool> IsPublishingBranchAsync(Guid taskId)
Parameters Type Name Description Guid taskId
The task Id.
Returns Type Description Task<System.Boolean>True if the requested publish branch tag is still in process.
View Source PublishAsync(Guid, ICollection<CulturePublishScheduleModel>, Guid)Publishes a single content item.
Declarationvirtual 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> culturesToPublishOrScheduleThe cultures to publish or schedule.
Guid userKeyThe identifier of the user performing the operation.
Returns View Source PublishAsync(Guid, CultureAndScheduleModel, Guid)Publishes a single content item.
DeclarationTask<Attempt<ContentPublishingResult, ContentPublishingOperationStatus>> PublishAsync(Guid key, CultureAndScheduleModel cultureAndSchedule, Guid userKey)
Parameters Type Name Description Guid key
The key of the root content.
CultureAndScheduleModel cultureAndScheduleThe cultures to publish and their publishing schedules.
Guid userKeyThe identifier of the user performing the operation.
Returns View Source PublishBranchAsync(Guid, IEnumerable<String>, Boolean, Guid)Publishes a content branch.
DeclarationTask<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> culturesThe cultures to publish.
System.Boolean forceA value indicating whether to force-publish content that is not already published.
Guid userKeyThe identifier of the user performing the operation.
Returns View Source PublishBranchAsync(Guid, IEnumerable<String>, PublishBranchFilter, Guid)Publishes a content branch.
Declarationvirtual Task<Attempt<ContentPublishingBranchResult, ContentPublishingOperationStatus>> PublishBranchAsync(Guid key, IEnumerable<string> cultures, PublishBranchFilter publishBranchFilter, Guid userKey)
Parameters Type Name Description Guid key
The key of the root content.
IEnumerable<System.String> culturesThe cultures to publish.
PublishBranchFilter publishBranchFilterA value indicating options for force publishing unpublished or re-publishing unchanged content.
Guid userKeyThe identifier of the user performing the operation.
Returns View Source PublishBranchAsync(Guid, IEnumerable<String>, PublishBranchFilter, Guid, Boolean)Publishes a content branch.
Declarationvirtual 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<System.String> culturesThe cultures to publish.
PublishBranchFilter publishBranchFilterA value indicating options for force publishing unpublished or re-publishing unchanged content.
Guid userKeyThe identifier of the user performing the operation.
System.Boolean useBackgroundThreadFlag indicating whether to use a background thread for the operation and immediately return to the caller.
Returns View Source UnpublishAsync(Guid, Nullable<ISet<String>>, Guid)Unpublishes multiple cultures of a single content item.
DeclarationTask<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>> culturesThe cultures to unpublish. Use null to unpublish all cultures.
Guid userKeyThe identifier of the user performing the operation.
ReturnsRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4