Frontend | Backend | Api

Hooks\Models\Api\RetrieveRecordsAction

Class for specification of an action to retrieve a record

Property Description Returns
entity Get the entity which should be retrieved string
criteria Get the criteria that should be passed to the handler when searching for the record array
orderBy Get the order that should be applied when retrieving records array
limit Get the limit for retrieving records string
offset Get the offset when retrieving records string
type Get the type of the action, which is the object name without namespace for the action string
displayType Get Nice Name for Action Class string
availablePreviousActions Get the available previous actions Collection
id int
name string
text string
position int
data array
created DateTime
modified DateTime
hook Get the Hook this Action is assigned to Hook
parent BaseAction
published DateTime
published bool
containedInLoop Check whether the action is contained in a loop bool
containingLoop Get the loop this action is contained in Loop