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

Information about the current state change. More...

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

Properties

ScheduleState State [get]
 The state that was entered.
 
Guid PlanerID [get]
 To avoid confusion between different planners.
 
string PlanerName [get]
 If you need to identify the planer to the user, use this.
 
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

string AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs.AbortReason
getabstract

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

Guid AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs.PlanerID
getabstract

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

string AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs.PlanerName
getabstract

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

Definition at line 124 of file MiscInterfaces.cs.

124{ get; }

◆ State

ScheduleState AxelSemrau.Chronos.Plugin.ScheduleStateEventArgs.State
getabstract

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: