Mobile and Offline Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Mobile App Development with Lightning Web Components and LWC Offline
Create Mobile-Ready Components
Use Mobile Device Features in Mobile Apps
Request App Review
Scan Barcodes
Barcode Scanning User Experience
Use the BarcodeScanner API
BarcodeScanner Example–Modern Scanning API
BarcodeScanner Example—Single Scan (Legacy)
Scan Multiple Barcodes (Legacy)
BarcodeScanner Example—Continuous Scanning (Legacy)
Create a Self-Service Kiosk Application
BarcodeScanner Example—Self-Service Kiosk (Legacy)
Customize the BarcodeScanner User Interface
Compatibility and Requirements
Considerations and Limitations
Access Device Biometrics
Manage Calendar Events
Access Contacts
Scan Documents
Monitor Geofences
Use Location
Interact With NFC Tags
Tap to Pay
Offline Considerations and Limitations
Offline Environment Details
Use Salesforce Features While Offline
Development Tools and Processes
Quick Start Tutorials
PDF

Compatibility and Requirements

BarcodeScanner is a JavaScript module that provides an API to Lightning web components to make mobile hardware and platform (operating system) features available in JavaScript. It requires access to device hardware and device platform APIs. This access is only available when BarcodeScanner runs within a compatible Salesforce mobile app. It does not and cannot function when running in a web browser, whether the browser runs on a desktop or mobile device.
BarcodeScanner is available in Lightning apps distributed using:
  • Salesforce Mobile app
  • Mobile Publisher for Salesforce App
  • Mobile Publisher for Experience Cloud

The Field Service Mobile app provides an alternative implementation of BarcodeScanner. See Scan Barcodes on a Mobile Device in the Field Service Developer Guide for details.

Note

BarcodeScanner is fully functional when used in a Lightning app or Lightning site run from one of these Salesforce apps on a compatible iOS or Android mobile device. See Requirements for the Salesforce Mobile App, or the requirements page for your target mobile app, for specific device and operating system requirements.

BarcodeScanner is not fully functional when running on other devices, such as a desktop, or when running in a web browser, even on a mobile device. It requires one of the mobile apps listed above. The BarcodeScanner API is accessible in Lightning Experience on all devices, so your code won’t fail due to missing functions. However, when your app runs in a browser—desktop or mobile—it can use only BarcodeScanner constants and utility functions. Attempting any scanning operation will fail.

Supported Barcode Types

BarcodeScanner can recognize the following standard barcode symbologies. (References not affiliated with Salesforce.)

Barcode Symbology Standard BarcodeScanner Type (barcodeTypes)
Code 128 CODE_128
Code 39 CODE_39
Code 93 CODE_93
Data Matrix DATA_MATRIX
EAN-13 / GTIN-13 EAN_13
EAN-8 / GTIN-8 EAN_8
Interleaved 2 of 5 ITF
PDF417 PDF_417
QR-Code QR
UPC-A / GTIN-12 UPC_A
UPC-E / GTIN-12 UPC_E

To access or compare barcode types in code, use the barcodeTypes constant.

BarcodeScanner doesn’t attempt to interpret the value found in a barcode. The contents of the barcode are decoded into a string value. It’s up to the controlling component or application to further parse and interpret the result and decide what to do with it. For more information about barcode standards and symbologies, see Barcoding for Beginners (not affiliated with Salesforce).