Struct AddCalendarOptions

Namespace

Quartz

Assembly

Quartz.dll

How a calendar is added to the scheduler.

public readonly record struct AddCalendarOptions : IEquatable<AddCalendarOptions>

Implements

IEquatable<AddCalendarOptions>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Defaults are the conservative ones: nothing is replaced, and no trigger is touched. So default — which is what omitting the argument gives — is "register it, change nothing else", and there is no third state between "not given" and "all defaults" for an implementer to have to guess about.

Properties

Replace

Whether an already registered calendar with the same name is over-written. When false, adding a calendar whose name already exists throws ObjectAlreadyExistsException.

public bool Replace { get; init; }

Property Value

bool

Replacing

Over-write an already registered calendar with the same name, leaving the triggers that reference it alone. The name for new AddCalendarOptions { Replace = true }.

public static AddCalendarOptions Replacing { get; }

Property Value

AddCalendarOptions

ReplacingAndUpdatingTriggers

Over-write an already registered calendar with the same name and re-compute the next fire time of every trigger that references it. The name for new AddCalendarOptions { Replace = true, UpdateTriggers = true }, which is what replacing a calendar whose exclusions have actually moved calls for.

public static AddCalendarOptions ReplacingAndUpdatingTriggers { get; }

Property Value

AddCalendarOptions

UpdateTriggers

Whether triggers that reference a calendar of this name have their next fire time re-computed against the new calendar.

public bool UpdateTriggers { get; init; }

Property Value

bool

See Also

AddCalendar(string, ICalendar, AddCalendarOptions, CancellationToken)