SimpleTrigger MembersQuartz.NET API Documentation

The SimpleTrigger type exposes the following members.

Constructors

  NameDescription
Public methodSimpleTrigger 
Create a SimpleTrigger with no settings.
Public methodSimpleTrigger(String)
Create a SimpleTrigger that will occur immediately, and not repeat.
Public methodSimpleTrigger(String, DateTime)
Create a SimpleTrigger that will occur at the given time, and not repeat.
Public methodSimpleTrigger(String, String)
Create a SimpleTrigger that will occur immediately, and not repeat.
Public methodSimpleTrigger(String, Int32, TimeSpan)
Create a SimpleTrigger that will occur immediately, and repeat at the the given interval the given number of times.
Public methodSimpleTrigger(String, String, DateTime)
Create a SimpleTrigger that will occur at the given time, and not repeat.
Public methodSimpleTrigger(String, String, Int32, TimeSpan)
Create a SimpleTrigger that will occur immediately, and repeat at the the given interval the given number of times.
Public methodSimpleTrigger(String, DateTime, Nullable DateTime , Int32, TimeSpan)
Create a SimpleTrigger that will occur at the given time, and repeat at the the given interval the given number of times, or until the given end time.
Public methodSimpleTrigger(String, String, DateTime, Nullable DateTime , Int32, TimeSpan)
Create a SimpleTrigger that will occur at the given time, and repeat at the the given interval the given number of times, or until the given end time.
Public methodSimpleTrigger(String, String, String, String, DateTime, Nullable DateTime , Int32, TimeSpan)
Create a SimpleTrigger that will occur at the given time, fire the identified IJob and repeat at the the given interval the given number of times, or until the given end time.
Top
Methods

  NameDescription
Public methodAddTriggerListener
Add the specified name of a ITriggerListener to the end of the Trigger's list of listeners.
(Inherited from Trigger.)
Public methodClearAllTriggerListeners
Remove all ITriggerListeners from the Trigger.
(Inherited from Trigger.)
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from Trigger.)
Public methodCompareTo
Compare the next fire time of this Trigger to that of another.
(Inherited from Trigger.)
Public methodComputeFirstFireTimeUtc
Called by the scheduler at the time a Trigger is first added to the scheduler, in order to have the Trigger compute its first fire time, based on any associated calendar.

After this method has been called, GetNextFireTimeUtc  should return a valid answer.

(Overrides Trigger ComputeFirstFireTimeUtc(ICalendar).)
Public methodComputeNumTimesFiredBetween
Computes the number of times fired between the two UTC date times.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Trigger.)
Public methodExecutionComplete
This method should not be used by the Quartz client.
(Inherited from Trigger.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetFireTimeAfter
Returns the next UTC time at which the SimpleTrigger will fire, after the given UTC time. If the trigger will not fire after the given time,   will be returned.
(Overrides Trigger GetFireTimeAfter(Nullable DateTime ).)
Public methodGetFireTimeBefore
Returns the last UTC time at which the SimpleTrigger will fire, before the given time. If the trigger will not fire before the given time,   will be returned.
Public methodGetHashCode
Serves as a hash function for a particular type. GetHashCode  is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Trigger.)
Public methodGetMayFireAgain
Determines whether or not the SimpleTrigger will occur again.
(Overrides Trigger GetMayFireAgain .)
Public methodGetNextFireTimeUtc
Returns the next time at which the SimpleTrigger will fire. If the trigger will not fire again,   will be returned. The value returned is not guaranteed to be valid until after the Trigger has been added to the scheduler.
(Overrides Trigger GetNextFireTimeUtc .)
Public methodGetPreviousFireTimeUtc
Returns the previous time at which the SimpleTrigger fired. If the trigger has not yet fired,   will be returned.
(Overrides Trigger GetPreviousFireTimeUtc .)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveTriggerListener
Remove the specified name of a ITriggerListener from the Trigger's list of listeners.
(Inherited from Trigger.)
Public methodSetNextFireTime
Set the next UTC time at which the SimpleTrigger should fire. This method should not be invoked by client code.
Public methodSetPreviousFireTime
Set the previous UTC time at which the SimpleTrigger fired. This method should not be invoked by client code.
Public methodToString
Return a simple string representation of this object.
(Inherited from Trigger.)
Public methodTriggered
Called when the IScheduler has decided to 'fire' the trigger (Execute the associated IJob), in order to give the Trigger a chance to update itself for its next triggering (if any).
(Overrides Trigger Triggered(ICalendar).)
Public methodUpdateAfterMisfire
Updates the SimpleTrigger's state based on the MisfireInstruction value that was selected when the SimpleTrigger was created.
(Overrides Trigger UpdateAfterMisfire(ICalendar).)
Public methodUpdateWithNewCalendar
Updates the instance with new calendar.
(Overrides Trigger UpdateWithNewCalendar(ICalendar, TimeSpan).)
Public methodValidate
Validates whether the properties of the JobDetail are valid for submission into a IScheduler.
(Overrides Trigger Validate .)
Protected methodValidateMisfireInstruction
Validates the misfire instruction.
(Overrides Trigger ValidateMisfireInstruction(Int32).)
Top
Fields

  NameDescription
Public fieldStatic memberRepeatIndefinitely
Used to indicate the 'repeat count' of the trigger is indefinite. Or in other words, the trigger should repeat continually until the trigger's ending timestamp.
Top
Properties

  NameDescription
Public propertyCalendarName
Get or set the ICalendar with the given name with this Trigger. Use   when setting to dis-associate a Calendar.
(Inherited from Trigger.)
Public propertyDescription
Get or set the description given to the Trigger instance by its creator (if any).
(Inherited from Trigger.)
Public propertyEndTimeUtc
Returns the date/time on which the trigger must stop firing. This defines the final boundary for trigger firings 舒 the trigger will not fire after to this date and time. If this value is null, no end time boundary is assumed, and the trigger can continue indefinitely. Sets the date/time on which the trigger must stop firing. This defines the final boundary for trigger firings 舒 the trigger will not fire after to this date and time. If this value is null, no end time boundary is assumed, and the trigger can continue indefinitely.
(Inherited from Trigger.)
Public propertyFinalFireTimeUtc
Returns the final UTC time at which the SimpleTrigger will fire, if repeatCount is RepeatIndefinitely, null will be returned.

Note that the return time may be in the past.

(Overrides Trigger FinalFireTimeUtc.)
Public propertyFireInstanceId
This method should not be used by the Quartz client.

Usable by IJobStore implementations, in order to facilitate 'recognizing' instances of fired Trigger s as their jobs complete execution.

(Inherited from Trigger.)
Public propertyFullJobName
Returns the 'full name' of the IJob that the Trigger points to, in the format "group.name".
(Inherited from Trigger.)
Public propertyFullName
Returns the 'full name' of the Trigger in the format "group.name".
(Inherited from Trigger.)
Public propertyGroup
Get the group of this Trigger. If  , Scheduler.DefaultGroup will be used.
(Inherited from Trigger.)
Public propertyHasAdditionalProperties
Gets a value indicating whether this instance has additional properties that should be considered when for example saving to database.
(Inherited from Trigger.)
Public propertyHasMillisecondPrecision
Tells whether this Trigger instance can handle events in millisecond precision.
(Overrides Trigger HasMillisecondPrecision.)
Public propertyJobDataMap
Get or set the JobDataMap that is associated with the Trigger.

Changes made to this map during job execution are not re-persisted, and in fact typically result in an illegal state.

(Inherited from Trigger.)
Public propertyJobGroup
Gets or sets the name of the associated JobDetail's group. If set with  , Scheduler.DefaultGroup will be used.
(Inherited from Trigger.)
Public propertyJobName
Get or set the name of the associated JobDetail.
(Inherited from Trigger.)
Public propertyKey
Gets the key.
(Inherited from Trigger.)
Public propertyMisfireInstruction
Get or set the instruction the IScheduler should be given for handling misfire situations for this Trigger- the concrete Trigger type that you are using will have defined a set of additional MISFIRE_INSTRUCTION_XXX constants that may be passed to this method.

If not explicitly set, the default value is InstructionNotSet.

(Inherited from Trigger.)
Public propertyName
Get or sets the name of this Trigger.
(Inherited from Trigger.)
Public propertyPriority
The priority of a Trigger acts as a tie breaker such that if two Triggers have the same scheduled fire time, then Quartz will do its best to give the one with the higher priority first access to a worker thread.
(Inherited from Trigger.)
Public propertyRepeatCount
Get or set thhe number of times the SimpleTrigger should repeat, after which it will be automatically deleted.
Public propertyRepeatInterval
Get or set the the time interval at which the SimpleTrigger should repeat.
Public propertyStartTimeUtc
The time at which the trigger's scheduling should start. May or may not be the first actual fire time of the trigger, depending upon the type of trigger and the settings of the other properties of the trigger. However the first actual first time will not be before this date.
(Inherited from Trigger.)
Public propertyTimesTriggered
Get or set the number of times the SimpleTrigger has already fired.
Public propertyTriggerListenerNames
Returns an array of String s containing the names of all ITriggerListeners assigned to the Trigger, in the order in which they should be notified.
(Inherited from Trigger.)
Public propertyVolatile
Whether or not the Trigger should be persisted in the IJobStore for re-use after program restarts.

If not explicitly set, the default value is  .

(Inherited from Trigger.)
Top
See Also