| Method | Description | Returns |
|---|---|---|
| getType() | Get the type of the event causing the hook execution. Always returns 'scheduled' for scheduled events. | string |
| getTask() | Return the task that triggered this hook | Task |
| getTypeDisplay() | Gets a string representation of the batch event based on its type | string |
| getRecordDisplay() | Gets a string representation of the batch event record. By default, there is no record. | string |
| getId() | int | |
| getCreated() | Date the record was created. | DateTime |
| getBatch() | Batch | |
| isNewRecord() | Check if the record is a new record | bool |
| getPropertyValueOrigin(string $property) | Get the origin of a property value => how it has been filled | string |
| isHierarchicalModel() | Check whether a model is a hierarchical model, i.e. can have children | bool |
Hooks\Models\Frontend\ScheduledBatchEvent
Batch event containing information about which task triggered the event