Table of Contents

Interface IScheduleSpec

Namespace
Excalibur.Dispatch.Delivery
Assembly
Excalibur.Dispatch.Abstractions.dll

Defines the scheduling specification for a message including cron expression, timezone, interval, next execution time, and enabled state.

public interface IScheduleSpec
Extension Methods

Properties

CronExpression

Gets or sets the cron expression that defines the recurring execution schedule.

string CronExpression { get; set; }

Property Value

string

A valid cron expression string defining when the message should be executed.

CronRecurrenceProfileId

Gets or sets the explicit persisted cron transition profile identifier.

string? CronRecurrenceProfileId { get; set; }

Property Value

string

Remarks

Pair with CronRecurrenceProfileVersion. The supported pair is CronosCompatible. A missing declaration is permitted only for non-cron or provably transition-free installed zones. Unknown, partial or mismatched declarations never fall back silently. Existing captured UTC occurrences retain their admitted authority; future admissions require valid configuration.

CronRecurrenceProfileVersion

Gets or sets the semantic version paired with CronRecurrenceProfileId.

int? CronRecurrenceProfileVersion { get; set; }

Property Value

int?

Enabled

Gets or sets a value indicating whether this scheduled message is active and should be executed.

bool Enabled { get; set; }

Property Value

bool

True if the schedule is active; false to pause execution without deleting the schedule.

Interval

Gets or sets the fixed interval for simple recurring schedule patterns.

TimeSpan? Interval { get; set; }

Property Value

TimeSpan?

A TimeSpan representing the interval between executions. Null indicates this is not an interval-based schedule.

NextExecutionUtc

Gets or sets the next scheduled execution time in UTC for efficient querying and execution planning.

DateTimeOffset? NextExecutionUtc { get; set; }

Property Value

DateTimeOffset?

The UTC timestamp when this message should next be executed, or null if the schedule is complete.

TimeZoneId

Gets or sets the timezone identifier for evaluating cron expressions in local time.

string? TimeZoneId { get; set; }

Property Value

string

A standard timezone identifier (e.g., "America/New_York", "Europe/London"). Null indicates UTC.