Class SchedulerClient

This class is inherited by any class that wants to run tasks in the scheduler.

Inheritance
System.Object
SchedulerClient
ExportImportScheduler
PurgeUsersOnline
PurgeAuthCookiesTask
PurgeCache
SynchronizeFileSystem
PurgeLogBuffer
SendLogNotifications
PurgeModuleCache
PurgeOutputCache
PurgeScheduleHistory
SearchEngineScheduler
CoreMessagingScheduler
WebServerMonitor
PurgeDeletedUsers
Namespace: DotNetNuke.Services.Scheduling
Assembly: DotNetNuke.dll
Syntax
public abstract class SchedulerClient : object

Constructors

| Improve this Doc View Source

SchedulerClient()

Initializes a new instance of the SchedulerClient class.

Declaration
public SchedulerClient()

Properties

| Improve this Doc View Source

aProcessMethod

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public string aProcessMethod { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ScheduleHistoryItem

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public ScheduleHistoryItem ScheduleHistoryItem { get; set; }
Property Value
Type Description
ScheduleHistoryItem
| Improve this Doc View Source

SchedulerEventGUID

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public string SchedulerEventGUID { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Status

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ThreadID

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public int ThreadID { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Completed()

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public void Completed()
| Improve this Doc View Source

DoWork()

This is the sub that kicks off the actual work within the SchedulerClient's subclass.

Declaration
public abstract void DoWork()
| Improve this Doc View Source

Errored(ref Exception)

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public void Errored(ref Exception objException)
Parameters
Type Name Description
Exception objException
| Improve this Doc View Source

Progressing()

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public void Progressing()
| Improve this Doc View Source

Started()

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public void Started()

Events

| Improve this Doc View Source

ProcessCompleted

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public event WorkCompleted ProcessCompleted
Event Type
Type Description
WorkCompleted
| Improve this Doc View Source

ProcessErrored

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public event WorkErrored ProcessErrored
Event Type
Type Description
WorkErrored
| Improve this Doc View Source

ProcessProgressing

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public event WorkProgressing ProcessProgressing
Event Type
Type Description
WorkProgressing
| Improve this Doc View Source

ProcessStarted

This class is inherited by any class that wants to run tasks in the scheduler.

Declaration
public event WorkStarted ProcessStarted
Event Type
Type Description
WorkStarted

Extension Methods