Milestones¶

Represents a list of milestones associated with a case. Milestones are used to track events and measure progress against time-based goals, such as SLAs or KPIs.

Milestones are identified and referenced by their name, and multiple milestones can be defined for a single case.

Use Milestones.Add to create a new milestone. Milestones start automatically upon creation. Use Milestones.Pause and Milestones.Resume to temporarily pause and resume milestones. Mark a milestone as completed with Milestones.Stop or cancel it with Milestones.Cancel.

Capabilities¶

Management and Retrieval¶

• Milestones.Add: Adds a new milestone to the list and starts it immediately.
• Milestones.AddFrom: Adds a new milestone to the list and starts it immediately, using a specified start date and time.
• Milestones.Get: Gets a milestone by its name.
• Milestones.Start: Restarts a milestone if it already exists; otherwise, creates a new milestone with the specified name and starts it immediately.
• Milestones.ToArray: Returns all defined milestones.

Lifecycle Control¶

• Milestones.Cancel: Cancels (aborts) a milestone.
• Milestones.CancelAll: Cancels (aborts) all milestones that are currently paused or in progress.
• Milestones.Pause: Pauses a milestone if found and returns the milestone instance.
• Milestones.PauseAll: Pauses all milestones that are currently in progress.
• Milestones.Resume: Resumes a milestone that was previously paused, if found.
• Milestones.ResumeAll: Resumes all milestones that are currently paused.
• Milestones.Stop: Stops a milestone and marks it as completed.
• Milestones.StopAll: Stops all milestones that are currently paused or in progress.