Class X2FlowApiCall

X2FlowAction that calls a remote API

CComponent

Extended by

X2FlowItem

Extended by

X2FlowAction

Extended by

X2FlowApiCall

Package: application\components\x2flow\actions
Located at x2engine/protected/components/x2flow/actions/X2FlowApiCall.php

Methods summary
`public`	# `getMakeRequest( )` Allows request behavior of this class to be toggled during unit tests Allows request behavior of this class to be toggled during unit tests
`public array`	# `paramRules( )` Returns `array` the param rules. Overrides `X2FlowAction::paramRules()`
`public array`	# `getHeaders( array $headerRows, mixed $params )` Parameters `$headerRows` `array` $headerRows `$params` Returns `array`
`public string`	# `formatHeaders( array $headers )` Parameters `$headers` `array` $headers Returns `string`
`public`	# `validateOptions( boolean & $paramRules, mixed $params = null, mixed $staticValidation = false )` Override parent method to add url validation. Present warning to user on flow save if specified url points to same server as the one X2Engine is hosted on. Override parent method to add url validation. Present warning to user on flow save if specified url points to same server as the one X2Engine is hosted on. Parameters `$paramRules` `boolean` $staticValidation If true, validation will include checks for warnings `$params` `$staticValidation` Overrides `X2FlowItem::validateOptions()`
`public boolean`	# `execute( mixed & $params )` Runs the automation action with provided params. Runs the automation action with provided params. Returns `boolean` the result of the execution

Methods inherited from X2FlowAction
`getActionInstances(), getActionTypes(), getEventType(), getNotifType(), setModelAttributes(), validate()`

Methods inherited from X2FlowItem
`calculateTimeOffset(), create(), getInstances(), getParamRules(), getTitle(), parseOption(), validateDropdown(), validateEmail()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Constants inherited from X2FlowItem
`VALIDATION_WARNING`

Properties summary
`public string`	`$title`	`'Remote API Call'`	#
`public string`	`$info`	`'Call a remote API by requesting the specified URL. You can specify the request type, HTTP headers, and any variables to be passed with the request.'`	# $var string the description of this action $var string the description of this action

Properties inherited from X2FlowAction
`$trigger`

Properties inherited from X2FlowItem
`$_instances, $config, $label, $requiresCron`