fb

Author: YunchuWang

src/ScheduledTasks/Models/ScheduleConfiguration.cs

@@ -93,7 +93,10 @@ public TimeSpan Interval
     }
 
     /// <summary>
-    /// Gets or sets a value indicating whether gets or sets whether the schedule should start immediately if it's late.
+    /// Gets or sets a value indicating whether to start the orchestration immediately when the current time is past the StartAt time.
+    /// By default it is false.
+    /// If false, the first run will be scheduled at the next interval based on the original start time.
+    /// If true, the first run will start immediately and subsequent runs will follow the regular interval.
     /// </summary>
     public bool StartImmediatelyIfLate { get; set; }
 

src/ScheduledTasks/Models/ScheduleCreationOptions.cs

@@ -11,7 +11,7 @@ public record ScheduleCreationOptions
     /// <summary>
     /// Initializes a new instance of the <see cref="ScheduleCreationOptions"/> class.
     /// </summary>
-    /// <param name="scheduleId">The ID of the schedule, or null to generate one.</param>
+    /// <param name="scheduleId">The ID of the schedule.</param>
     /// <param name="orchestrationName">The name of the orchestration to schedule.</param>
     /// <param name="interval">The time interval between schedule executions. Must be at least 1 second and cannot be negative.</param>
     public ScheduleCreationOptions(string scheduleId, string orchestrationName, TimeSpan interval)

src/ScheduledTasks/Models/ScheduleDescription.cs

@@ -46,7 +46,10 @@ public record ScheduleDescription
     public TimeSpan? Interval { get; init; }
 
     /// <summary>
-    /// Gets whether the schedule should run immediately if started late.
+    /// Gets a value indicating whether to start the orchestration immediately when the current time is past the StartAt time.
+    /// By default it is false.
+    /// If false, the first run will be scheduled at the next interval based on the original start time.
+    /// If true, the first run will start immediately and subsequent runs will follow the regular interval.
     /// </summary>
     public bool? StartImmediatelyIfLate { get; init; }
 

src/ScheduledTasks/Models/ScheduleUpdateOptions.cs

@@ -61,7 +61,10 @@ public TimeSpan? Interval
     }
 
     /// <summary>
-    /// Gets or initializes whether the schedule should start immediately if it's late.
+    /// Gets a value indicating whether to start the orchestration immediately when the current time is past the StartAt time.
+    /// By default it is false.
+    /// If false, the first run will be scheduled at the next interval based on the original start time.
+    /// If true, the first run will start immediately and subsequent runs will follow the regular interval.
     /// </summary>
     public bool? StartImmediatelyIfLate { get; init; }
 }