BarcodeScanner データ型

BarcodeScanner は複数のデータ型を定義します。

スキャンされたバーコードを表すオブジェクト。

プロパティ名	型	説明	例
type	`BarcodeType` (string 型の列挙)	認識されたバーコードの種別。使用可能な値は、`BarcodeScanner.barcodeTypes` に列挙されています。	`'ean13'` (`myScanner.barcodeTypes.EAN_13` の文字列値) `'qr'` (`myScanner.barcodeTypes.QR` の文字列値)
value	String	バーコードの復号化された値。	`'9781984825193'` `'https://developer.salesforce.com/'`

バーコードスキャンセッションの設定の詳細を表すオブジェクト。

プロパティ名	型	説明	例
`barcodeTypes`	`BarcodeType[]`	省略可能。スキャン対象のバーコードの種別を指定します。使用可能な値は、`BarcodeScanner.barcodeTypes` に列挙されています。デフォルトは、サポートされるすべてのバーコード種別です。	`[myScanner.barcodeTypes.EAN_13, myScanner.barcodeTypes.QR, myScanner.barcodeTypes.DATA_MATRIX]`
`instructionText`	String	省略可能。スキャンインターフェースに表示する指示を指定します。デフォルトはテキストなしです。	「棚にある次の品目をスキャンする」
`successText`	String	省略可能。バーコードが正常にスキャンされた場合にスキャンインターフェースに表示するメッセージを指定します。デフォルトはテキストなしです。	「品目がスキャンされました」
`showSuccessCheckMark`	Boolean	省略可能。スキャンが成功したときにチェックマークを表示するかどうかを指定します。デフォルト設定は `true` です。	`false`
`vibrateOnSuccess`	Boolean	省略可能。スキャンが成功したときにデバイスをバイブレーションさせるかどうかを決定します。デフォルト設定は `true` です。	`false`
`scannerSize`	String	省略可能。スキャナのカメラビューのサイズを変更します。指定できるオプションは、ユーザのデバイスの画面サイズに対する割合を表しています。 `SMALL`: 25% `MEDIUM`: 33% `LARGE`: 50% `XLARGE`: 75% デフォルトは `XLARGE` です。	'MEDIUM'
`cameraFacing`	String	省略可能。前向きと後向きのどちらのカメラを使用するかを指定します。デフォルトは「BACK」です。指定できるオプションには「FRONT」および「BACK」があります。指定したカメラの向きがユーザのデバイスでサポートされていない場合は、エラーが返されます。	'FRONT'
`backgroundViewHTML`	String	省略可能。スキャナの標準 UI を使用せずに、カスタム UI を定義します。デフォルトは none です。このパラメータに値を指定しない場合は、標準 UI が使用されます。カスタム UI を使用する場合は、スキャナの終了に使用する標準の [キャンセル] ボタンを含め、標準 UI が完全に置き換えられます。カスタム UI を定義する場合、スキャナの終了を処理するのは、コール元の責任です。
`presentWithAnimation`	Boolean	省略可能。スキャナを表示および終了するときにそれに対応するアニメーションを表示するかどうかを指定します。デフォルト設定は `true` です。	`false`
`manualConfirmation`	Boolean	省略可能。検出されたバーコードをスキャンするどうかをユーザが手動で確認するかどうかを決定します。デフォルト設定は `false` です。	`true`
`previewBarcodeData`	Boolean	省略可能。スキャナがスキャン中にバーコードデータを表示するかどうかを決定します。デフォルト設定は `true` です。バーコードのプレビューは、`backgroundViewHTML` が省略されている場合にのみサポートされます。	`false`
`enableBulkScan`	Boolean	省略可能。スキャンされたバーコードの結果がコール元に返される前に、スキャナがその結果を収集するかどうかを決定します。デフォルト設定は `false` です。`true` に設定されている場合、スキャンされたバーコードの結果がスキャナによって収集され、画面に表示されます。ユーザが [完了] をタップすると、スキャンされたバーコードデータがコール元に返されます。	`true`
`enableMultiScan`	Boolean	省略可能。スキャナが複数のバーコードを同時に検出するかどうかを決定します。デフォルト設定は `false` です。このパラメータを `true` に設定すると、`enableBulkScan` パラメータも `true` に設定されます。	`true`

バーコードをスキャンしようとしたときに発生したエラーを表すオブジェクト。

プロパティ名	型	説明
code	`BarcodeScannerFailureCode` (string 型の列挙)	スキャンに失敗した理由を表す値。次のようなコードを使用できます。 `USER_DISMISSED_SCANNER` `USER_DENIED_PERMISSION` `USER_DISABLED_PERMISSION` `INVALID_BARCODE_TYPE_REQUESTED` `SERVICE_NOT_ENABLED` `UNKNOWN_REASON`
message	String	スキャンに失敗した理由を説明する文字列値。この値は、ユーザインターフェースメッセージでの使用に適しています。メッセージは英語で提供されます。ローカライズはされません。

スキャン中にユーザが [キャンセル] ボタンをクリックすると、userDismissedScanner が返されます。これは、スキャンセッションを終了させる通常のメソッドです。エラー処理では、userDismissedScanner を確認したり、権限エラーなどとは異なる処理を行ったりすることができます。