Ares Addon System Events
Ares has a number of system events which can be broken down into two categories.
Route System Event
Argument: RouteAddonEventArgs
This system event is raised when an item is routed in the Client and no custom routing rules apply to it. If an addon decides it is appropriate to route an item, it should do so using the "Route" command.
Properties
RouteAddonEventArgs has the following properties:
| ItemId (int) | The ID of the item being routed. |
|---|---|
| Handled (boolean) | whether or not custom routing has been handled for this item. An addon should first check this property to see if another addon has already performed custom routing. If this is false and an addon routes this item, it should set this argument property to true so that other addons know it has already been processed. |
| CurrentStatus (string) | The status of the item after its initial route, before it was passed on to the addon system. |
DataContext
| Item | An Item object representing the item being routed. |
|---|---|
| Course | A Course object representing the course the item belongs to. |
| Instructor | A User object representing the instructor of the course. As of Ares v5.0, the instructor user object is no longer accessible to addons. Addon's can still read (but not write) the Instructor and InstructorDisplayName fields for the courses. |
Item Processes
Argument: ItemProcessedEventArgs
These system events are raised when the respective process is applied to an item. The remaining system events are all triggered by item processes and function the same.
System Event: "ItemAwaitingStacksSearching", "ItemAvailableAtDesk", "ItemInTransit", "ItemRecalled", "ItemCancelled"
Properties
ItemProcessedEventArgs has the following property:
| Item (Item) | The Item being processed. |
|---|
DataContext
None