Mobile and Offline Developer Guide

Mobile App Development with Lightning Web Components and LWC Offline
Create Mobile-Ready Components
Use Mobile Device Features in Mobile Apps
Offline Considerations and Limitations
Offline Environment Details
Use Salesforce Features While Offline
Use GraphQL While Mobile and Offline
Use Apex While Mobile and Offline
Use Apex in Lightning Web Components While Online
Enable Caching of Apex Results
Apex Results Are Separate from Other Primed Data
Understand Apex Behavior While Offline
Additional Considerations for Apex in an Offline-Enabled Mobile App
Additional Documentation for Apex in Lightning Web Components
Use Images in an LWC Offline-Enabled Component
Upload Images While Offline
Use Third-Party JavaScript in an LWC Offline-Enabled Component
Navigation
Development Tools and Processes
Quick Start Tutorials
PDF

Note: 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.

Enable Caching of Apex Results

To allow results of Apex calls to be saved for offline use, enable caching on Apex methods used in your offline-enabled mobile apps.

Annotate the Apex method with @AuraEnabled(cacheable=true), which caches the method results on the client. When you set cacheable=true, a method must only retrieve data, it can’t mutate (change) data.

  • Apex methods used in reactive wires must be annotated with @AuraEnabled(cacheable=true), whether you intend to use the results offline or not.
  • Apex methods called imperatively only need to be annotated with @AuraEnabled(cacheable=true) if you want the results to be available offline.

Additional details of Apex method caching behavior and managing cached results can be found in the Lightning Web Components Developer Guide.