Lightning Aura Components Developer Guide
jNewer Version Available
Configure the Client-Side Controller for a Flow Local Action
When a component is executed as a flow local action, the flow calls the invoke method in the client-side controller. To run the code
asynchronously in your client-side controller, such as when you're making an XML HTTP request
(XHR), return a Promise. When the method finishes or the Promise is fulfilled, control is
returned back to the flow.
Asynchronous Code
When a Promise is resolved, the next element in the flow is executed. When a Promise is rejected or hits the timeout, the flow takes the local action's fault connector and sets $Flow.FaultMessage to the error message.
By default, the error message is “An error occurred when the elementName element tried to execute the c:myComponent component.” To customize the error message in $Flow.FaultMessage, return it as a new Error object in the reject() call.
1({
2 invoke : function(component, event, helper) {
3 return new Promise(function(resolve, reject) {
4 // Do something asynchronously, like get data from
5 // an on-premise database
6
7 // Complete the call and return to the flow
8 if (/* request was successful */) {
9 // Set output values for the appropriate attributes
10 resolve();
11 } else {
12 reject(new Error("My error message")); }
13 });
14 }
15})Synchronous Code
When the method finishes, the next element in the flow is executed.
1({
2 invoke : function(component, event, helper) {
3 // Do something synchronously, like open another browser tab
4 // with a specified URL
5
6 // Set output values for the appropriate attributes
7 }
8 })