ModelHooks module

ScheduledBatchEvent

Batch event containing information about which task triggered the event

A model in the Hooks module, with 11 members for templates, 8 API properties and 11 members for admin templates.

Hooks\Models\Frontend\ScheduledBatchEvent Hooks\Models\Api\ScheduledBatchEvent Hooks\Models\Backend\ScheduledBatchEvent Also in Hooks: AgentAction Batch BatchAction Category Condition ConditionElse ConditionIf CreateFileAction CreateRecordAction DeleteRecordAction EntityBatchEvent EntityEvent Hook HttpRequestAction HttpResponseAction Loop LoopElement MergeFilesAction MergeToPDFAction RenderTemplateAction RetrieveRecordsAction SendMailAction SourceHookBatchEvent StopAction TriggerHookAction UpdateRecordAction WebBatchEvent WebEvent
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 11

Take no arguments.

# getType()
string
Get the type of the event causing the hook execution. Always returns 'scheduled' for scheduled events.
# getTask()
?Task
Return the task that triggered this hook
# getTypeDisplay()
string
Get a string representation of the batch event based on its type
# getDataDisplay()
string
Get a string representation of additional batch event source data for the table. Empty by default.
# getId()
?int
# getCreated()
?DateTime
Date the record was created.
# getCreatedBy()
?User
Get the user that triggered the event
# getBatch()
?Batch
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 8

Read-only values on the record.

# type
string
Get the type of the event causing the hook execution. Always returns 'scheduled' for scheduled events.
# task
?Task
Return the task that triggered this hook
# typeDisplay
string
Get a string representation of the batch event based on its type
# dataDisplay
string
Get a string representation of additional batch event source data for the table. Empty by default.
# id
?int
# created
?DateTime
Date the record was created.
# createdBy
?User
Get the user that triggered the event
# batch
?Batch

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 11

Take no arguments.

# getType()
string
Get the type of the event causing the hook execution. Always returns 'scheduled' for scheduled events.
# getTask()
?Task
Return the task that triggered this hook
# getTypeDisplay()
string
Get a string representation of the batch event based on its type
# getDataDisplay()
string
Get a string representation of additional batch event source data for the table. Empty by default.
# getId()
?int
# getCreated()
?DateTime
Date the record was created.
# getCreatedBy()
?User
Get the user that triggered the event
# getBatch()
?Batch
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned