Class SchedulingProvider

Inheritance
object
SchedulingProvider
DNNScheduler
Inherited Members
Namespace: DotNetNuke.Services.Scheduling
Assembly: DotNetNuke.dll
Syntax
public abstract class SchedulingProvider

Constructors

SchedulingProvider()

Declaration
protected SchedulingProvider()

Fields

EventName

Declaration
public EventName EventName
Field Value
Type Description
EventName

Properties

Debug

Declaration
public static bool Debug { get; }
Property Value
Type Description
bool

DelayAtAppStart

Declaration
public static int DelayAtAppStart { get; }
Property Value
Type Description
int

Enabled

Declaration
public static bool Enabled { get; }
Property Value
Type Description
bool

MaxThreads

Declaration
public static int MaxThreads { get; }
Property Value
Type Description
int

ProviderPath

Declaration
public string ProviderPath { get; }
Property Value
Type Description
string

ReadyForPoll

Declaration
public static bool ReadyForPoll { get; }
Property Value
Type Description
bool

ScheduleLastPolled

Declaration
public static DateTime ScheduleLastPolled { get; set; }
Property Value
Type Description
DateTime

SchedulerMode

Declaration
public static SchedulerMode SchedulerMode { get; }
Property Value
Type Description
SchedulerMode

Settings

Declaration
public virtual Dictionary<string, string> Settings { get; }
Property Value
Type Description
Dictionary<string, string>

Methods

AddSchedule(ScheduleItem)

Declaration
public abstract int AddSchedule(ScheduleItem scheduleItem)
Parameters
Type Name Description
ScheduleItem scheduleItem
Returns
Type Description
int

AddScheduleItemSetting(int, string, string)

Declaration
public abstract void AddScheduleItemSetting(int scheduleID, string name, string value)
Parameters
Type Name Description
int scheduleID
string name
string value

DeleteSchedule(ScheduleItem)

Declaration
public abstract void DeleteSchedule(ScheduleItem scheduleItem)
Parameters
Type Name Description
ScheduleItem scheduleItem

ExecuteTasks()

Declaration
public abstract void ExecuteTasks()

GetActiveThreadCount()

Declaration
public abstract int GetActiveThreadCount()
Returns
Type Description
int

GetFreeThreadCount()

Declaration
public abstract int GetFreeThreadCount()
Returns
Type Description
int

GetMaxThreadCount()

Declaration
public abstract int GetMaxThreadCount()
Returns
Type Description
int

GetNextScheduledTask(string)

Declaration
public abstract ScheduleItem GetNextScheduledTask(string server)
Parameters
Type Name Description
string server
Returns
Type Description
ScheduleItem

GetSchedule()

Declaration
public abstract ArrayList GetSchedule()
Returns
Type Description
ArrayList

GetSchedule(int)

Declaration
public abstract ScheduleItem GetSchedule(int scheduleID)
Parameters
Type Name Description
int scheduleID
Returns
Type Description
ScheduleItem

GetSchedule(string)

Declaration
public abstract ArrayList GetSchedule(string server)
Parameters
Type Name Description
string server
Returns
Type Description
ArrayList

GetSchedule(string, string)

Declaration
public abstract ScheduleItem GetSchedule(string typeFullName, string server)
Parameters
Type Name Description
string typeFullName
string server
Returns
Type Description
ScheduleItem

GetScheduleHistory(int)

Declaration
public abstract ArrayList GetScheduleHistory(int scheduleID)
Parameters
Type Name Description
int scheduleID
Returns
Type Description
ArrayList

GetScheduleItemSettings(int)

Declaration
public abstract Hashtable GetScheduleItemSettings(int scheduleID)
Parameters
Type Name Description
int scheduleID
Returns
Type Description
Hashtable

GetScheduleProcessing()

Declaration
public abstract Collection GetScheduleProcessing()
Returns
Type Description
Collection

GetScheduleQueue()

Declaration
public abstract Collection GetScheduleQueue()
Returns
Type Description
Collection

GetScheduleStatus()

Declaration
public abstract ScheduleStatus GetScheduleStatus()
Returns
Type Description
ScheduleStatus

Halt(string)

Declaration
public abstract void Halt(string sourceOfHalt)
Parameters
Type Name Description
string sourceOfHalt

Instance()

Declaration
public static SchedulingProvider Instance()
Returns
Type Description
SchedulingProvider

PurgeScheduleHistory()

Declaration
public abstract void PurgeScheduleHistory()

ReStart(string)

Declaration
public abstract void ReStart(string sourceOfRestart)
Parameters
Type Name Description
string sourceOfRestart

RemoveFromScheduleInProgress(ScheduleItem)

Declaration
public abstract void RemoveFromScheduleInProgress(ScheduleItem scheduleItem)
Parameters
Type Name Description
ScheduleItem scheduleItem

RunEventSchedule(EventName)

Declaration
public abstract void RunEventSchedule(EventName eventName)
Parameters
Type Name Description
EventName eventName

RunScheduleItemNow(ScheduleItem)

Declaration
public virtual void RunScheduleItemNow(ScheduleItem scheduleItem)
Parameters
Type Name Description
ScheduleItem scheduleItem

RunScheduleItemNow(ScheduleItem, bool)

Declaration
public virtual void RunScheduleItemNow(ScheduleItem scheduleItem, bool runNow)
Parameters
Type Name Description
ScheduleItem scheduleItem
bool runNow

Start()

Declaration
public abstract void Start()

StartAndWaitForResponse()

Declaration
public abstract void StartAndWaitForResponse()

UpdateSchedule(ScheduleItem)

Declaration
public abstract void UpdateSchedule(ScheduleItem scheduleItem)
Parameters
Type Name Description
ScheduleItem scheduleItem

UpdateScheduleWithoutExecution(ScheduleItem)

Declaration
public abstract void UpdateScheduleWithoutExecution(ScheduleItem scheduleItem)
Parameters
Type Name Description
ScheduleItem scheduleItem

Extension Methods