Frontend | Backend | Api

Hooks\Models\Backend\HttpRequestAction

HttpRequestAction Entity

Method Description Returns
getUrl() string
getMethod() string
getHeaders() string
getRetries() int
getTimeout() int
getAcceptedStatusCodes() string
getTemplate() string
getTemplateCode() string
getType() Get the type of the action, which is the object name without namespace for the action string
getDisplayType() Get Nice Name for Action Class string
getAvailablePreviousActions() Get the available previous actions Collection
getId() int
getName() string
getText() string
getPosition() int
getData() array
getCreated() DateTime
getModified() DateTime
getHook() Get the Hook this Action is assigned to Hook
getParent() BaseAction
getPublished() DateTime
isPublished() bool
isContainedInLoop() Check whether the action is contained in a loop bool
getContainingLoop() Get the loop this action is contained in Loop
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
isVersionedModel() Check whether a model is versioned bool
getAvailableMethods() Get the http method types to display array
getDisplayIcon() Get the display icon to use when rendering the action string
getMaxRetries() Get the maximum number of retries int
getMinTimeout() Get the minimum timeout (in seconds) int
getMaxTimeout() Get the maximum timeout (in seconds) int
getAcceptedStatusCodeRegex() Get the regular expression used for valid accepted status codes string
getRunDataVariables() Get the run data variables provided by this action array
getHateoasLinks() Get the HATEOAS links for the record array
getEditUrl() Get the url for editing the record. string
getMoveUrl() Get the url for moving the record. string
getDeleteUrl() Get the url for deleting the record. string
getAvailableTemplates() Get a listing of all templates under templates/hooks array
getAvailableTemplateVariables() Get the template variables available in this action array