Class Job

Namespace

Oqtane.Models

Assembly

Oqtane.Shared.dll

Definition of a Job / Task which is run on the server. When Jobs run, they create a JobLog

public class Job : ModelBase, IAuditable

Inheritance

object

ModelBase

Job

Implements

IAuditable

Inherited Members

ModelBase.CreatedBy

ModelBase.CreatedOn

ModelBase.ModifiedBy

ModelBase.ModifiedOn

Properties

EndDate

When the job is to be run the last time. See also StartDate.

public DateTime? EndDate { get; set; }

Property Value

DateTime?

Frequency

Unit used in how often the job should run - expects a character like m (minutes), H (hours) etc.

public string Frequency { get; set; }

Property Value

string

Interval

How often the Job should run - see also Frequency

public int Interval { get; set; }

Property Value

int

IsEnabled

Determines if the Job is activated / enabled.

public bool IsEnabled { get; set; }

Property Value

bool

IsExecuting

If the Job is executing right now.

public bool IsExecuting { get; set; }

Property Value

bool

IsStarted

If the Job has ever started running

public bool IsStarted { get; set; }

Property Value

bool

JobId

Internal ID

public int JobId { get; set; }

Property Value

int

JobType

What kind of Job this is

public string JobType { get; set; }

Property Value

string

Name

Name for simple identification

public string Name { get; set; }

Property Value

string

NextExecution

When the Job will run again next time.

public DateTime? NextExecution { get; set; }

Property Value

DateTime?

RetentionHistory

Todo: todoc - unsure what this does

public int RetentionHistory { get; set; }

Property Value

int

StartDate

When the Job is to be run the first time. See also EndDate.

public DateTime? StartDate { get; set; }

Property Value

DateTime?