Take the community feedback survey now.

AI OnAI Off

Class BatchPublisher

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Handles batch operations on content versions in relation to publishing.

Inheritance
System.Object
BatchPublisher
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Core.Internal
Assembly: EPiServer.dll
Version: 10.10.4
Syntax
[ServiceConfiguration(typeof(BatchPublisher))]
public class BatchPublisher

Constructors

BatchPublisher(ContentRepository, IContentProviderManager, IBatchPublishSortingStrategy, TaskExecutor)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Constructor for BatchPublisher

Declaration
public BatchPublisher(ContentRepository contentRepository, IContentProviderManager providerManager, IBatchPublishSortingStrategy sortingStrategy, TaskExecutor taskExecutor)
Parameters
Type Name Description
ContentRepository contentRepository

The content repository.
IContentProviderManager providerManager

The provider manager used to check provider capabilities.
IBatchPublishSortingStrategy sortingStrategy

Object responsible for the sorting of content items before publishing them.
TaskExecutor taskExecutor

The task executor responsible for running publishing tasks.

Methods

Cancel(Guid)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Sends a cancellation signal to a publishing task with the specified id.

Declaration
public virtual Task Cancel(Guid trackingTokenId)
Parameters
Type Name Description
System.Guid trackingTokenId

The tracking token id associated with the publishing task.
Returns
Type Description
System.Threading.Tasks.Task

The Task that was cancelled or null if no task was found.

CancelDelayedPublishing(IEnumerable<ContentReference>, AccessLevel, CancellationToken, IProgress<BatchProgress>)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Starts a task to cancel any delayed publishing setup for the specified versions.

Declaration
public Task CancelDelayedPublishing(IEnumerable<ContentReference> versions, AccessLevel accessLevel, CancellationToken cancellationToken, IProgress<BatchProgress> progress)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ContentReference> versions

The versions for which to cancel the delayed publishing.
AccessLevel accessLevel

The access level required to complete this task.
System.Threading.CancellationToken cancellationToken

The cancellation token used to signal if the task should be cancelled before completion.
System.IProgress<BatchProgress> progress

The instance upon which progress is reported to.
Returns
Type Description
System.Threading.Tasks.Task

The task that performs the cancelling operation.

PublishAsync(IEnumerable<ContentReference>)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Starts a task to publish the specified versions.

Declaration
public Task PublishAsync(IEnumerable<ContentReference> versions)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ContentReference> versions

The versions to publish.
Returns
Type Description
System.Threading.Tasks.Task

The task that performs the publish operation.

PublishAsync(IEnumerable<ContentReference>, AccessLevel)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Starts a task to publish the specified versions.

Declaration
public Task PublishAsync(IEnumerable<ContentReference> versions, AccessLevel accessLevel)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ContentReference> versions

The versions to publish.
AccessLevel accessLevel

The access level to check.
Returns
Type Description
System.Threading.Tasks.Task

The task that performs the publish operation.

PublishAsync(IEnumerable<ContentReference>, Nullable<DateTime>)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Starts a task to publish the specified versions.

Declaration
public Task PublishAsync(IEnumerable<ContentReference> versions, DateTime? delayPublishUntil)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ContentReference> versions

The versions to publish.
System.Nullable<System.DateTime> delayPublishUntil
Returns
Type Description
System.Threading.Tasks.Task

The task that performs the publish operation.

PublishAsync(IEnumerable<ContentReference>, Nullable<DateTime>, AccessLevel)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Starts a task to publish the specified versions.

Declaration
public Task PublishAsync(IEnumerable<ContentReference> versions, DateTime? delayPublishUntil, AccessLevel accessLevel)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ContentReference> versions

The versions to publish.
System.Nullable<System.DateTime> delayPublishUntil
AccessLevel accessLevel

The access level to check.
Returns
Type Description
System.Threading.Tasks.Task

The task that performs the publish operation.

PublishAsync(IEnumerable<ContentReference>, Nullable<DateTime>, AccessLevel, TrackingToken)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Starts a task to publish the specified versions.

Declaration
public Task PublishAsync(IEnumerable<ContentReference> versions, DateTime? delayPublishUntil, AccessLevel accessLevel, TrackingToken trackingToken)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<ContentReference> versions

The versions to publish.
System.Nullable<System.DateTime> delayPublishUntil
AccessLevel accessLevel

The access level to check.
TrackingToken trackingToken

The trackingtoken that will be associated with the task so it can be tracked.
Returns
Type Description
System.Threading.Tasks.Task

The task that performs the publish operation.

Extension Methods