Briefcase Priming Records Response

Handles responses for all Mobile SDK Briefcase Priming requests.

In addition to the request factory method, Mobile SDK provides a custom Briefcase response object. Use the properties of this object to obtain parsed Briefcase response values.

Properties 
  • Priming records (map or dictionary; contains record IDs and their modification timestamps)
  • Relay token (string; if null, no more records are available)
  • Rule errors (string array; contains IDs of priming rules that were processed but resulted in an error)
  • Stats (object containing number of rules, number of records, number of rules served, and number of records served)

iOS 

Swift 

Response handling:

1let parsedResponse =
2    PrimingRecordsResponse(try response.asJson() as! [AnyHashable : Any])
3let records = parsedResponse.primingRecords
4let token = parsedResponse.relayToken
5let ruleErrors = parsedResponse.ruleErrors
6let stats = parsedResponse.stats

Objective-C 

Response handling:

1SFSDKPrimingRecordsResponse* parsedResponse = [[SFSDKPrimingRecordsResponse alloc]
2    initWith:response];
3NSDictionary<NSString*, NSDictionary<NSString*,
4    NSArray<SFSDKPrimingRecord*>*>*>* primingRecords =
5    parsedResponse.primingRecords;
6NSString *relayToken = parsedResponse.relayToken;
7NSArray<SFSDKPrimingRuleError*>* ruleErrors = parsedResponse.ruleErrors;
8SFSDKPrimingStats * stats = parsedResponse.stats;

Android 

Kotlin 

Request factory method:

1val parsedResponse = PrimingRecordsResponse(result.asJSONArray())
2val primingRecords = parsedResponse.primingRecords
3val relayToken = parsedResponse.relayToken
4val ruleErrors = parsedResponse.ruleErrors
5val stats = parsedResponse.stats

Java 

Response handling:

1PrimingRecordsResponse parsedResponse =
2    new PrimingRecordsResponse(result.asJSONObject());
3String stats = parsedResponse.stats;
4Map<String, Map<String, List<PrimingRecordsResponse.PrimingRecord>>> records =
5    parsedResponse.primingRecords;
6String relayToken = parsedResponse.relayToken;
7List<PrimingRecordsResponse.PrimingRuleError> ruleErrors = parsedResponse.ruleErrors;

See Also 

We've Moved

Welcome to the new home of the Mobile SDK Developer Guide! For now, the Japanese guide can be found in PDF form.

Introduction to Mobile Development
Introduction to Salesforce Mobile SDK Development
What’s New in Mobile SDK 13.2
Getting Started With Mobile SDK for iOS and Android
Updating Mobile SDK Apps (5.0 and Later)
Native iOS Development
Native Android Development
HTML5 and Hybrid Development
React Native Development
Offline Management
Files and Networking
Push Notifications and Mobile SDK
Configure WebSockets
Authentication, Security, and Identity in Mobile Apps
Login Screen Customization
Identity Provider Apps
REST Wrappers for SFAP APIs
Using Key-Value Stores for Secure Data Storage
Dark Mode and Dark Theme Settings
Using Experience Cloud Sites With Mobile SDK Apps
Multi-User Support in Mobile SDK
Mobile SDK Tools for Developers
Logging and Analytics
Migrating from the Previous Release
Reference
Supported Salesforce APIs
Batch Request
Briefcase Priming Records
Briefcase Priming Records Response
Collection Create
Collection Delete
Collection Retrieve
Collection Update
Collection Upsert
Collection Response
Composite Request
Create
Delete
Describe
Describe Global
Metadata
Notification
Notification Update
Notifications
Notifications Status
Notifications Update
Object Layout
Resources
Retrieve
SOSL Search
Search Result Layout
Search Scope and Order
SObject Tree
SOQL Query
SOQL Query All
User Info
Update
Upsert
Versions
Files API Reference
iOS Architecture
Android Architecture
Supported Versions of Tools and Components for Mobile SDK
Deprecations and Removed APIs