Share via


SPSchedule class

Abstract base class that supports the different schedule types that are used in job definitions.

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.SPSchedule
    Microsoft.SharePoint.SPDailySchedule
    Microsoft.SharePoint.SPHourlySchedule
    Microsoft.SharePoint.SPMinuteSchedule
    Microsoft.SharePoint.SPMonthlyByDaySchedule
    Microsoft.SharePoint.SPOneTimeSchedule

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public MustInherit Class SPSchedule
'Usage
Dim instance As SPSchedule
public abstract class SPSchedule

Remarks

Use the Schedule property of the SPJobDefinition class to get the schedule for a job definition.

SharePoint Foundation job definitions can use the following schedule types:

SharePoint Foundation does not support extending the SPSchedule class.

The begin and end properties in classes that derive from SPSchedule specify a time window when a job should be started and have no effect on when the job finishes. The timer service will pick a random time between the begin and end and will start the job at that time. This feature is primarily used for resource-intensive jobs that run on multiple computers in the farm. The randomized start time ensures that they do not all start simultaneously, which could adversely affect server availability. To start the job at a precise time, the begin and end values for the schedule should be identical.

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See also

Reference

SPSchedule members

Microsoft.SharePoint namespace