SalesforceSDK/com.salesforce.androidsdk.rest/CompositeRequest

CompositeRequest

open class CompositeRequest : RestRequest

CompositeRequest: Class to represent a composite request.

Constructors

CompositeRequest

constructor(apiVersion: String, allOrNone: Boolean, refIdToRequests: LinkedHashMap<String, RestRequest>)

Types

CompositeRequestBuilder

open class CompositeRequestBuilder

Builder class for CompositeRequest

Properties

additionalHttpHeaders

val additionalHttpHeaders: Map<String, String>

ALL_OR_NONE

val ALL_OR_NONE: String = "allOrNone"

allOrNone

val allOrNone: Boolean

ATTRIBUTES

val ATTRIBUTES: String = "attributes"

BATCH_REQUESTS

val BATCH_REQUESTS: String = "batchRequests"

BATCH_SIZE_OPTION

val BATCH_SIZE_OPTION: String = "batchSize"

BODY

val BODY: String = "body"

COMPOSITE_REQUEST

val COMPOSITE_REQUEST: String = "compositeRequest"

DEFAULT_BATCH_SIZE

val DEFAULT_BATCH_SIZE: Int = 2000

endpoint

val endpoint: RestRequest.RestEndpoint

HALT_ON_ERROR

val HALT_ON_ERROR: String = "haltOnError"

HTTP_DATE_FORMAT

val HTTP_DATE_FORMAT: DateFormat

HTTP date format

HTTP_HEADERS

val HTTP_HEADERS: String = "httpHeaders"

IF_UNMODIFIED_SINCE

val IF_UNMODIFIED_SINCE: String = "If-Unmodified-Since"

ISO8601_DATE_FORMAT

val ISO8601_DATE_FORMAT: DateFormat

Salesforce timestamp format.

MAX_BATCH_SIZE

val MAX_BATCH_SIZE: Int = 2000

MAX_COLLECTION_RETRIEVE_SIZE

val MAX_COLLECTION_RETRIEVE_SIZE: Int = 2000

MEDIA_TYPE_FORM_URLENCODED

val MEDIA_TYPE_FORM_URLENCODED: MediaType

application/x-www-form-urlencoded media type

MEDIA_TYPE_JSON

val MEDIA_TYPE_JSON: MediaType

application/json media type

METHOD

val METHOD: String = "method"

method

val method: RestRequest.RestMethod

MIN_BATCH_SIZE

val MIN_BATCH_SIZE: Int = 200

path

val path: String

RECORDS

val RECORDS: String = "records"

Misc keys appearing in requests

REFERENCE_ID

val REFERENCE_ID: String = "referenceId"

refIdToRequests

val refIdToRequests: LinkedHashMap<String, RestRequest>

requestBody

val requestBody: RequestBody

requestBodyAsJson

val requestBodyAsJson: JSONObject

RICH_INPUT

val RICH_INPUT: String = "richInput"

SERVICES_DATA

val SERVICES_DATA: String = "/services/data/"

SERVICES_OAUTH2

val SERVICES_OAUTH2: String = "/services/oauth2/"

SFORCE_QUERY_OPTIONS

val SFORCE_QUERY_OPTIONS: String = "Sforce-Query-Options"

TYPE

val TYPE: String = "type"

URL

val URL: String = "url"

UTF_8

val UTF_8: String

utf_8 charset

Functions

computeCompositeRequestJson

open fun computeCompositeRequestJson(allOrNone: Boolean, refIdToRequests: LinkedHashMap<String, RestRequest>): JSONObject

getBatchRequest

open fun getBatchRequest(apiVersion: String, haltOnError: Boolean, requests: List<RestRequest>): BatchRequest

Batch request

getCheapRequest

open fun getCheapRequest(apiVersion: String): RestRequest

Cheap request to re-hydrate access token

getCompositeRequest

open fun getCompositeRequest(apiVersion: String, allOrNone: Boolean, refIdToRequests: LinkedHashMap<String, RestRequest>): CompositeRequest

Composite request

getRequestForCollectionCreate

open fun getRequestForCollectionCreate(apiVersion: String, allOrNone: Boolean, records: JSONArray): RestRequest

Request for creating multiple records with fewer round trips

getRequestForCollectionDelete

open fun getRequestForCollectionDelete(apiVersion: String, allOrNone: Boolean, objectIds: List<String>): RestRequest

Request for deleting multiple records with fewer round trips

getRequestForCollectionRetrieve

open fun getRequestForCollectionRetrieve(apiVersion: String, objectType: String, objectIds: List<String>, fieldList: List<String>): RestRequest

Request for retrieving multiple records with fewer round trips

getRequestForCollectionUpdate

open fun getRequestForCollectionUpdate(apiVersion: String, allOrNone: Boolean, records: JSONArray): RestRequest

Request for updating multiple records with fewer round trips

getRequestForCollectionUpsert

open fun getRequestForCollectionUpsert(apiVersion: String, allOrNone: Boolean, objectType: String, externalIdField: String, records: JSONArray): RestRequest

Request for upserting multiple records with fewer round trips

getRequestForCreate

open fun getRequestForCreate(apiVersion: String, objectType: String, fields: Map<String, Any>): RestRequest

Request to create a record.

getRequestForDelete

open fun getRequestForDelete(apiVersion: String, objectType: String, objectId: String): RestRequest

Request to delete a record.

getRequestForDescribe

open fun getRequestForDescribe(apiVersion: String, objectType: String): RestRequest

Request to completely describe the individual metadata at all levels for the specified object.

getRequestForDescribeGlobal

open fun getRequestForDescribeGlobal(apiVersion: String): RestRequest

Request to list the available objects and their metadata for your organization's data.

getRequestForLimits

open fun getRequestForLimits(apiVersion: String): RestRequest

Request for getting information about limits in your org

getRequestForMetadata

open fun getRequestForMetadata(apiVersion: String, objectType: String): RestRequest

Request to describe the individual metadata for the specified object.

getRequestForNotification

open fun getRequestForNotification(apiVersion: String, notificationId: String): RestRequest

Request to get a notification.

getRequestForNotifications

open fun getRequestForNotifications(apiVersion: String, size: Integer, before: Date, after: Date): RestRequest

Request for getting notifications.

getRequestForNotificationsStatus

open fun getRequestForNotificationsStatus(apiVersion: String): RestRequest

Request to get status of notifications for the user.

getRequestForNotificationsUpdate

open fun getRequestForNotificationsUpdate(apiVersion: String, notificationIds: List<String>, before: Date, read: Boolean, seen: Boolean): RestRequest

Request for updating notifications.

getRequestForNotificationUpdate

open fun getRequestForNotificationUpdate(apiVersion: String, notificationId: String, read: Boolean, seen: Boolean): RestRequest

Request for updating a notification.

getRequestForObjectLayout

open fun getRequestForObjectLayout(apiVersion: String, objectAPIName: String, formFactor: String, layoutType: String, mode: String, recordTypeId: String): RestRequest

Request to get object layout data.

getRequestForPrimingRecords

open fun getRequestForPrimingRecords(apiVersion: String, relayToken: String, changedAfterTime: Long): RestRequest

Request for getting list of record related to offline briefcase

getRequestForQuery

open fun getRequestForQuery(apiVersion: String, q: String): RestRequest

open fun getRequestForQuery(apiVersion: String, q: String, batchSize: Int): RestRequest

Request to execute the specified SOQL query.

getRequestForQueryAll

open fun getRequestForQueryAll(apiVersion: String, q: String): RestRequest

Request to execute the specified SOQL query which includes deleted records because of a merge or delete in the result set.

getRequestForResources

open fun getRequestForResources(apiVersion: String): RestRequest

Request to list available resources for the specified API version, including resource name and URI.

getRequestForRetrieve

open fun getRequestForRetrieve(apiVersion: String, objectType: String, objectId: String, fieldList: List<String>): RestRequest

Request to retrieve a record by object ID.

getRequestForSearch

open fun getRequestForSearch(apiVersion: String, q: String): RestRequest

Request to execute the specified SOSL search.

getRequestForSearchResultLayout

open fun getRequestForSearchResultLayout(apiVersion: String, objectList: List<String>): RestRequest

Request to get search result layouts

getRequestForSearchScopeAndOrder

open fun getRequestForSearchScopeAndOrder(apiVersion: String): RestRequest

Request to get search scope and order.

getRequestForSingleAccess

open fun getRequestForSingleAccess(redirectUri: String): RestRequest

Request to generate URL to bridge into UI sessions (a front door URL) Applications should use that API instead of building front door URLs directly

getRequestForSObjectTree

open fun getRequestForSObjectTree(apiVersion: String, objectType: String, objectTrees: List<RestRequest.SObjectTree>): RestRequest

Request to create one or more sObject trees with root records of the specified type.

getRequestForUpdate

open fun getRequestForUpdate(apiVersion: String, objectType: String, objectId: String, fields: Map<String, Any>): RestRequest

open fun getRequestForUpdate(apiVersion: String, objectType: String, objectId: String, fields: Map<String, Any>, ifUnmodifiedSinceDate: Date): RestRequest

Request to update a record.

getRequestForUpsert

open fun getRequestForUpsert(apiVersion: String, objectType: String, externalIdField: String, externalId: String, fields: Map<String, Any>): RestRequest

Request to upsert (update or insert) a record.

getRequestForUserInfo

open fun getRequestForUserInfo(): RestRequest

Request to get information about the user making the request.

getRequestForVersions

open fun getRequestForVersions(): RestRequest

Request to get summary information about each Salesforce.com version currently available.

toString

open fun toString(): String