`scan(options)`

バーコードのスキャンを開始するには、この関数を使用します。

構文

1import { getBarcodeScanner } from 'lightning/mobileCapabilities';
2scan(options: BarcodeScannerOptions): Promise<Object>

パラメータ

options — (必須) のスキャンセッションを設定するための BarcodeScannerOptions オブジェクト。

戻り値

スキャンされたバーコードの詳細を使用して Barcode オブジェクトの配列として解決される Promise オブジェクト。

却下された Promise では、BarcodeScannerFailure が返されます。

使用方法

この関数は、スキャナリソースを割り当てます。スキャンの完了時にリソースをリリースするには、dismiss() とペアにします。

1myScanner
2  .scan(scanningOptions)
3  .then((result) => {
4    // Do something with the result of the scan
5    console.log(result);
6    this.scannedBarcode = result.value;
7  })
8  .catch((error) => {
9    // Handle cancellation and scanning errors here
10    console.error(error);
11  })
12  .finally(() => {
13    myScanner.dismiss();
14  });

この関数がコールされると、モバイル OS スキャンユーザインターフェースがモバイルデバイスに表示されます。ユーザは、カメラをバーコードに向けて、バーコードが認識されるまで待ちます。

バーコードが正常にスキャンされると、達成された Promise を介して結果が返されます。then 句で正常な結果を処理します。
バーコードのスキャンに失敗すると、却下された Promise を介してエラーが返されます。catch 句でエラーを処理します。
ユーザがスキャン中に [キャンセル] ボタンをクリックすると、Promise は userDismissedScanner の BarcodeScannerFailure.code 値で却下されます。
スキャンが成功してもエラーでも、モバイル OS スキャナインターフェースは表示されたままになります。スキャナインターフェースを閉じるには、コンポーネントのインターフェースに戻り、dismiss() をコールします。
finally 句で、最終的なクリーンアップの処理 (dismiss() のコールなど) を行います。

関連トピック

BarcodeScanner の例 – 最新のスキャン API

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。