Class Task
- Namespace
- Dynamicweb.Indexing.Repositories.Tasks
- Assembly
- Dynamicweb.Core.dll
Represents task
public sealed class Task
- Inheritance
-
Task
- Inherited Members
Constructors
Task()
Default constructor
public Task()
Properties
End
Gets or sets the end time. DateTime.MaxValue
indicates no end time, meaning it keeps repeating until actively stopped.
public DateTime End { get; set; }
Property Value
- DateTime
The end time.
IsTaskRunning
Returns true if the task is running.
public bool IsTaskRunning { get; }
Property Value
LastExecutionStartTime
Gets the last execution start time. The value represents the last time this task was started.
If the task was never run the value is null
.
public DateTime? LastExecutionStartTime { get; }
Property Value
- DateTime?
The last execution time.
LastExecutionSuccessful
Gets the last execution successful. The value indicates whether the last execution was successful.
If the task was never run, or if it's currently running the value is null
.
public bool? LastExecutionSuccessful { get; }
Property Value
- bool?
The last execution successful.
LastExecutionTime
Gets the last execution time. The value represents the last time this task was executed.
If the task was never run, or if it's currently running the value is null
.
public DateTime? LastExecutionTime { get; }
Property Value
- DateTime?
The last execution time.
Name
Gets or sets the name of the task. This is the name of the actual file that defined this task.
public string Name { get; set; }
Property Value
- string
The name.
Parameters
Gets or sets the parameters needed for the underlying task type.
public IDictionary<string, string> Parameters { get; set; }
Property Value
- IDictionary<string, string>
The parameters.
RepeatInMinutes
Gets or sets the repeat interval (in minutes).
public int RepeatInMinutes { get; set; }
Property Value
- int
The repeat in minutes.
Repository
Gets the repository to which this task belongs.
public string Repository { get; }
Property Value
- string
The repository.
Start
Gets or sets the start time. DateTime.MinValue
indicates no start time, meaning it's active always, or until any specified end time.
public DateTime Start { get; set; }
Property Value
- DateTime
The start time.
TypeName
Gets or sets the type of the underlying. Must be specific enough so it can be resolved using the Type system.
public string TypeName { get; set; }
Property Value
- string
The type.
Methods
Run()
Runs this task.
public void Run()