lightning:flow

lightning:flow コンポーネントは、Lightning ランタイムでのフローインタビューを表します。

name 属性で、表示するフローを指定します。該当するフローがある場合、inputVariables 属性を使用してそのフローの入力変数を初期化します。

次の例では「Calculate Discounts (商談の割引計算)」フロー (「割引計算機能の構築」Trailhead プロジェクトのもの) を表示します。inputVariables 属性は Opportunity.Id と Opportunity.AccountId をフローの入力変数に渡します。

1<aura:component>
2   <aura:handler name="init" value="{!this}" action="{!c.init}"/>
3   <lightning:flow aura:id="flow” onstatuschange="{!c.statusChange}"/>
4</aura:component>

クライアント側コントローラでインタビューの入力変数を初期化した後、インタビューを開始して、インタビューの完了時に何を行うのかを決定します。

1({
2  init : function (cmp) {
3    var flow = cmp.find("flow");
4    var inputVariables = [
5      {
6        name : 'OpportunityID',
7        type : 'String',
8        value : 'Opportunity.Id'
9      },
10      {
11        name : 'AccountID',
12        type : 'String',
13        value : 'Opportunity.AccountId'
14      }
15    ];
16    flow.startFlow("Calculate_discounts", inputVariables);
17  },
18
19  statusChange : function (cmp, event) {
20    if(event.getParam('status') === "FINISHED") {
21      //Do something
22    }
23  }
24})

参照されるフローが有効化されている必要があります。

フローインタビューの有効な状況は、次のとおりです。

• STARTED: インタビューは正常に開始しました。
• PAUSED: インタビューは正常に一時停止しました。
• FINISHED: 画面を伴うフローのインタビューが完了しました。
• FINISHED_SCREEN: 画面を伴わないフローのインタビューが完了し、コンポーネントは「フローが終了しました」というメッセージのデフォルト画面を表示しています。
• ERROR: 問題が発生して、インタビューに失敗しました。

各フローコンポーネントには、ナビゲーションボタン (戻る、次へ、一時停止、完了) が含まれており、フロー内を移動できます。デフォルトでは、フローが完了すると、コンポーネントは新しいインタビューの最初の画面を再読み込みします。フローが完了したときの動作をカスタマイズするには、状況に FINISHED が含まれる場合の onstatuschange アクションのイベントハンドラを追加します。

このコンポーネントは、次のメソッドをサポートします。