beginCapture(options) (従来)

新しいスキャンセッションを開始するには、この関数を使用します。

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

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

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

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

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

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

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

関連トピック