Mobile SDK Development Guide
jUsing Lightning Web Components in Hybrid Apps
Creating Native Apps with
Adding Mobile Sync to Existing Android Apps
Adding to Existing iOS Apps
About Sync Targets
Using the MRU Sync Down Target
Using the SOQL Sync Down Target
Using the SOSL Sync Down Target
Using the Briefcase Sync Down Target
Using the Refresh Sync Down Target
Using the Batch Sync Up Target
Using the sObject Collection Sync Up Target
Syncing Related Records
Validating Configuration Files
Using Key-Value Stores for Secure Data Storage
Dark Mode and Dark Theme Settings
iOS Current Deprecations
iOS APIs Removed in Mobile SDK 11.0
Android Current Deprecations
Android APIs Removed in Mobile SDK 11.0
Trademark Attributions
Removing UIWebView from iOS Hybrid Apps
Using Standard Targets
Mobile Sync provides ready-to-use target classes for several standard
Salesforce request types. You can use these targets implicitly through configuration files, or
directly through code.
Supported standard types include:
- Layout
- Metadata
- MRU
- SOQL query
- SOSL query
- Refresh
- Batch
- Briefcase
- sObject Collections
-
Using the MRU Sync Down Target
To retrieve the most recently viewed records for a specific Salesforce object in your org, use the MRU sync down target. -
Using the SOQL Sync Down Target
If you can define a SOQL query that selects everything required for a business need, the SOQL target is your simplest sync down option. This target takes a SOQL query and optional supporting arguments. -
Using the SOSL Sync Down Target
-
Using the Briefcase Sync Down Target
If your org uses Briefcases for your mobile users, the Briefcase sync down target was introduced in Mobile SDK 10.1. This sync target is an efficient way to load many records at a time. Sync is constrained to the records included in all Briefcases assigned to the current user and made accessible in the mobile client’s Connected App. You can limit the sync target to specific objects and fields included in those Briefcases. This target takes an array of BriefcaseObjectInfo objects, which include sObject type, fields, and the soup to add them to. -
Syncing Metadata and Layouts
Mobile SDK 6.2 introduces new API features that simplify object discovery and presentation. These features harness the power of Mobile Sync to access Salesforce object metadata and layouts. Mobile SDK automatically stores the data in predefined soups for offline use and structured data models for easy querying. -
Using the Refresh Sync Down Target
Many apps download records, cache all of them, and then let users edit them from the SmartStore cache when connectivity drops. Local “offline” work is quick and efficient—a great user experience—but, when connectivity resumes, it's important to refresh the cached records with server updates. -
Using the Batch Sync Up Target
To enhance performance in large sync up operations, Mobile SDK 7.1 introduces a batch sync up target. -
Using the sObject Collection Sync Up Target
For the very best performance in large sync up operations, Mobile SDK 10.1 introduced an sObject collection sync up target.