BarcodeScanner API の使用

バーコードスキャン機能を含む Lightning コンポーネントを開発するには、BarcodeScanner API を使用します。

BarcodeScanner をコンポーネント定義にインポートして、BarcodeScanner API 関数をコードで使用できるようにします。
スキャンライフサイクル関数をコールする前にテストを実行して、BarcodeScanner を使用できることを確認します。
スキャンライフサイクル関数を使用して、スキャンを開始、継続および停止します。

開発を効率化するために、LWC スキャンコードで最新の scan() および dismiss() API を使用することをお勧めします。従来の beginCapture() API、resumeCapture() API、endCapture() API は引き続き使用できますが、将来のリリースで廃止される予定です。

コンポーネントの JavaScript ファイルで、標準 JavaScript import ステートメントを使用して BarcodeScanner をインポートします。具体的には、次のように lightning/mobileCapabilities モジュールから getBarcodeScanner() ファクトリ関数をインポートします。

コンポーネントにインポートされたら、ファクトリ関数を使用して BarcodeScanner のインスタンスを取得します。BarcodeScanner インスタンスでは、ユーティリティ関数と定数を使用して、スキャナを使用できるかどうかを確認し、スキャンを設定します。スキャンライフサイクル関数を使用して、スキャン操作を実行します。

BarcodeScanner は、物理デバイスのハードウェアおよびプラットフォーム機能に連動します。BarcodeScanner を使用するコンポーネントは、デスクトップコンピュータでエラーなく表示されますが、スキャン機能は動作しません。このようなエラーを回避するには、使用する前に BarcodeScanner 機能を使用できるかどうかをテストします。

BarcodeScanner でのスキャンは、スキャンライフサイクル関数を使用すると簡単に行えます。

scan(options) によってスキャンを開始します。
Promise の形式で返されたスキャンの結果を処理します。
dismiss() を使用してスキャンを終了します。

次に例を示します。

スキャン結果の処理方法やエラーの処理方法などについての詳細は、scan(options) を参照してください。

関連トピック

BarcodeScanner API