ModelHooks module

AgentAction

AgentAction Entity

A model in the Hooks module, with 22 members for templates, 19 API properties and 29 members for admin templates.

Hooks\Models\Frontend\AgentAction Hooks\Models\Api\AgentAction Hooks\Models\Backend\AgentAction Also in Hooks: Batch BatchAction Category Condition ConditionElse ConditionIf CreateFileAction CreateRecordAction DeleteRecordAction EntityBatchEvent EntityEvent Hook HttpRequestAction HttpResponseAction Loop LoopElement MergeFilesAction MergeToPDFAction RenderTemplateAction RetrieveRecordsAction ScheduledBatchEvent SendMailAction SourceHookBatchEvent StopAction TriggerHookAction UpdateRecordAction WebBatchEvent WebEvent

Templates view

Properties 22

Take no arguments.

# getAgentInstall(): ?Install; Get the agent install this action invokes. Nullable at the persistence level (the FK is SET NULL when the install is deleted), but required at authoring time by the constraint below.
# getTemplate(): ?string
# getTemplateCode(): ?string
# getType(): string; Get the type of the action, which is the object name without namespace for the action
# getDisplayType(): string; Get Nice Name for Action Class
# getAvailablePreviousActions(): Collection; Get the available previous actions
# getId(): ?int
# getName(): ?string
# getText(): ?string
# getPosition(): ?int
# getData(): ?array
# getCreated(): ?DateTime
# getModified(): ?DateTime
# getHook(): ?Hook; Get the Hook this Action is assigned to
# getParent(): ?BaseAction
# getPublished(): ?DateTime
# isPublished(): bool
# isContainedInLoop(): bool; Check whether the action is contained in a loop
# getContainingLoop(): ?Loop; Get the loop this action is contained in
# 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 19

Read-only values on the record.

# agentInstall: ?Install; Get the agent install this action invokes. Nullable at the persistence level (the FK is SET NULL when the install is deleted), but required at authoring time by the constraint below.
# template: ?string
# templateCode: ?string
# type: string; Get the type of the action, which is the object name without namespace for the action
# displayType: string; Get Nice Name for Action Class
# availablePreviousActions: Collection; Get the available previous actions
# id: ?int
# name: ?string
# text: ?string
# position: ?int
# data: ?array
# created: ?DateTime
# modified: ?DateTime
# hook: ?Hook; Get the Hook this Action is assigned to
# parent: ?BaseAction
# published: ?DateTime
# published: bool
# containedInLoop: bool; Check whether the action is contained in a loop
# containingLoop: ?Loop; Get the loop this action is contained in

Admin view

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

Properties 29