Lightning Aura Components Developer Guide

Introducing Aura Components
Quick Start
Creating Components
Using Components
Communicating with Events
Communicating Across the DOM with Lightning Message Service
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Lightning Data Service
Loading a Record
Editing a Record
Creating a Record
Deleting a Record
Record Changes
Handling Errors
Changing the Display Density
Considerations
Lightning Action Examples
SaveRecordResult
Displaying the Create and Edit Record Modals
Using Apex
Testing Components
Debugging
Performance
Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

SaveRecordResult

Represents the result of a Lightning Data Service operation that makes a persistent change to record data.

SaveRecordResult Object

Callback functions for the saveRecord and deleteRecord functions receive a SaveRecordResult object as their only argument.

Attribute Name Type Description
objectApiName String The object API name for the record.
entityLabel String The label for the name of the sObject of the record.
error String Error is one of the following.
  • A localized message indicating what went wrong.
  • An array of errors, including a localized message indicating what went wrong. It might also include further data to help handle the error, such as field- or page-level errors.

error is undefined if the save state is SUCCESS or DRAFT.
recordId String The 18-character ID of the record affected.
state String The result state of the operation. Possible values are:
  • SUCCESS—The operation completed on the server successfully.
  • DRAFT—The server wasn’t reachable, so the operation was saved locally as a draft. The change is applied to the server when it’s reachable.
  • INCOMPLETE—The server wasn’t reachable, and the device doesn’t support drafts. (Drafts are supported only in the Salesforce app.) Try this operation again later.
  • ERROR—The operation couldn’t be completed. Check the error attribute for more information.