Briefcase Priming Records

Returns a request object that obtains record IDs from briefcases assigned to the external client app or connected app.

Mobile SDK provides a custom response object for parsing the results of Briefcase Priming Records requests. See Briefcase Priming Records Response.

Using Relay Tokens to Acquire Record IDs

Retrieve batches of record IDs in an iterative loop that’s controlled by a relay token, as follows:

In your first request, set relayToken to null. The response to this request will contain a new relay token.
In each subsequent request, set relayToken to the relay token value of the previous response.

In your request, you can also set a timestamp to retrieve only records that changed after the given time.

Parameters

API version (string)
Relay token (string; can be null)
“Changed after” timestamp (ISO timestamp; can be null)

iOS

Swift

Request factory method:

1let request = RestClient.shared.requestForPrimingRecords(relayToken: relayToken,
2    changedAfter: changedAfter, apiVersion: nil)

Objective-C

Request factory method:

1- (SFRestRequest*) requestForPrimingRecords:(*nullable* NSString *)relayToken
2    changedAfterTimestamp:(nullable NSNumber *)timestamp apiVersion:(*nullable* NSString *)apiVersion;

Android

Kotlin

Request factory method:

1val request =
2    RestRequest.getRequestForPrimingRecords(ApiVersionStrings.getVersionNumber(this),
3        relayToken, changedAfter)

Java

Request factory method:

1public static RestRequest getRequestForPrimingRecords(
2  String apiVersion,
3  String relayToken,
4  Long changedAfterTime)

Briefcase Priming Records

Using Relay Tokens to Acquire Record IDs

Parameters

iOS

Android

See Also