Apex Developer Guide

Apex Developer Guide
Release Notes
Getting Started with Apex
Writing Apex
Running Apex
Invoking Apex
Apex Transactions and Governor Limits
Using Salesforce Features with Apex
Actions
Apex Cursors
Approval Processing
Authentication
Chatter Answers and Ideas
Use Cases for the CommercePayments Namespace
Connect in Apex
Connect in Apex Examples
Connect in Apex Features
Using ConnectApi Input and Output Classes
Understanding Limits for ConnectApi Classes
Packaging ConnectApi Classes
Serializing and Deserializing ConnectApi Objects
ConnectApi Versioning and Equality Checking
Casting ConnectApi Objects
Wildcards
Testing ConnectApi Code
Differences Between ConnectApi Classes and Other Apex Classes
Moderate Chatter Private Messages with Triggers
Data 360 In Apex
DataWeave in Apex
Moderate Feed Items with Triggers
Experience Cloud Sites
Email
External Services
Flows
Formula Evaluation in Apex
Metadata
Permission Set Groups
Platform Cache
Salesforce Knowledge
Salesforce Files
Salesforce Connect
Salesforce Reports and Dashboards API via Apex
Salesforce Sites
Support Classes
Territory Management 2.0
Integration and Apex Utilities
Debugging, Testing, and Deploying Apex
Apex Reference
Appendices
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.

ConnectApi Versioning and Equality Checking

Versioning in ConnectApi classes follows specific rules that are different than the rules for other Apex classes.

Versioning for ConnectApi classes follows these rules.

  • A ConnectApi method call executes in the context of the version of the class that contains the method call. The use of version is analogous to the /vXX.X section of a Connect REST API URL.
  • Each ConnectApi output object exposes a getBuildVersion method. This method returns the version under which the method that created the output object was invoked.
  • When interacting with input objects, Apex can access only properties supported by the version of the enclosing Apex class.
  • Input objects passed to a ConnectApi method may contain only non-null properties that are supported by the version of the Apex class executing the method. If the input object contains version-inappropriate properties, an exception is thrown.
  • The output of the toString method only returns properties that are supported in the version of the code interacting with the object. For output objects, the returned properties must also be supported in the build version.
  • Apex REST, JSON.serialize, and @RemoteAction serialization include only version-appropriate properties.
  • Apex REST, JSON.deserialize, and @RemoteAction deserialization reject properties that are version-inappropriate.
  • Enums are not versioned. Enum values are returned in all API versions. Clients should handle values they don't understand gracefully.

Equality checking for ConnectApi classes follows these rules.

  • Input objects—properties are compared.
  • Output objects—properties and build versions are compared. For example, if two objects have the same properties with the same values but have different build versions, the objects are not equal. To get the build version, call getBuildVersion.