Documentation

FlowController extends BasePublicApiController
in package

Tags
Path

("/flow") Class FlowController

subpackage

Api\Controllers

Table of Contents

FLOW_HOOK  = 'flowControllerHook'
INSERT_FLOW_HOOK  = 'insert.to.flow.hook'
$container  : Container
$database  : Explorer
$translator  : Translator
$flowFactory  : FlowFactory
$hookManager  : ModelHooks
__construct()  : mixed
getFlow()  : ApiResponse
setFlow()  : ApiResponse

Constants

INSERT_FLOW_HOOK

public mixed INSERT_FLOW_HOOK = 'insert.to.flow.hook'

Properties

Methods

__construct()

public __construct(Container $container, Explorer $database) : mixed
Parameters
$container : Container
$database : Explorer
Return values
mixed —

getFlow()

public getFlow(ApiRequest $request, ApiResponse $response) : ApiResponse
Parameters
$request : ApiRequest
$response : ApiResponse
Tags
Path

("/{flowName}")

Method

("GET")

RequestParameters

({ @RequestParameter(name="flowName", type="string", description="Flow name") })

throws
JsonException
Return values
ApiResponse —

setFlow()

public setFlow(ApiRequest $request, ApiResponse $response) : ApiResponse
Parameters
$request : ApiRequest
$response : ApiResponse
Tags
Path

("/setFlow")

Method

("POST")

throws
JsonException
Return values
ApiResponse —

Search results