SalesforceSDK/com.salesforce.androidsdk.rest

Package-level declarations

Types

This is where all the API version info lives.

class AppAttestationChallengeApiException(val source: String?) : Exception

An exception derived from a Mobile App Attestation Challenge API endpoint failure response. See https://docs.google.com/document/d/1MGw0-dO4Q-CJLNuqYBSYKAbEUy484lpLLX20ZIvwU6Y/edit?tab=t.0 TODO: Replace with final documentation when available. ECJ20260311

BatchRequest

open class BatchRequest : RestRequest

BatchRequest: Class to represent a batch request.

BatchResponse

open class BatchResponse

BatchResponse: Class to represent response for a BatchRequest.

ClientManager

open class ClientManager

Factory for authenticated RestClient instances belonging to one persisted user.

CollectionResponse

open class CollectionResponse

CollectionCreateResponse: Class to represent response for a sobject collection create/update/upsert or delete request.

CompositeRequest

open class CompositeRequest : RestRequest

CompositeRequest: Class to represent a composite request.

CompositeResponse

open class CompositeResponse

CompositeResponse: Class to represent response for a CompositeRequest.

NotificationsActionsResponseBody

@Serializable

data class NotificationsActionsResponseBody(val message: String?)

Models a Notifications API actions endpoint response. See https://salesforce.quip.com/dwjPAf3py4Br TODO: Replace the documentation link with the final documentation. ECJ20250320

NotificationsApiClient

class NotificationsApiClient(restClient: RestClient)

Provides REST client methods for a variety of notifications API endpoints.

NotificationsApiErrorResponseBody

@Serializable

data class NotificationsApiErrorResponseBody(val errorCode: String? = null, val message: String? = null, val messageCode: String? = null)

Models the Salesforce Notifications API actions endpoint's error response. See https://salesforce.quip.com/dwjPAf3py4Br TODO: Replace the documentation link with the final documentation. ECJ20250320

NotificationsApiException

class NotificationsApiException(val errorCode: String? = null, message: String? = null, val messageCode: String? = null, val source: String? = null) : Exception

An exception derived from a Salesforce Notifications API endpoint failure response.

NotificationsTypesResponseBody

@Serializable

data class NotificationsTypesResponseBody(val notificationTypes: Array<NotificationsTypesResponseBody.NotificationType>? = null)

Models a Notifications API Types endpoint response. See https://salesforce.quip.com/KGU3ALoXRCjK#RcfABAPLVfg TODO: Replace the documentation link with the final documentation. ECJ20250310

PrimingRecordsResponse

open class PrimingRecordsResponse

PrimingRecordsResponse: Class to represent response for a priming records request.

RestClient

open class RestClient

RestClient allows you to send authenticated HTTP requests to a force.com server.

RestRequest

open class RestRequest

RestRequest: Class to represent any REST request.

RestResponse

open class RestResponse

RestResponse: Class to represent any REST response.

SfapApiChatGenerationsRequestBody

@Serializable

open class SfapApiChatGenerationsRequestBody(val messages: Array<SfapApiChatGenerationsRequestBody.Message>, val localization: SfapApiChatGenerationsRequestBody.Localization)

Models a sfap_api chat-generations endpoint request. See https://developer.salesforce.com/docs/einstein/genai/references/models-api?meta=generateChat

SfapApiChatGenerationsResponseBody

@Serializable

data class SfapApiChatGenerationsResponseBody(val id: String? = null, val generationDetails: SfapApiChatGenerationsResponseBody.GenerationDetails? = null)

Models a sfap_api "chat-generations" endpoint response.

SfapApiClient

class SfapApiClient(apiHostName: String, modelName: String? = null, restClient: RestClient)

Provides REST client methods for a variety of sfap_api endpoints.

SfapApiEmbeddingsRequestBody

@Serializable

data class SfapApiEmbeddingsRequestBody(val input: Array<String>)

Models a sfap_api embeddings endpoint request. See https://developer.salesforce.com/docs/einstein/genai/references/models-api?meta=generateText

SfapApiEmbeddingsResponseBody

@Serializable

data class SfapApiEmbeddingsResponseBody(val embeddings: Array<SfapApiEmbeddingsResponseBody.Embedding>? = null, val parameters: SfapApiEmbeddingsResponseBody.Parameters? = null)

Models a sfap_api embeddings endpoint response.

SfapApiErrorResponseBody

@Serializable

data class SfapApiErrorResponseBody(val errorCode: String? = null, val message: String? = null, val messageCode: String? = null)

Models a sfap_api endpoint's error response. See https://developer.salesforce.com/docs/einstein/genai/references/models-api?meta=generateText

SfapApiException

class SfapApiException(val errorCode: String? = null, message: String? = null, val messageCode: String? = null, val source: String? = null) : Exception

An exception derived from an sfap_api endpoint failure response. See https://developer.salesforce.com/docs/einstein/genai/guide/access-models-api-with-rest.html#step-3-use-models-rest-api

SfapApiFeedbackRequestBody

@Serializable

open class SfapApiFeedbackRequestBody(val id: String? = null, val appGeneration: String? = null, val appGenerationId: String? = null, val feedback: String? = null, val feedbackText: String? = null, val generationId: String? = null, val source: String? = null)

Models a sfap_api feedback endpoint request. See https://developer.salesforce.com/docs/einstein/genai/references/models-api?meta=submitFeedback

SfapApiFeedbackResponseBody

@Serializable

data class SfapApiFeedbackResponseBody(val message: String? = null)

Models a sfap_api feedback endpoint response.

SfapApiGenerationsRequestBody

@Serializable

data class SfapApiGenerationsRequestBody(val prompt: String)

Models a sfap_api generations endpoint request. See https://developer.salesforce.com/docs/einstein/genai/references/models-api?meta=generateText

SfapApiGenerationsResponseBody

@Serializable

data class SfapApiGenerationsResponseBody(val id: String? = null, val generation: SfapApiGenerationsResponseBody.Generation? = null, val moreGenerations: String? = null, val parameters: SfapApiGenerationsResponseBody.Parameters? = null, val prompt: String? = null)

Models a sfap_api "generations" endpoint response.