Class SchedulingController

Inheritance

object

SchedulingController

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Services.Scheduling

Assembly: DotNetNuke.dll

Syntax

public class SchedulingController

Constructors

SchedulingController()

Declaration

public SchedulingController()

Methods

AddSchedule(string, int, string, int, string, int, string, bool, bool, string, string, string)

Declaration

[Obsolete("Deprecated in DotNetNuke 7.3.0. Use alternate overload. Scheduled for removal in v10.0.0.")]
public static int AddSchedule(string typeFullName, int timeLapse, string timeLapseMeasurement, int retryTimeLapse, string retryTimeLapseMeasurement, int retainHistoryNum, string attachToEvent, bool catchUpEnabled, bool enabled, string objectDependencies, string servers, string friendlyName)

Parameters

Type	Name	Description
string	typeFullName
int	timeLapse
string	timeLapseMeasurement
int	retryTimeLapse
string	retryTimeLapseMeasurement
int	retainHistoryNum
string	attachToEvent
bool	catchUpEnabled
bool	enabled
string	objectDependencies
string	servers
string	friendlyName

Returns

Type	Description
int

AddSchedule(string, int, string, int, string, int, string, bool, bool, string, string, string, DateTime)

Declaration

public static int AddSchedule(string typeFullName, int timeLapse, string timeLapseMeasurement, int retryTimeLapse, string retryTimeLapseMeasurement, int retainHistoryNum, string attachToEvent, bool catchUpEnabled, bool enabled, string objectDependencies, string servers, string friendlyName, DateTime scheduleStartDate)

Parameters

Type	Name	Description
string	typeFullName
int	timeLapse
string	timeLapseMeasurement
int	retryTimeLapse
string	retryTimeLapseMeasurement
int	retainHistoryNum
string	attachToEvent
bool	catchUpEnabled
bool	enabled
string	objectDependencies
string	servers
string	friendlyName
DateTime	scheduleStartDate

Returns

Type	Description
int

AddScheduleHistory(ScheduleHistoryItem)

Declaration

public static int AddScheduleHistory(ScheduleHistoryItem objScheduleHistoryItem)

Parameters

Type	Name	Description
ScheduleHistoryItem	objScheduleHistoryItem

Returns

Type	Description
int

AddScheduleItemSetting(int, string, string)

Declaration

public static void AddScheduleItemSetting(int scheduleID, string name, string value)

Parameters

Type	Name	Description
int	scheduleID
string	name
string	value

CanRunOnThisServer(string)

Declaration

public static bool CanRunOnThisServer(string servers)

Parameters

Type	Name	Description
string	servers

Returns

Type	Description
bool

DeleteSchedule(int)

Declaration

public static void DeleteSchedule(int scheduleID)

Parameters

Type	Name	Description
int	scheduleID

GetActiveThreadCount()

Declaration

public static int GetActiveThreadCount()

Returns

Type	Description
int

GetFreeThreadCount()

Declaration

public static int GetFreeThreadCount()

Returns

Type	Description
int

GetMaxThreadCount()

Declaration

public static int GetMaxThreadCount()

Returns

Type	Description
int

GetNextScheduledTask(string)

Declaration

public static ScheduleItem GetNextScheduledTask(string server)

Parameters

Type	Name	Description
string	server

Returns

Type	Description
ScheduleItem

GetSchedule()

Declaration

public static List<ScheduleItem> GetSchedule()

Returns

Type	Description
List<ScheduleItem>

GetSchedule(int)

Declaration

public static ScheduleItem GetSchedule(int scheduleID)

Parameters

Type	Name	Description
int	scheduleID

Returns

Type	Description
ScheduleItem

GetSchedule(string)

Declaration

public static List<ScheduleItem> GetSchedule(string server)

Parameters

Type	Name	Description
string	server

Returns

Type	Description
List<ScheduleItem>

GetSchedule(string, string)

Declaration

public static ScheduleItem GetSchedule(string typeFullName, string server)

Parameters

Type	Name	Description
string	typeFullName
string	server

Returns

Type	Description
ScheduleItem

GetScheduleByEvent(string, string)

Declaration

public static List<ScheduleItem> GetScheduleByEvent(string eventName, string server)

Parameters

Type	Name	Description
string	eventName
string	server

Returns

Type	Description
List<ScheduleItem>

GetScheduleHistory(int)

Declaration

public static List<ScheduleHistoryItem> GetScheduleHistory(int scheduleID)

Parameters

Type	Name	Description
int	scheduleID

Returns

Type	Description
List<ScheduleHistoryItem>

GetScheduleItemSettings(int)

Declaration

public static Hashtable GetScheduleItemSettings(int scheduleID)

Parameters

Type	Name	Description
int	scheduleID

Returns

Type	Description
Hashtable

GetScheduleProcessing()

Declaration

public static Collection GetScheduleProcessing()

Returns

Type	Description
Collection

GetScheduleQueue()

Declaration

public static Collection GetScheduleQueue()

Returns

Type	Description
Collection

GetScheduleStatus()

Declaration

public static ScheduleStatus GetScheduleStatus()

Returns

Type	Description
ScheduleStatus

PurgeScheduleHistory()

Declaration

public static void PurgeScheduleHistory()

ReloadSchedule()

Declaration

public static void ReloadSchedule()

UpdateSchedule(ScheduleItem)

Declaration

public static void UpdateSchedule(ScheduleItem scheduleItem)

Parameters

Type	Name	Description
ScheduleItem	scheduleItem

UpdateSchedule(int, string, int, string, int, string, int, string, bool, bool, string, string, string)

Declaration

public static void UpdateSchedule(int scheduleID, string typeFullName, int timeLapse, string timeLapseMeasurement, int retryTimeLapse, string retryTimeLapseMeasurement, int retainHistoryNum, string attachToEvent, bool catchUpEnabled, bool enabled, string objectDependencies, string servers, string friendlyName)

Parameters

Type	Name	Description
int	scheduleID
string	typeFullName
int	timeLapse
string	timeLapseMeasurement
int	retryTimeLapse
string	retryTimeLapseMeasurement
int	retainHistoryNum
string	attachToEvent
bool	catchUpEnabled
bool	enabled
string	objectDependencies
string	servers
string	friendlyName

UpdateSchedule(int, string, int, string, int, string, int, string, bool, bool, string, string, string, DateTime)

Declaration

[Obsolete("Deprecated in DotNetNuke 7.3.0. Use alternate overload. Scheduled for removal in v10.0.0.")]
public static void UpdateSchedule(int scheduleID, string typeFullName, int timeLapse, string timeLapseMeasurement, int retryTimeLapse, string retryTimeLapseMeasurement, int retainHistoryNum, string attachToEvent, bool catchUpEnabled, bool enabled, string objectDependencies, string servers, string friendlyName, DateTime scheduleStartDate)

Parameters

Type	Name	Description
int	scheduleID
string	typeFullName
int	timeLapse
string	timeLapseMeasurement
int	retryTimeLapse
string	retryTimeLapseMeasurement
int	retainHistoryNum
string	attachToEvent
bool	catchUpEnabled
bool	enabled
string	objectDependencies
string	servers
string	friendlyName
DateTime	scheduleStartDate

UpdateScheduleHistory(ScheduleHistoryItem)

Declaration

public static void UpdateScheduleHistory(ScheduleHistoryItem objScheduleHistoryItem)

Parameters

Type	Name	Description
ScheduleHistoryItem	objScheduleHistoryItem

Extension Methods

JsonExtensionsWeb.ToJson(object)