Chronos Plugins 5.4.0
This documentation covers the plugin interfaces definitions and an example implementation.
Loading...
Searching...
No Matches
AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs Class Reference

Information about the current state change. More...

+ Inheritance diagram for AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs:
+ Collaboration diagram for AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs:

Properties

abstract ScheduleState State [get]
 The state that was entered.
 
abstract Guid PlanerID [get]
 To avoid confusion between different planners.
 
abstract string PlanerName [get]
 If you need to identify the planer to the user, use this.
 
abstract string AbortReason [get]
 Contains the error message in case the schedule was aborted because of an error.
 

Detailed Description

Information about the current state change.

Definition at line 105 of file MiscInterfaces.cs.

Property Documentation

◆ AbortReason

abstract string AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs.AbortReason
get

Contains the error message in case the schedule was aborted because of an error.

Definition at line 128 of file MiscInterfaces.cs.

128{ get; }

◆ PlanerID

abstract Guid AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs.PlanerID
get

To avoid confusion between different planners.

You can use this as a unique marker if you, for example, have a task that should do something only once per planer no matter how often it is included.

Definition at line 119 of file MiscInterfaces.cs.

119{ get; }

◆ PlanerName

abstract string AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs.PlanerName
get

If you need to identify the planer to the user, use this.

Definition at line 124 of file MiscInterfaces.cs.

124{ get; }

◆ State

abstract ScheduleState AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs.State
get

The state that was entered.

Definition at line 110 of file MiscInterfaces.cs.

110{ get; }

The documentation for this class was generated from the following file: