Try our conversational search powered by Generative AI!

AI OnAI Off

Class JobBase

Base class for all Scheduled job that supports start and stop

Inheritance
System.Object
JobBase
BlobCleanupJob
CleanUnusedAssetsFoldersJob
DelayedPublishJob
EmptyWastebasketJob
ThumbnailPropertiesClearJob
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.BaseLibrary.Scheduling
Assembly: EPiServer.BaseLibrary.dll
Version: 8.11.0
Syntax
public abstract class JobBase

Constructors

JobBase()

Declaration
protected JobBase()

Properties

IsStoppable

Gets/Sets if the job is stoppable

Declaration
public bool IsStoppable { get; protected set; }
Property Value
Type Description
System.Boolean

ScheduledJobId

Gets the Id of the scheduled job

Declaration
public Guid ScheduledJobId { get; set; }
Property Value
Type Description
System.Guid

Methods

Execute()

Execute the job

Declaration
public abstract string Execute()
Returns
Type Description
System.String

OnStatusChanged(String)

Raise a StatusChanged event

Declaration
protected virtual void OnStatusChanged(string statusMessage)
Parameters
Type Name Description
System.String statusMessage

Status message to report

Stop()

Stop the job

Declaration
public virtual void Stop()

Events

StatusChanged

Event used to report status changes for the Job

Declaration
public event EventHandler<JobStatusChangedEventArgs> StatusChanged
Event Type
Type Description
System.EventHandler<JobStatusChangedEventArgs>

Extension Methods