この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

lightning:flow

Lightning ランタイムでのフローインタビューを表します。このコンポーネントでは、API バージョン 41.0 以降が必要です。

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

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

次の例では「Survey Customers (顧客調査)」フロー (「満足度調査の作成」Trailhead プロジェクトのもの) を表示します。

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

クライアント側コントローラで、開始するフローを指定します。

1({
2  init : function (cmp) {
3    var flow = cmp.find("flowData");
4    flow.startFlow("Survey_customers");
5  }
6})

使用上の考慮事項

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

onstatuschange アクションは次のパラメータを返します。

パラメータ	型	説明
activeStages	Object[]	フローの `$Flow.ActiveStages` 変数の現在の値。API バージョン 42.0 以降で利用できます。
currentStage	Object	フローの `$Flow.CurrentStage` 変数の現在の値。API バージョン 42.0 以降で利用できます。
flowTitle	String	フローの表示ラベル。
helpText	String	現在の画面のヘルプテキスト。API バージョン 42.0 以降で利用できます。
guid	String	インタビューの GUID。API バージョン 42.0 以降で利用できます。
outputVariables	Object[]	フローの出力変数の現在の値。
status	String	インタビューの現在の状況。フローインタビューの有効な状況は、次のとおりです。 `STARTED`: インタビューは正常に開始しました。 `PAUSED`: インタビューは正常に一時停止しました。 `FINISHED`: 画面を伴うフローのインタビューが完了しました。 `FINISHED_SCREEN`: 画面を伴わないフローのインタビューが完了し、コンポーネントは「フローが終了しました」というメッセージのデフォルト画面を表示しています。 `ERROR`: 問題が発生して、インタビューに失敗しました。

フローの完了動作のカスタマイズ

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

メソッド

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

startFlow(flowName, inputVariables): フローインタビューを開始します。

flowName (String): 表示するフローの一意の名前。
inputVariables (Object[]): フロー入力変数の初期値を設定します。

resumeFlow(interviewId): 一時停止中のフローインタビューを再開します。

interviewId (String): 再開するインタビューの ID。

詳細は、「フロー Lightning コンポーネントの操作」を参照してください。

属性

属性名	属性型	説明
`body`	Component[]	コンポーネントのボディ。マークアップでは、これはタグのボディに含まれるすべてを指します。
`class`	String	コンポーネントの基本クラスに加え、外部要素の CSS クラス。
`title`	String	マウスポインタが要素に重ねられたときにツールチップテキストを表示します。
`onstatuschange`	Action	インタビューの状況が変更されたときや新しい画面が表示されたときにトリガされるアクション。

Lightning コンポーネント開発者ガイド

lightning:flow

属性