`isAvailable()`

Use this function to determine whether DocumentScanner functionality is available.

Syntax

1import { getDocumentScanner } from 'lightning/mobileCapabilities';
2isAvailable(): Boolean

Parameters

None.

Returns

Returns true when used on a supported device, and false otherwise.

Usage

Use this function to disable or hide scan features on platforms where scanning isn’t supported. For example:

1handleGetScannerClick(event) {
2    const myDocumentScanner = getDocumentScanner();
3    if(myDocumentScanner.isAvailable()) {
4        // Perform document scanning operations
5    }
6    else {
7        // DocumentScanner not available, or consuming app hasn’t implemented it
8        // Not running on a device with camera or OCR functionality, etc.
9        // Handle with message, error, beep, and so on
10    }
11}

Release Preview

This release is in preview. Features described here don't become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can't guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.