From 88e3964df0d1c101121849c1c74b4117ad7eb9d6 Mon Sep 17 00:00:00 2001 From: Robin Genz Date: Wed, 11 Oct 2023 11:20:12 +0200 Subject: [PATCH] docs(barcode-scanning): add more comments --- packages/barcode-scanning/README.md | 5 ++++- packages/barcode-scanning/src/definitions.ts | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/packages/barcode-scanning/README.md b/packages/barcode-scanning/README.md index 2f6f73c..b732043 100644 --- a/packages/barcode-scanning/README.md +++ b/packages/barcode-scanning/README.md @@ -335,7 +335,8 @@ Scan a barcode with a ready-to-use interface without WebView customization. On **Android**, this method is only available on devices with Google Play Services installed. Therefore, no camera permission is required. -**Attention:** Before using this method on *Android*, first check if the Google Barcode Scanner module is available. +**Attention:** Before using this method on *Android*, first check if the Google Barcode Scanner module is available +by using `isGoogleBarcodeScannerModuleAvailable()`. Only available on Android and iOS. @@ -469,6 +470,8 @@ isGoogleBarcodeScannerModuleAvailable() => PromiseBarcode Scanner module is available. +If the Google Barcode Scanner module is not available, you can install it by using `installGoogleBarcodeScannerModule()`. + Only available on Android. **Returns:** Promise<IsGoogleBarcodeScannerModuleAvailableResult> diff --git a/packages/barcode-scanning/src/definitions.ts b/packages/barcode-scanning/src/definitions.ts index 061d526..24f8581 100644 --- a/packages/barcode-scanning/src/definitions.ts +++ b/packages/barcode-scanning/src/definitions.ts @@ -33,7 +33,8 @@ export interface BarcodeScannerPlugin { * On **Android**, this method is only available on devices with Google Play Services * installed. Therefore, no camera permission is required. * - * **Attention:** Before using this method on *Android*, first check if the Google Barcode Scanner module is available. + * **Attention:** Before using this method on *Android*, first check if the Google Barcode Scanner module is available + * by using `isGoogleBarcodeScannerModuleAvailable()`. * * Only available on Android and iOS. * @@ -100,6 +101,8 @@ export interface BarcodeScannerPlugin { /** * Check if the Google Barcode Scanner module is available. * + * If the Google Barcode Scanner module is not available, you can install it by using `installGoogleBarcodeScannerModule()`. + * * Only available on Android. * * @since 5.1.0