View Source

Interface IRecurringBackgroundJob

A recurring background job

Namespace: Umbraco.Cms.Infrastructure.BackgroundJobs

Assembly: Umbraco.Infrastructure.dll

Syntax

public interface IRecurringBackgroundJob

Fields

DefaultDelay

Declaration

public static readonly TimeSpan DefaultDelay

Field Value

Type	Description
TimeSpan

DefaultServerRoles

Declaration

public static readonly ServerRole[] DefaultServerRoles

Field Value

Type	Description
ServerRole[]

Properties

Delay

Timespan representing the initial delay after application start-up before the first run of the task occurs.

Declaration

virtual TimeSpan Delay { get; }

Property Value

Type	Description
TimeSpan

Period

Timespan representing how often the task should recur.

Declaration

TimeSpan Period { get; }

Property Value

Type	Description
TimeSpan

ServerRoles

Declaration

virtual ServerRole[] ServerRoles { get; }

Property Value

Type	Description
ServerRole[]

Methods

RunJobAsync()

Declaration

Task RunJobAsync()

Returns

Type	Description
Task

Events

PeriodChanged

Declaration

event EventHandler PeriodChanged

Event Type

Type	Description
EventHandler