Class ScheduledJobBase
Base class for all Scheduled job that supports start and stop
Inheritance
System.Object
ScheduledJobBase
Implements
Namespace: EPiServer.Scheduler
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public abstract class ScheduledJobBase : Object, IScheduledJobConstructors
ScheduledJobBase()
Declaration
protected ScheduledJobBase()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> StatusChangedEvent Type
| Type | Description |
|---|---|
| System.EventHandler<JobStatusChangedEventArgs> |
Explicit Interface Implementations
IScheduledJob.ID
Declaration
Guid IScheduledJob.ID { get; }Returns
| Type | Description |
|---|---|
| System.Guid |
