Apexref

• Auth Exceptions: The Auth namespace contains some exception classes.
• ActionLinks Class: Create, delete, and get information about an action link group definition; get information about an action link group; get action link diagnostic information.These methods are for ActionLinks. All methods are static.Create an action link group definition. To associate an action link group with a feed element, first create an action link group definition. Then post a feed element with an associated actions capability.Delete an action link group definition. Deleting an action link group definition removes all references to it from feed elements.Get information about an action link, including state for the context user.Get diagnostic information returned when an action link executes. Diagnostic information is given only for users who can access the action link.Get information about an action link group including state for the context user.Get information about an action link group definition.
• Announcements Class: Access information about announcements and post announcements. These methods are for Announcements. All methods are static.Delete an announcement.Get an announcement.Get the first page of announcements.Get a page of announcements.Post an announcement.Update the expiration date of an announcement.
• BotVersionActivation Class: Access and update activation information of a bot version.These methods are for BotVersionActivation. All methods are static.Get the active or inactive status of the bot version.Update the status of the specified bot version.
• CdpActivationExternalPlatform Class: Get Data 360 activation external platforms.These methods are for CdpActivationExternalPlatform. All methods are static.Get a list of all activation external platforms.Get a paginated list of activation external platforms. Repeat the call for additional external platform results.
• CdpActivationTarget Class: Get, create, and update Data 360 activation targets.These methods are for CdpActivationTarget. All methods are static.Create an activation target.Get an activation target by ID.Get a list of activation targets.Get a paginated list of activation targets.Update an activation target.
• CdpActivation Class: Get, create, update, and delete Data 360 activations.These methods are for CdpActivation. All methods are static.Get activations.Get a paginated list of activations.Create an activation.Delete an activation.Get an activation by ID.Update an activation by ID.
• CdpAudienceDMO Class: Get activation records from Data 360 Audience Data Model Objects (DMOs).These methods are for CdpAudienceDMO. All methods are static.Get a list of all activation records from Audience Data Model Objects (DMOs).
• CdpCalculatedInsight Class: Create, delete, get, run, and update Data 360 calculated insights.These methods are for CdpCalculatedInsight. All methods are static.Create a calculated insight.Delete a calculated insight.Get a calculated insight.Get calculated insights.Get a page of calculated insights.Run a calculated insight.Update a calculated insight.
• CdpConnection Class: Get database schemas for a Data 360 connection.These methods are for CdpConnection. All methods are static.Get a list of database schemas for a connection.
• CdpDataSpace Class: Get Data 360 data spaces.These methods are for CdpDataSpace. All methods are static.Get a collection of all data spaces that a user is assigned to.Get a data space by ID or API name.
• CdpDataStreams Class: Run Data 360 data streams.These methods are for CdpDataStreams. All methods are static.Start a data stream run to read from a source and update a data lake object.
• CdpIdentityResolution Class: Create, delete, get, run, and update Data 360 identity resolution rulesets.These methods are for CdpIdentityResolution. All methods are static.Create an identity resolution ruleset.Delete an identity resolution ruleset.Get an identity resolution ruleset.Get identity resolution rulesets.Trigger an immediate identity resolution ruleset job run.Update an identity resolution ruleset.
• CdpMachineLearning Class: Make a machine-learning prediction with Data 360.These methods are for CdpMachineLearning. All methods are static.Make a prediction using a specified model and parameters. This request is synchronous.
• CdpQuery Class: Get Data 360 metadata and query data.These methods are for CdpQuery. All methods are static.Get all metadata, including Calculated Insights, Engagement, Profile, and other objects, as well as their relationships to other objects.Get all metadata, filtering for entity type, category, and name.Get all metadata, filtering for entity type, category, name, and data space.Query a data graph in the default data space. For real-time data graphs, the method attempts to retrieve data from the real-time data graph but falls back to the standard data graph if the real-time data graph is unavailable.Query a data graph in a specified data space. For real-time data graphs, the method attempts to retrieve data from the real-time data graph but falls back to the standard data graph if the real-time data graph is unavailable.Query a data graph by performing a live lookup in the default data space. For real-time data graphs, the method attempts to retrieve data from the real-time data graph but falls back to the standard data graph if the real-time data graph is unavailable.Query a data graph by performing a live lookup in a specified data space. For real-time data graphs, the method attempts to retrieve data from the real-time data graph but falls back to the standard data graph if the real-time data graph is unavailable.Query a data graph by the primary key of either the primary Data Model Object (DMO) or the Individual linked DMO. Get the data from the default data space. For real-time data graphs, the method attempts to retrieve data from the real-time data graph but falls back to the standard data graph if the real-time data graph is unavailable.Query a data graph by the primary key of either the primary Data Model Object (DMO) or the Individual linked DMO. Get the data from a specified data space. For real-time data graphs, the method attempts to retrieve data from the real-time data graph but falls back to the standard data graph if the real-time data graph is unavailable.Query a data graph by the primary key of either the primary Data Model Object (DMO) or the Individual linked DMO. Get the data from a specified data space. Get data from a standard or real-time data graph. For real-time data graphs, the method attempts to retrieve data from the real-time data graph but falls back to the standard data graph if the real-time data graph is unavailable.Retrieve metadata from all data graphs in the default data space. Retrieves data from both standard and real-time data graphs.Retrieve metadata from a specified data graph in the default data space. Retrieves data from both standard and real-time data graphs.Retrieve metadata from a specified data graph in a specified data space. Retrieves data from both standard and real-time data graphs.Get Insight metadata, including Calculated Insight objects, their dimensions and measures.Get metadata for a Calculated Insight object. Metadata includes dimensions and measures.Get metadata for a Calculated Insight object and specify the data space. Metadata includes dimensions and measures.Get a list of metadata entities and retrieve only essential fields to optimize performance at scale.Get a list of metadata entities and retrieve only essential fields to optimize performance at scale. Specify the entity category and type.Get a list of metadata entities and retrieve only essential fields to optimize performance at scale. Specify the entity category, type, and data space.Get metadata for data model objects in the profile category, including Individual, Contact Point Email, Unified Individual, and Contact Point Address objects. Metadata includes the objects, their fields, and category.Get metadata for a data model object in the profile category, such as Individual, Contact Point Email, Unified Individual, and Contact Point Address. Metadata includes the list of fields, data types, and indexes available for lookup.Get metadata for a data model object in the profile category, such as Individual, Contact Point Email, Unified Individual, and Contact Point Address. Also, specify the data space. Metadata includes the list of fields, data types, and indexes available for lookup.Synchronously query data across data model, lake, unified, and linked objects. This query returns up to 49,999 rows.Synchronously query data across data model, lake, unified, and linked objects. Specify batch size, offset, and order of the results. This query returns up to 49,999 rows.Synchronously query data across data model, lake, unified, and linked objects. Specify batch size, offset, order of the results, and data space. This query returns up to 49,999 rows.Query data across data model, lake, unified, and linked objects.Query data across data model, lake, unified, and linked objects. Also, specify the data space.Get the next batch of data across data model, lake, unified, and linked objects.Get the next batch of data across data model, lake, unified, and linked objects. Also, specify the data space.Submit an SQL query request for execution and retrieve the first chunk of data.Submit an SQL query request for execution and specify the data space.Submit an SQL query request for execution and specify the workload name and data space.Get additional query results that weren't returned in the initial request. Paginate through existing query results by specifying the offset and row limit. Results are available for up to 24 hours.Get additional query results that weren't returned in the initial request. Paginate through existing query results by specifying the offset and row limit. Also, specify whether to include metadata in the response or not. Results are available for up to 24 hours.Get additional query results that weren’t returned in the initial request. Paginate through existing query results by specifying the offset and row limit. Also, specify the data space. Results are available for up to 24 hours.Get additional query results that weren't returned in the initial request. Paginate through existing query results by specifying the offset and row limit. Also, specify the data space and whether or not to exclude metadata from the response. Results are available for up to 24 hours.Get additional query results that weren't returned in the initial request. Paginate through existing query results by specifying the offset and row limit. Also, specify the workload name and data space. Results are available for up to 24 hours.Get additional query results that weren't returned in the initial request. Paginate through existing query results by specifying the offset and row limit. Also, specify the workload name, data space, and whether or not to exclude metadata from the response. Results are available for up to 24 hours.Delete the specified query and terminate long-running queries that are no longer needed to manage resource consumption.Delete the specified query and terminate long-running queries that are no longer needed to manage resource consumption. Specify the data space.Delete the specified query and terminate long-running queries that are no longer needed to manage resource consumption. Specify the data space and workload name.Get the status of an SQL query request. Results are available for up to 24 hours.Get the status of an SQL query request and specify the time to wait before returning the response. Results are available for up to 24 hours.Get the status of an SQL query request and specify the data space. Results are available for up to 24 hours.Get the status of an SQL query request. Specify the data space and time to wait before returning the response. Results are available for up to 24 hours.Get the status of an SQL query request. Specify the workload name and data space. Results are available for up to 24 hours.Get the status of an SQL query request. Specify the workload name, data space, and time to wait before returning the response. Results are available for up to 24 hours.Query a Calculated Insight object.Query a Calculated Insight object within a specified time range.Query a Calculated Insight object within a specified time range and specify the data space.Query a Profile data model object using filters.Query a Profile data model object using filters and a search key.Query a Profile data model object and a child object using filters and a search key.Query a Profile data model object and a Calculated Insight object using filters and a search key.Query a Profile data model object and a Calculated Insight object using filters, a search key, and a time range.Query a Profile data model object and a Calculated Insight object using filters, a search key, a time range, and a data space.Look up objects by source ID.Look up objects by source ID and specify the data space.
• CdpSegment Class: Create, delete, get, publish, and update Data 360 segments.These methods are for CdpSegment. All methods are static.Create a segment.Create a segment in a dataspace.Deactivate a segment by API name.Deactivate a segment by ID.Delete a segment.Publish a segment.Get a segment by API name.Get a segment by ID.Get segments.Get an ordered batch of paginated segments.Get an ordered batch of paginated segments in a dataspace.Get an ordered and filtered batch of paginated segments.Get an ordered and filtered batch of paginated segments in a dataspace.Update a segment.
• ChatterFavorites Class: Chatter favorites give you easy access to topics, list views, and feed searches.These methods are for ChatterFavorites. All methods are static.Add a feed search favorite for a user. Add a topic as a favorite.Delete a favorite.Get information about a favorite. Get a list of favorites for a user. Get the first page of feed elements for a favorite.Get a page of sorted feed elements for a favorite.Get a page of sorted feed elements for a favorite. Include no more than the specified number of comments per feed element.Update the last view date of the saved search or list view feed to the current system time. These test methods are for ChatterFavorites. All methods are static.Register a ConnectApi.FeedElementPage object to be returned when getFeedElements​ is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedElementPage object to be returned when getFeedElements​ is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElements​ is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. These methods for ChatterFavorites are retired.Get the first page of feed items for a favorite.Get a page of sorted feed items for a favorite.Get a page of sorted feed items for a favorite. Include no more than the specified number of comments per feed item.Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​ is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​ is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​ is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.
• ChatterFeeds Class: Get, post, and delete feed elements, likes, comments, and bookmarks. You can also search feed elements, share feed elements, and vote on polls.These methods are for ChatterFeeds. All methods are static.Create a Chatter feed stream.Delete a comment.Delete a feed element.Delete a like on a comment or post.Delete a Chatter feed stream.Get a comment.Get a list of comments.Get a threaded comment in the context of its parent comments and post.Get comments for a feed element.Get comments in a threaded style for a feed element.Get a page of comments for a feed element.Get a page of comments in a threaded style for a feed element.Get sorted comments in a threaded style for a feed element.Get a page of sorted comments in a threaded style for a feed element.Get sorted comments for a feed element.Get sorted comments in a threaded style for a feed element.Get extensions.Get a feed.Get a sorted feed.Get a feed for a record or user.Get a sorted feed for a record or user.Get a list of all feeds available to the context user.Get a feed element.Get a feed element with sorted comments.Get a feed element and its comments in a threaded style.Get a feed element and its sorted comments in a threaded style.Get a feed element with the specified number of elements per bundle including no more than the specified number of comments per feed element.Get a feed element with its comments in a threaded style with the specified number of elements per bundle and comments per feed element.Get a feed element with its sorted comments in a threaded style with the specified number of elements per bundle and comments per feed element.Get a feed element with the specified number of elements per bundle including no more than the specified number of sorted comments per feed element.Get a list of feed elements.Get the poll associated with a feed element.Get feed elements from a bundle.Get a page of feed elements from a bundle. Specify the number of elements per bundle and include no more than the specified number of comments per feed element.Get feed elements from the Company, DirectMessageModeration, DirectMessages, Home, Isolated, Moderation, and PendingReview feeds.Get a page of sorted feed elements from the Company, DirectMessageModeration, DirectMessages, Home, Isolated, Moderation, and PendingReview feeds.Get a page of sorted feed elements from the Company, DirectMessageModeration, DirectMessages, Home, Isolated, Moderation, and PendingReview feeds. Each feed element contains no more than the specified number of comments. Get a page of sorted and filtered feed elements from the Home feed. Each feed element contains no more than the specified number of comments.Get a page of filtered and sorted feed elements with comments in a threaded style from the Home feed. Each feed element contains no more than the specified number of comments.Get feed elements from any feed other than Company, DirectMessageModeration, DirectMessages, Filter, Home, Isolated, Landing, Moderation, and PendingReview for a user or record.Get a page of sorted feed elements from any feed other than Company, DirectMessageModeration, DirectMessages, Filter, Home, Isolated, Landing, Moderation, and PendingReview.Get a page of sorted feed elements from any feed other than Company, DirectMessageModeration, DirectMessages, Filter, Home, Isolated, Landing, Moderation, and PendingReview. Each feed element includes no more than the specified number of comments.Get a page of sorted feed elements from a record feed. Each feed element includes no more than the specified number of comments. Specify whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of sorted and filtered feed elements from the UserProfile feed.Get a page of feed elements with comments in a threaded style from the UserProfile feed.Get a page of sorted and filtered feed elements from the case feed.Get a page of sorted feed elements from a record feed. Specify the number of elements per bundle and include no more than the specified number of comments per feed element. Specify whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of sorted and filtered feed elements from a record feed. Specify the number of elements per bundle and include no more than the specified number of comments per feed element. Specify whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of sorted and filtered feed elements with comments in a threaded style for a record feed. Specify the number of elements per bundle and include no more than the specified number of comments per feed element. Specify whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of sorted and filtered feed elements from a case feed. Get a page of filtered and sorted feed elements with comments in a threaded style from a case feed. Get feed elements from a feed filtered by a key prefix for a user.Get a page of sorted feed elements from a feed filtered by a key prefix for a user.Get a page of sorted feed elements from a feed filtered by a key prefix for a user. Each feed element contains no more than the specified number of comments.Get a page of feed elements from a feed filtered by a key prefix for a user. Include only feed elements that have been updated since the time specified in the updatedSince parameter.Get a page of feed elements from the Company, DirectMessageModeration, Home, and Moderation feeds. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Each feed element contains no more than the specified number of comments.Get a page of filtered feed elements from the Home feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Each feed element contains no more than the specified number of comments.Get a page of feed elements from the Files, Groups, News, People, and Record feeds. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Each feed element contains no more than the specified number of comments.Get a page of feed elements from a record feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Specify whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of filtered feed elements from a UserProfile feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter.Get a page of filtered feed elements from a case feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter.Get a page of feed elements from a record feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Specify the maximum number of feed elements in a bundle and whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of filtered feed elements from a record feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Specify the maximum number of feed elements in a bundle and whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of filtered feed elements from a case feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter.Get information about a feed and a page of feed elements from the feed.Get a page of information about the feed and the feed elements with the specified number of comments per feed element from the feed.Get a feed filtered by a key prefix for a user. Get a sorted feed filtered by a key prefix for a user. Get a feed directory of filter feeds available to the context user.Get a like on a post or comment. Get likes for a comment.Get a page of likes for a comment. Get likes for a feed element.Get a page of likes for a feed element. Get link metadata for URLs.Get pinned feed elements from a group or topic feed.Get information about who read a feed element and when.Get a page of information about who read a feed element and when.Get posts related to the context feed element.Get information about a Chatter feed stream.Get information about a Chatter feed stream, regardless of Experience Cloud site.Get the Chatter feed streams for the context user.Get and sort the Chatter feed streams for the context user.Get a page of Chatter feed streams for the context user.Get a sorted page of Chatter feed streams for the context user.Get a sorted page of Chatter feed streams from all Enterprise Cloud sites for the context user.Get supported emojis for the org.Get threaded comments for a comment.Get a page of threaded comments for a comment.Access the comments capability for a comment.Get top unanswered questions for the context user in aExperience Cloud site.Get filtered top unanswered questions for the context user in an Experience Cloud site.Get a page of top unanswered questions for the context user in an Experience Cloud site.Get a page of filtered top unanswered questions for the context user in an Experience Cloud site.Get the first page of users who upvoted or downvoted a comment.Get a page of users who upvoted or downvoted a comment.Get the first page of users who upvoted or downvoted a feed element.Get a page of users who upvoted or downvoted a feed element.Discover whether the context user can edit a comment.Discover whether the context user can edit a feed element. Discover whether a news feed has been updated or changed. Use this method to poll a news feed for updates.Like a comment for the context user.Like a feed element. Post a plain-text comment to a feed element.Post a rich-text comment to a feed element. Use this method to include mentions and to attach a file.Post a plain-text feed element.Post a rich-text feed element. Include mentions and hashtag topics, attach already uploaded files to a feed element, and associate action link groups with a feed element. You can also use this method to share a feed element and add a comment.Post a list of feed elements.Publish a draft feed element.Get the first page of feed elements that match the search criteria.Get the first page of sorted feed elements that match the search criteria.Get the feed elements and comments that match the search criteria.Get a page of feed elements that match the search criteria.Get a page of sorted feed elements that match the search criteria.Get a page of feed elements with comments in a threaded style that match the search criteria.Get a page of sorted feed elements that match the search criteria. Each feed element includes no more than the specified number of comments.Get the feed elements from the Company, DirectMessageModeration, Home, Isolated, Moderation, and PendingReview feeds that match the search criteria.Get a page of sorted feed elements from the Company, DirectMessageModeration, Home, Isolated, Moderation, and PendingReview feeds that match the search criteria.Get a page of sorted feed elements from the Company, DirectMessageModeration, Home, Isolated, Moderation, and PendingReview feeds that match the search criteria. Each feed element includes no more than the specified number of comments.Get a page of sorted and filtered feed elements from the Home feed that match the search criteria. Each feed element includes no more than the specified number of comments.Search up to 5,000 of the most recent feed elements in a feed for a subject ID that match the search string. Feed elements are returned in order of most recent activity.Get a page of sorted feed elements from a feed for a record or user that match the search criteria.Get a page of sorted feed elements from a feed that match the search criteria. Each feed element includes no more than the specified number of comments.Get a page of sorted and filtered feed elements from a UserProfile feed that match the search criteria.Get a page of sorted and filtered feed elements from a case feed that match the search criteria.Get a page of sorted feed elements from a feed for a record or user that match the search criteria. Each feed element includes no more than the specified number of comments. Specify whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of sorted and filtered feed elements from a feed for a record or user that match the search criteria. Each feed element includes no more than the specified number of comments. Specify whether to return feed elements posted by internal (non-Experience Cloud site) users only.Get a page of sorted and filtered feed elements from a case feed that match the search criteria.Get the feed elements from a feed filtered by a key prefix that match the search criteria.Get a page of sorted feed elements from a feed filtered by a key prefix that match the search criteria.Get a page of sorted feed elements from a feed filtered by a key prefix that match the search criteria. Each feed element includes no more than the specified number of comments.Search the Chatter feed streams for the context user.Search and sort the Chatter feed streams for the context user.Search the Chatter feed streams for the context user and return a page of results.Search the Chatter feed streams for the context user and return a sorted page of results.Search the Chatter feed streams from all Experience Cloud sites for the context user and return a sorted page of results.Mark a comment as verified or unverified.Mark a comment as verified by an anonymous user.Upvote or downvote a comment.Set the status of a comment.Set a feed element to closed.Upvote or downvote a feed element.Set the status of a feed post.Mute or unmute a feed element.Mark a feed element as read for the context user using an input class.Mark a feed element as read for the context user.Edit a comment.Update the members of a direct message.Edit a feed element.Bookmark a feed element or remove a bookmark from a feed element using an input class.Bookmark a feed element or remove a bookmark from a feed element.Mark multiple feed elements as read by the context user at the same time using an input class.Mark multiple feed elements as read by the context user at the same time.Like or unlike a comment.Like or unlike a feed element.Pin or unpin feed elements to a group or topic feed.Update a Chatter feed stream.Vote on a poll or change your vote on a poll.These test methods are for ChatterFeeds. All methods are static.Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getFeedElementsFromFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getFeedElementsFromFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getFeedElementsFromFeed method is called in a test context. Use the method with the same parameters or you receive an exception. a ConnectApi.FeedElementPage object to be returned when the matching getFeedElements​​FromFilterFeed method is called in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching getFeedElements​​FromFilterFeed method is called in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching getFeedElements​​FromFilterFeed method is called in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedElementPage object to be returned when the getFeedElementsFromFilterFeedUpdatedSince method is called in a test context.Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.RelatedFeedPosts object to be returned when the matching ConnectApi.getRelatedPosts(communityId, feedElementId, filter, maxResults) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getTopUnansweredQuestions method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getTopUnansweredQuestions method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getTopUnansweredQuestions method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getTopUnansweredQuestions method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElements method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElements method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElements method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElements method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElements method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElements method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElements method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when searchFeedElementsInFeed is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFilterFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFilterFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFilterFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStream(communityId, q) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStream(communityId, q, sortParam) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStreams(communityId, q, pageParam, pageSize) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStreams(communityId, q, pageParam, pageSize, sortParam) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStreams(communityId, q, pageParam, pageSize, sortParam, globalScope) method is called in a test context. Use the method with the same parameters or you receive an exception.These methods for ChatterFeeds are retired.Delete a feed item.Get comments for a feed item. Get a page of comments for a feed item.Get a feed item. Get a list of feed items.Get feed items from the Company, Home, and Moderation feeds.Get a page of sorted feed items from the Company, Home, and Moderation feeds. Get a page of sorted feed items from the Company, Home, and Moderation feeds. Each feed item contains no more than the specified number of comments. Get feed items from a feed for a user or record.Get a page of sorted feed items from a feed for a user or record.Get a page of sorted feed items from a feed for a user or record. Each feed item includes no more than the specified number of comments. Get a page of sorted feed items from a record feed for a user or record. Each feed item includes no more than the specified number of comments. Specify whether to return feed items posted by internal (non-Experience Cloud site) users only.Get feed items from a feed filtered by a key prefix for a user.Get a page of sorted feed items from a feed filtered by a key prefix for a user.Get a page of sorted feed items from a feed filtered by a key prefix for a user. Each feed item contains no more than the specified number of comments. Get a page of feed items from a feed filtered by a key prefix for a user. Include only feed items that have been updated since the time specified in the updatedSince parameter.Get a page of feed items from the Company, Home, and Moderation feeds. Include only feed items that have been updated since the time specified in the updatedSince parameter. Each feed item contains no more than the specified number of comments.Get a page of feed items from the Files, Groups, News, People, and Record feeds. Include only feed items that have been updated since the time specified in the updatedSince parameter. Each feed item contains no more than the specified number of comments.Get a page of feed items from a record feed. Include only feed items that have been updated since the time specified in the updatedSince parameter. Specify whether to return feed items posted by internal (non-Experience Cloud site) users only.Get the poll associated with a feed item.Get likes for a feed item.Get a page of likes for a feed item. Like a feed item for the context user.Post a plain-text comment to a feed item.Post a rich-text comment to a feed item. Use this method to include mentions and to attach a file to a comment.Post a rich-text feed element. Include mentions and hashtag topics, attach a file to a feed element, and associate action link groups with a feed element. You can also use this method to share a feed element and add a comment. Post a plain-text feed item. Post a rich-text feed item to a feed. Use this method to include mentions and hashtag topics and to attach a file to a feed item. You can also use this method to share a feed item and add a comment.Get the feed items that match the search criteria. Get the sorted feed items that match the search criteria.Get a page of feed items that match the search criteria.Get a page of sorted feed items that match the search criteria.Get a page of sorted feed items that match the search criteria.Get the feed items from the Company, Home, and Moderation feeds that match the search criteria.Get a page of sorted feed items from the Company, Home, and Moderation feeds that match the search criteria. Get a page of sorted feed items from the Company, Home, and Moderation feeds that match the search criteria. Each feed item includes no more than the specified number of comments. Get the feed items from a feed that match the search criteria.Get a page of sorted feed items from a feed for a user or record that match the search criteria.Get a page of sorted feed items from a feed that match the search criteria. Each feed item includes no more than the specified number of comments.Get a page of sorted feed items from a feed for a user or record that match the search criteria. Each feed item includes no more than the specified number of comments. Specify whether to return feed items posted by internal (non-Experience Cloud site) users only.Get the feed items that match the search criteria from a feed filtered by a key prefix for a user.Get a page of sorted feed items that match the search criteria from a feed filtered by a key prefix for a user.Get a page of sorted feed items that match the search criteria from a feed filtered by a key prefix for a user. Each feed item includes no more than the specified number of comments.Share the originalFeedElementId as the context user.Share the originalFeedItemId to the feed specified by the feedType. Bookmark a feed item or remove a bookmark from a feed item.Vote or change your vote on a feed poll. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​FromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​FromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​FromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​FromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​FromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​FromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​FromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when the matching getFeedItems​​FromFilterFeed method is called in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching getFeedItems​​FromFilterFeed method is called in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching getFeedItems​​FromFilterFeed method is called in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.FeedItemPage object to be returned when the getFeedItemsFromFilterFeedUpdatedSince method is called in a test context.Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​UpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​UpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a ConnectApi.FeedItemPage object to be returned when getFeedItems​UpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception. Register a test feed item page to be returned when searchFeedItems(communityId, q) is called during a test.Register a test feed item page to be returned when searchFeedItems(String, String, ConnectApi.FeedSortOrder) is called during a test.Register a test feed item page to be returned when searchFeedItems(String, String, String, Integer) is called during a test.Register a test feed item page to be returned when searchFeedItems(String, String, String, Integer, ConnectApi.FeedSortOrder) is called during a test.Register a test feed item page to be returned when searchFeedItems(communityId, q, recentCommentCount, pageParam, pageSize, sortParam) is called during a test.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFilterFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFilterFeed method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFilterFeed method is called in a test context. Use the method with the same parameters or you receive an exception.
• ChatterGroups Class: Information about groups, such as the group’s members, photo, and the groups the specified user is a member of. Add members to a group, remove members, and change the group photo. These methods are for ChatterGroups. All methods are static.Add a user to a group as a standard member. Add a user with a role to a group.Associate a record with a group.Create a group.Delete the group banner photo.Delete a group.Remove a member from a group. Delete the group photo.Get the first page of announcements in a group.Get a page of announcements in a group.Get the group banner photo.Get information about a group. Get information about a list of groups.Get information about a request to join a private group. Get information about every request to join a private group. Get information about every request to join a private group that has a specified status. Get the first page of groups.Get a page of groups. Get a page of groups with an archive status. Get information about a group member. Get the first page of information about the members of a group.Get a page of information about the members of a group.Get information about a list of group memberships.Get the context user’s Chatter settings for a group. Get the photo for a group. Get a record associated with a group.Get the first page of records associated with a group.Get a page of records associated with a group.Invite internal and external users to join a group.Post an announcement to a group.Remove the association of a record with a group.Request membership in a private group. Get the first page of groups that match the search criteria.Get a page of groups that match the search criteria.Get a page of groups with the archive status that match the search criteria.Set an uploaded file as the group banner photo.Set a file that hasn’t been uploaded as the group banner photo.Set and crop an uploaded file as the group banner photo.Set and crop a file that hasn’t been uploaded as the group banner photo.Set an uploaded file as the group photo.Set a file that hasn’t been uploaded as the group photo.Set and crop an uploaded file as the group photo.Set and crop a file that hasn’t been uploaded as the group photo.Update the settings of a group.Update the role of a group member.Update the context user’s email frequency for a group.Update a request to join a private group. Update a request to join a private group and optionally provide a message when the request is denied.These test methods are for ChatterGroups. All methods are static.Register a ConnectApi.ChatterGroupPage object to be returned when the matching ConnectApi.searchGroups method is called in a test context. Use the test method with the same parameters or you receive an exception.Register a ConnectApi.ChatterGroupPage object to be returned when the matching ConnectApi.searchGroups method is called in a test context. Use the test method with the same parameters or you receive an exception.Register a ConnectApi.ChatterGroupPage object to be returned when the matching ConnectApi.searchGroups method is called in a test context. Use the test method with the same parameters or you receive an exception.
• ChatterMessages Class: Get, send, search, and reply to private messages. You can also get and search private conversations, mark conversations as read, and get a count of unread private messages.These methods are for ChatterMessages. All methods are static.Get a conversation. Get a page of a conversation. Get a conversation from an Experience Cloud site.Get a page of a conversation from an Experience Cloud site.Get the most recent conversations.Get a page of conversations. Get the most recent conversations from an Experience Cloud site.Get a page of conversations from an Experience Cloud site.Get a message. Get a message from an Experience Cloud site.Get the most recent messages.Get a page of messages.Get the most recent messages from an Experience Cloud site.Get a page of messages from an Experience Cloud site.Get the number of conversations that are marked unread.Get the number of conversations that are marked unread in an Experience Cloud site.Mark a conversation as read or unread. Mark a conversation as read or unread in an Experience Cloud site.Reply to a message. Reply to a message in an Experience Cloud site.Get a conversation that matches the search criteria. Get a conversation with a page of messages that match the search criteria. Get a conversation with messages that match the search criteria in an Experience Cloud site.Get a conversation with a page of messages that match the search criteria in an Experience Cloud site.Get conversations in which member names and messages match the search criteria. Get a page of conversations in which member names and messages match the search criteria. Get conversations in which member names and messages match the search criteria in an Experience Cloud site.Get a page of conversations in which member names and messages match the search criteria in an Experience Cloud site.Get messages that match the search criteria. Get a page of messages that match the search criteria. Get messages that match the search criteria in an Experience Cloud site.Get a page of messages that match the search criteria in an Experience Cloud site.Send a message to a list of recipients. Send a message to a list of recipients in an Experience Cloud site.
• ChatterUsers Class: Access information about users, such as activity, followers, subscriptions, files, and groups.These methods are for ChatterUsers. All methods are static.Export Chatter-related user activity, such as bookmarks, topic endorsements, and votes.Follow a user or record. Get the default Chatter settings for a user. Get the first page of followers for a user.Get a page of followers for a user. Get the first page of users and records that a user follows.Get a page of users and records that a user follows.Get a page with the specified number of users and records that a user follows.Get the first page of records, filtered by key prefix, that a user follows.Get a page of records, filtered by key prefix, that a user follows.Get a page with the specified number of records, filtered by key prefix, that a user follows.Get a user’s reputation.Get information about a user.Get information about a list of users.Get a user’s groups.Get a page of a user’s groups. Get the first page of users.Get a page of users. Start a job to purge Chatter-related user activity, such as bookmarks, topic endorsements, and votes.Get the user’s groups that match the search criteria.Get a page of a user’s groups that match the search criteria.Get the first page of users that match the search criteria.Get a page of users that match the search criteria. Get a page of users that match the search criteria. Update the default Chatter settings for a user.Update the About Me section for a user.These test methods are for ChatterUsers. All methods are static.Register a ConnectApi.UserPage object to be returned when the matching ConnectApi.searchUsers method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.UserPage object to be returned when the matching ConnectApi.searchUsers method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.UserPage object to be returned when the matching ConnectApi.searchUsers method is called in a test context. Use the method with the same parameters or you receive an exception.These methods for ChatterUsers are retired.Delete a user’s photo.Get the groups that a user is a member of. Get a page of groups that a user is a member of.Get a user’s photo. Get the user’s groups that match the search criteria.Get a page of a user’s groups that match the search criteria.Set an uploaded file as a user’s photo. Set a file that hasn’t been uploaded as the user’s photo.Set and crop an uploaded file as a user’s photo.Set and crop a file that hasn’t been uploaded as a user’s photo.
• Chatter Class: Access information about followers and subscriptions for records.These methods are for Chatter. All methods are static.Delete a subscription. Use this method to stop following a record, a user, or a file.Get the first page of followers for a record.Get a page of followers for a record. Get information about a subscription.Submit a daily or weekly Chatter email digest job.
• Clm Class: Create and update Contract Lifecycle Management (CLM) contracts using object ID.These methods are for Clm. All methods are static.Create contracts using the object ID.Update contracts using the object ID.
• CommerceBuyerExperience Class: Create, delete, or get commerce addresses. Get order delivery group, order item, order shipments, shipment items, and order summaries. Get adjustments for order items and order summaries.These methods are for CommerceBuyerExperience. All methods are static.Add an order to a cart using a webstore order summary.Add an order to a cart for a specific account using a webstore order summary.Submit a job to calculate adjustment aggregates for a list of order summary IDs. Create a Commerce account address for a webstore account. Delete a Commerce account address for a webstore. Get a Commerce account address for a webstore. Get Commerce account addresses for a webstore and account. Get Commerce account addresses for a webstore and account.Get Commerce account addresses for a webstore and account.Get Commerce account addresses for a webstore and account.Get Commerce account addresses for a webstore and account.Get order delivery group summaries.Get order delivery group summaries.Get a page of order delivery group summaries.Get order delivery group summaries with specific fields.Get a page of order delivery group summaries with specific fields.Get order delivery group summaries with specific fields.Get a sorted list of order delivery group summaries with specific fields.Get a sorted list of order delivery group summaries with specific fields.Get order item summaries.Get order item summaries.Get order item summaries for a delivery group summary.Get order item summaries for a delivery group summary.Get a page of order item summaries for a delivery group summary.Get order item summaries for a delivery group summary with specific fields.Get order item summaries for a delivery group summary with specific fields.Get a page of order item summaries for a delivery group summary with specific fields.Get a sorted list of order item summaries for a delivery group summary with specific fields.Get a sorted page of order item summaries for a delivery group summary with specific fields.Get a sorted page of order item summaries for a delivery group summary with specific fields and include adjustment details.Get adjustments for order items.Get adjustments for order items.Get order shipment items.Get order shipment items.Get order shipment items with specific fields.Get a page of order shipment items with specific fields.Get a sorted page of order shipment items.Get order shipments.Get order shipments.Get order shipments with specific fields.Get a page of order shipments with specific fields.Get a sorted page of order shipments with specific fields.Get order summaries.Get order summaries.Get order summaries with specific fields.Get a page of order summaries with specific fields.Get a sorted page of order summaries with specific fields.Get a sorted page of order summaries with specific fields within a specific date range.Get a sorted page of order summaries with specific fields within a specific date range and scoped to orders owned by the context user.Get a sorted page of order summaries with specific fields within a specific date range and scoped to orders owned by the context user. Get an order summary. Get an order summary with fields. Get an order summary with fields and include adjustment details. Get adjustments for an order summary.Get adjustments for an order summary.Look up details about an order summary for a guest shopper or a registered buyer using the effective account ID, requested fields, line items, delivery groups, adjustments aggregates, and adjustments. Look up details about an order summary for a guest shopper or a registered buyer using the effective account ID and requested fields.Look up details about an order summary for a guest shopper or a registered buyer using the effective account ID. Update a Commerce account address for a webstore.
• CommerceCart Class: Get, create, update, calculate, and delete carts. Get cart items, add items to carts, update and delete cart items.These methods are for CommerceCart. All methods are static. Add an item to a cart of a specific currency. Add an item to a cart of a specific currency.Add a batch of up to 100 items to a cart.Add a batch of up to 100 items to a cart of a specific currency.Add an item to a cart. Apply a coupon to a cart. Apply a coupon to a cart. Copy the products from a cart to a wishlist.Calculate a cart.Calculate a cart.Create a cart.Create a cart from an approved quote, or duplicate a draft quote into a cart by converting the quote into cart items. Create a new quote from an active cart by converting cart items into quote line items. Clones an existing cart to create a secondary, read-only cart to support Pay Now functionality. Sets the guest cart status to PendingDelete in a B2B store.Delete a cart. Sets the guest cart status to PendingDelete in a B2B store or Closed in a D2C store. Delete a coupon from a cart. Delete a coupon from a cart. Delete an item from a cart.Delete an inventory reservation.Evaluate shipping costs for a cart.Evaluate taxes for a cart. Get coupons for a cart. Get coupons for a cart.Get promotions for a cart item.Get a promotion for a cart item.Get items in a cart.Get a page of items in a cart.Get a sorted page of items in a cart.Get a specified size page of items in a cart.Get a specified size, sorted page of items in a cart.Get a specified size, sorted page of items filtered by product fields in a cart.Get a specified size, sorted page of items filtered by product fields in a cart.Get a sorted page of items in a cart, including coupons and promotions.Get a specific, sorted page of items in a cart, including coupons and promotions.Get promotions for a cart.Get promotions for a cart in a specific currency.Get a cart.Get a cart in a specific currency.Get a cart or create an active cart if one doesn’t exist.Get a cart in a specific currency, or create an active cart if one doesn’t exist.Get cart items of a specific product.Get the items in a cart, sorted by product ID.Make a secondary cart a primary cart. Preserve cart contents when a guest logs in as an authenticated customer. Sets the guest cart status to PendingDelete in a B2B store or Closed in a D2C store.Set the visibility for cart messages.Update an item in a cart.Update an item in a cart of a specific currency.Update an item in a cart of a specific currency.Create or update an inventory reservation.
• CommerceCatalogManagement Class: Create or update a composite product. Create a variation product.These methods are for CommerceCatalogManagement. All methods are static.Create a composite product.Update a composite product.Create a variation product.
• CommerceCatalog Class: Get products, product categories, and product category paths.These methods are for CommerceCatalog. All methods are static.Retrieve product category menu items for the given parent item and store.Get a product.Get a product with variation and attribute information.Get a product with quantity rule information.Get detailed information for a product, optionally including information about its product selling models.Get detailed information for a product without its entitlement information.Get detailed information for a product without its entitlement information.Get detailed information for a product without its entitlement information.Get a product category.Get product categories.Get the product category path from the root category to the current category.Get a collection of child products related to a parent product.Get a collection of child products related to a parent product. Get fields, prices, and default images for a list of products. Get fields and default images for a list of products.Get fields and default images for a list of products.Get fields and default images for a list of products.
• CommercePromotions Class: Evaluate promotions for Commerce orders. Get coupon code redemption usage.These methods are for CommercePromotions. All methods are static.Get coupon code redemption usage to revert a previously redeemed coupon code.Determine which promotions the customer is eligible for based on the store and buyer group, and compute the applicable price adjustments based on the coupons and the items in the cart. This API evaluates only the first 50 active manual promotions and first 50 active automatic promotions, based on priority. This API computes and returns applicable price adjustments, but it does not apply those adjustments to the webcart record. If you want to enable promotions based on shipping, contact Salesforce Customer Support.Get coupon code redemption addition (increase) usage.
• CommerceQuotes Class: These methods are for CommerceQuotes. All methods are static.Initiate a quote renegotiation or decline a quote.Get quote details associated with a specified account.Get all quotes associated with a specified account. Create a quote from a product.
• CommerceSearchConnectFamily Class: Search products by search term or category in a webstore.These methods are for CommerceSearchConnectFamily. All methods are static. Search products by search term or category in a webstore. Search products by search term or category in a webstore.
• CommerceSearchSettings Class: Get indexes. Get index logs. Create an index of a product catalog.These methods are for CommerceSearchSettings. All methods are static.Create an index of a product catalog.Get a Commerce search index.Get Commerce search indexes.Get Commerce search index logs.
• CommerceSearch Class: Get sort rules for the live search index. Get product search suggestions. Search products.These methods are for CommerceSearch. All methods are static.Get sort rules for the live index.Get suggestions for product searches.Get suggestions for product searches.Get suggestions for product searches.Get suggestions for product searches.Search products.
• CommerceStorePricing Class: Get product prices.These methods are for CommerceStorePricing. All methods are static.Get the list and buyer price for a product.Get a product’s list and buyer price for specified product selling models.Get the prices for multiple products using multiple product IDs.Get the prices for multiple products using multiple product IDs and a currency ISO code.Get the prices for multiple products.Get the prices for multiple products using a currency ISO code.
• CommerceWishlist Class: Get, create, update, and delete wishlists. Add wishlists to carts. Get wishlist items, add items to wishlists, and delete wishlist items.These methods are for CommerceWishlist. All methods are static.Add an item to a wishlist for the context user.Add an item to a wishlist.Add a wishlist to the active cart for the context user.Add a wishlist to the active cart.Add a wishlist to a cart.Add a wishlist to a cart.Create a wishlist for the context user.Create a wishlist.Delete a wishlist for the context user.Delete a wishlist.Get a wishlist with product fields sorted by items.Get a wishlist with product fields sorted by items with a specified number of items per page.Get a page of sorted wishlist items with product fields.Get a page of specified size of sorted wishlist items with product fields.Get wishlist summaries.Get wishlist summaries with product fields sorted by items.Get wishlist summaries with product fields sorted by items with a specified number of items per page.Remove an item from a wishlist.Update the name of a wishlist for the context user.Update the name of a wishlist.
• Communities Class: Get information about Experience Cloud sites in your org.These methods are for Communities. All methods are static.Get a list of Experience Cloud sites that the context user has access to.Get a list of Experience Cloud sites with the specified status that the context user has access to. Get information about an Experience Cloud site.
• CommunityModeration Class: Get information about flagged feed items and comments in an Experience Cloud site. Add and remove flags from comments and feed items.These methods are for CommunityModeration. All methods are static.Add a moderation flag to a comment.Add a moderation flag of the specified visibility to a comment.Add a moderation flag of the specified type to a comment.Add a moderation flag with a note to a comment.Add a moderation flag of the specified type with a note to a comment.Add a moderation flag of the specified type and visibility to a comment.Add a moderation flag of the specified visibility with a note to a comment.Add a moderation flag of the specified type and visibility with a note to a comment.Add a moderation flag to a feed element.Add a moderation flag of the specified visibility to a feed element.Add a moderation flag of the specified type to a feed element.Add a moderation flag with a note to a feed element.Add a moderation flag of the specified type with a note to a feed element.Add a moderation flag of the specified type and visibility to a feed element.Add a moderation flag of the specified visibility with a note to a feed element.Add a moderation flag of the specified type and visibility with a note to a feed element.Get the moderation flags on a comment. Get the moderation flags with specified visibility on a comment.Get a page of moderation flags on a comment.Get a page of moderation flags with specified visibility on a comment.Get the moderation flags on a feed element.Get the moderation flags with specified visibility on a feed element.Get a page of moderation flags on a feed element.Get a page of moderation flags with specified visibility on a feed element.Remove a moderation flag from a comment.Remove a moderation flag from a feed element.These methods for CommunityModeration are retired.Add a moderation flag to a feed item.Add a moderation flag with specified visibility to a feed item.Get the moderation flags on a feed item.Get the moderation flags with specified visibility on a feed item.Remove a moderation flag from a feed item.
• ContentHub Class: Access Files Connect repositories and their files and folders.These methods are for ContentHub. All methods are static.Add a repository item.Add a repository item in an Experience Cloud site.Add a repository item, including the binary file.Add a repository item, including the binary file, in an Experience Cloud site.Get the item types that the context user is allowed to create in the repository folder.Get the item types, filtered by type, that the context user is allowed to create in the repository folder.Get the item types that the context user is allowed to create in the repository folder in an Experience Cloud site.Get the item types, filtered by type, that the context user is allowed to create in the repository folder in an Experience Cloud site.Get a repository file preview.Get a page or page range of a repository file preview.Get a repository file preview in an Experience Cloud site.Get a page or page range of a repository file preview in an Experience Cloud site.Get information about an item type associated with a repository.Get information about an item type associated with a repository in an Experience Cloud site.Get information about a repository file’s supported previews.Get information about a repository file’s supported previews in an Experience Cloud site.Get a list of repositories.Get a list of repositories in an Experience Cloud site.Get a page of repositories.Get a page of repositories in an Experience Cloud site.Get a repository.Get a repository in an Experience Cloud site.Get a repository file.Get a repository file with or without permissions information.Get a repository file in an Experience Cloud site.Get a repository file with or without permissions information in an Experience Cloud site.Get a repository folder.Get a repository folder in an Experience Cloud site.Get repository folder items.Get repository folder items in an Experience Cloud site.Get a page of repository folder items.Get a page of repository folder items in an Experience Cloud site.Update the name of a repository file.Update the content of a repository file.Update the name of a repository file in an Experience Cloud site.Update the content of a repository file in an Experience Cloud site.These test methods are for ContentHub. All methods are static.Register a ConnectApi.RepositoryFolderItem object to be returned when the matching addRepositoryItem(repositoryId, repositoryFolderId, file) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFolderItem object to be returned when the matching addRepositoryItem(communityId, repositoryId, repositoryFolderId, file) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFolderItem object to be returned when the matching addRepositoryItem(repositoryId, repositoryFolderId, file, fileData) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFolderItem object to be returned when the matching addRepositoryItem(communityId, repositoryId, repositoryFolderId, file, fileData) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubAllowedItemTypeCollection object to be returned when the matching getAllowedItemTypes(repositoryId, repositoryFolderId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubAllowedItemTypeCollection object to be returned when the matching getAllowedItemTypes(repositoryId, repositoryFolderId, filter) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubAllowedItemTypeCollection object to be returned when the matching getAllowedItemTypes(communityId, repositoryId, repositoryFolderId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubAllowedItemTypeCollection object to be returned when the matching getAllowedItemTypes(communityId, repositoryId, repositoryFolderId, filter) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FilePreview object to be returned when the matching getFilePreview(repositoryId, repositoryFileId, formatType) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FilePreview object to be returned when the matching getFilePreview(repositoryId, repositoryFileId, formatType, startPageNumber, endPageNumber) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FilePreview object to be returned when the matching getFilePreview(communityId, repositoryId, repositoryFileId, formatType) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FilePreview object to be returned when the matching getFilePreview(communityId, repositoryId, repositoryFileId, formatType, startPageNumber, endPageNumber) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubItemTypeDetail object to be returned when the matching getItemType(repositoryId, repositoryItemTypeId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubItemTypeDetail object to be returned when the matching getItemType(communityId, repositoryId, repositoryItemTypeId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FilePreviewCollection object to be returned when the matching getPreviews(repositoryId, repositoryFileId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.FilePreviewCollection object to be returned when the matching getPreviews(communityId, repositoryId, repositoryFileId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubRepositoryCollection object to be returned when the matching getRepositories() method is called in a test context. Use the method with the same parameters or you receive an exception. Register a getRepositories(communityId) object to be returned when the matching ConnectApi.ContentHubRepositoryCollection method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubRepositoryCollection object to be returned when the matching getRepositories(pageParam, pageSize) method is called in a test context. Use the method with the same parameters or you receive an exception. Register a ConnectApi.ContentHubRepositoryCollection object to be returned when the matching getRepositories(communityId, pageParam, pageSize) method is called in a test context. Use the method with the same parameters or you receive an exception. Register a ConnectApi.ContentHubRepository object to be returned when the matching getRepository(repositoryId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ContentHubRepository object to be returned when the matching getRepository(communityId, repositoryId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFileDetail object to be returned when the matching getRepositoryFile(repositoryId, repositoryFileId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFileDetail object to be returned when the matching getRepositoryFile(repositoryId, repositoryFileId, includeExternalFilePermissionsInfo) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFileDetail object to be returned when the matching getRepositoryFile(communityId, repositoryId, repositoryFileId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFileDetail object to be returned when the matching getRepositoryFile(communityId, repositoryId, repositoryFileId, includeExternalFilePermissionsInfo) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFolderDetail object to be returned when the matching getRepositoryFolder(repositoryId, repositoryFolderId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFolderDetail object to be returned when the matching getRepositoryFolder(communityId, repositoryId, repositoryFolderId) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFolderItemsCollection object to be returned when the matching getRepositoryFolderItems(repositoryId, repositoryFolderId) method is called in a test context. Use the method with the same parameters or you receive an exception. Register a ConnectApi.RepositoryFolderItemsCollection object to be returned when the matching getRepositoryFolderItems(communityId, repositoryId, repositoryFolderId) method is called in a test context. Use the method with the same parameters or you receive an exception. Register a ConnectApi.RepositoryFolderItemsCollection object to be returned when the matching getRepositoryFolderItems(repositoryId, repositoryFolderId, pageParam, pageSize) method is called in a test context. Use the method with the same parameters or you receive an exception. Register a ConnectApi.RepositoryFolderItemsCollection object to be returned when the matching getRepositoryFolderItems(communityId, repositoryId, repositoryFolderId, pageParam, pageSize) method is called in a test context. Use the method with the same parameters or you receive an exception. Register a ConnectApi.RepositoryFileDetail object to be returned when the matching updateRepositoryFile(communityId, repositoryId, repositoryFileId, file, fileData) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFileDetail object to be returned when the matching updateRepositoryFile(repositoryId, repositoryFileId, file) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFileDetail object to be returned when the matching updateRepositoryFile(repositoryId, repositoryFileId, file, fileData) method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.RepositoryFileDetail object to be returned when the matching updateRepositoryFile(communityId, repositoryId, repositoryFileId, file) method is called in a test context. Use the method with the same parameters or you receive an exception.
• ConversationApplicationDefinition Class: Access information about a conversation application definition.These methods are for ConversationApplicationDefinition. All methods are static.Get information about an integration’s conversation application definition and the associated bot.
• ConnectApi.CreatedFile: Represents a single file created during a FetchOptimizationFiles operation. Contains the ID of the Content Version record created in the org and an indicator of whether the creation succeeded.
• Datacloud Class: Purchase Data.com contact or company records, and retrieve purchase information. These methods are for Datacloud. All methods are static.Get a list of purchased company records for an order.Get a company record.Get a contact.Get a list of purchased contacts for an order.Get an order.Get purchase usage information for a user.Purchase records that are listed in an input file.
• EinsteinLLM Class: Get a list of prompt templates and generate LLM responses for prompt templates.These methods are for EinsteinLLM. All methods are static.Generates a response using the specified prompt template and input parameters.Get a list of prompt templates using the specified filters.
• EmailMergeFieldService Class: Extract a list of merge fields for an object. A merge field is a field you can put in an email template, mail merge template, custom link, or formula to incorporate values from a record.These methods are for EmailMergeFieldService. All methods are static.Extract the merge fields for a specific object.
• EmployeeProfiles Class: Get, set and crop, and delete employee banner photos and photos.These methods are for EmployeeProfiles. All methods are static.Delete an employee’s banner photo.Delete an employee’s photo.Get an employee’s banner photo.Get an employee’s photo.Set an uploaded file as an employee’s banner photo.Set a file that hasn’t been uploaded as an employee’s banner photo.Set and crop an uploaded file as an employee’s banner photo.Set and crop a file that hasn’t been uploaded as an employee’s banner photo.Set an uploaded file as an employee’s photo.Set a file that hasn’t been uploaded as an employee’s photo.Set and crop an uploaded file as an employee’s photo.Set and crop a file that hasn’t been uploaded as an employee’s photo.
• Exchanges Class: Preview and submit cart to exchange orders.These methods are for Exchanges. All methods are static.Retrieves a preview of an exchange order, taking into account the order summary balance and the difference between the return order and the cart that represents the exchange order.Creates an exchange order summary, based on the return order and the cart used for exchanges. The new exchange order summary is attached to the original order summary (created before any exchanges occurred). You can also provide optional payment information and optional information about order summary sequences, which affect the newly created exchange order summary.
• ExtendedCommerceDelivery Class: Access information about delivery estimation.This method is for ExtendedCommerceDelivery. It is static.Forecast an expected delivery date and time based on delivery estimation settings and the selected shipping carrier method. Provide information on when a package is expected to be shipped and delivered.
• ExternalEmailServices Class: Access information about integration with external email services, such as sending email within Salesforce through an external email account.These methods are for ExternalEmailService. All methods are static.Get information about whether an external email service has been authorized to send email on behalf of a user.
• ExternalManagedAccount Class: Get externally managed accounts.These methods are for ExternalManagedAccount. All methods are static.Get externally managed accounts available to the context user across all Experience Cloud sites.Get externally managed accounts available to the context user, including the context user’s account, across all Experience Cloud sites.Get externally managed accounts for a store.Get externally managed accounts, including the context user’s account, for a store.
• FieldService Class: Preview and create shifts from a pattern.These methods are for FieldService. All methods are static.Create up to 2,000 shifts from a pattern.Preview up to 2,000 shifts from a pattern.
• FlowApprovalProcesses Class: Get the status and available actions for flow approval processes.These methods are for FlowApprovalProcesses. All methods are static.Get the status and available actions for flow approval processes.
• FulfillmentOrder Class: Fulfill orders in Order Management.These methods are for FulfillmentOrder. All methods are static.Cancel FulfillmentOrderLineItems from a FulfillmentOrder. This action doesn’t cancel the associated OrderItemSummaries, so reallocate the canceled quantities to a new FulfillmentOrder.Create one or more FulfillmentOrders and FulfillmentOrderLineItems for an OrderDeliveryGroupSummary, which defines a delivery method and recipient for an OrderSummary. You specify the OrderItemSummaries to allocate, which can be fulfilled from different locations. Specifying multiple fulfillment groups creates one FulfillmentOrder for each location. For each OrderItemSummary, a FulfillmentOrderLineItem is created and assigned to the corresponding FulfillmentOrder.Create an invoice for a FulfillmentOrder that doesn’t have one.Create FulfillmentOrders for multiple OrderDeliveryGroups in a single request.Create Invoices for multiple FulfillmentOrders.
• IBusinessObjectivesAndRecsFamily Class: Get and patch business objectives, or goals. Get, create, patch, and update recommended actions for business objectives.These methods are for IBusinessObjectivesAndRecsFamily. All methods are static.Create recommended actions for a business objective, or goal.Get business objectives, or goals, for a webstore.Get recommended actions for a business objective, or goal.Partially update a business objective, or goal.Partially update a recommended action associated with a business objective, or goal.Update a recommended action for a business objective, or goal.
• Knowledge Class: Get information about trending articles in Experience Cloud sites.These methods are for Knowledge. All methods are static.Get the top viewed articles for a topic.Get trending articles for an Experience Cloud site.Get the trending articles for a topic in an Experience Cloud site.These test methods are for Knowledge. All methods are static.Register a ConnectApi.KnowledgeVersionArticleCollection object to be returned when the matching ConnectApi.getTrendingArticles method is called in a test context. Use the method with the same parameters or you receive an exception. Register a ConnectApi.KnowledgeVersionArticleCollection object to be returned when the matching ConnectApi.getTrendingArticlesForTopic method is called in a test context. Use the method with the same parameters or you receive an exception.
• LightningScheduler Class: Create and update service appointments.These methods are for LightningScheduler. All methods are static.Create a service appointment.Update a service appointment.
• ManagedContentChannels Class: Get managed content channels. Create, get, update, or delete a managed content channel.These methods are for ManagedContentChannels. All methods are static.Delete a managed content channel.Get a managed content channel.Get managed content channels.Update a managed content channel.Create a managed content channel.
• ManagedContentDelivery Class: Get channels. Get collection items. Get managed content. Get a managed content rendition.These methods are for ManagedContentDelivery. All methods are static.Get managed content delivery channels for the context user.Get collection items for a channel.Get a page of collection items for a channel.Get collection items for an Experience Cloud site.Get a page of collection items for an Experience Cloud site.Get a managed content delivery channel.Get a piece of published content for a channel.Get a piece of published content in a specified language for a channel.Get a piece of published content in a specified language with references for a channel.Get a piece of published content for an Experience Cloud site.Get a piece of published content in a specified language for an Experience Cloud site.Get a piece of published content in a specified language with references for an Experience Cloud site.Get a collection of published contents for a channel.Get a collection of published contents for an Experience Cloud site.Get a managed content rendition for a channel.Get a managed content rendition in a specified language for a channel.These methods for ManagedContentDelivery are retired.Get a managed content delivery channel.Get a collection of published contents for a channel.Get a collection of published contents for an Experience Cloud site.
• ManagedContentSpaces Class: Create, get, update, or delete a managed content space. Get channels in a managed content space. Add or remove channels from a managed content space.These methods are for ManagedContentSpaces. All methods are static.Delete a managed content space.Get a managed content space.Get channels for a managed content space.Get managed content spaces.Update the name or description of a managed content space.Add or remove channels from a managed content space.Create a managed content space.
• ManagedContent Class: Clone managed content. Create and get managed content. Create, delete, or update a digital asset management (DAM) provider instance. Bulk delete managed content. Delete and replace variants. Get channels. Get DAM providers. Get targets that managed content space folders can be shared with. Get and update targets that managed content space folders are shared with. Expose managed content as metadata. Publish and unpublish content.These methods are for ManagedContent. All methods are static.Clone a piece of managed content.Create managed content.Create a digital asset management (DAM) provider instance.Create managed content with content data.Asynchronously bulk delete managed content folders and items for a managed content space.Delete a digital asset management (DAM) provider instance.Delete a managed content variant.Expose managed content as metadata so it can be accessed through Metadata API.Get all managed content versions for a channel.Get all managed content versions for a channel with absolute URLs.Get managed content delivery channels for the context user.Get all managed content versions for an Experience Cloud site.Get all managed content versions for an Experience Cloud site with absolute URLs.Get managed content versions for a channel using a list of content keys.Get managed content versions for a channel using a list of managed content IDs.Get managed content versions for a channel with absolute URLs using a list of managed content IDs.Get information about an import or export job.Get managed content versions for an Experience Cloud site using a list of content keys.Get managed content versions for an Experience Cloud site using a list of managed content IDs.Get managed content versions for an Experience Cloud site with absolute URLs using a list of managed content IDs.Get managed content versions using a list of content topic names.Get managed content versions with absolute URLs using a list of content topic names.Get managed content versions using a list of content keys and content topic names.Get managed content versions using a list of managed content IDs and content topic names.Get managed content versions with absolute URLs using a list of managed content IDs and content topic names.Get digital asset management (DAM) providers.Get digital asset management (DAM) providers for a managed content space.Get a single managed content item for a managed content space.Get targets that a managed content space folder is shared with.Get targets that a managed content space folder can be shared with.Update the targets that a managed content space folder is shared with.Publish content.Replace a managed content variant.Replace a managed content variant, including content data.Unpublish content.Update a digital asset management (DAM) provider instance.These methods for ManagedContent are retired.Get managed content delivery channels for the context user.Get a managed content space.
• ManagedTopics Class: Get managed topics in an Experience Cloud site. Create, delete, and reorder managed topics.These methods are for ManagedTopics. All methods are static.Create a managed topic of a specific type for an Experience Cloud site.Create a child managed topic for an Experience Cloud site.Create a managed topic of a specific type by name for an Experience Cloud site.Create a child managed topic by name for an Experience Cloud site.Delete a managed topic from an Experience Cloud site.Get a managed topic in an Experience Cloud site.Get a managed topic, including its parent and children managed topics, in an Experience Cloud site.Get the featured and navigational managed topics for an Experience Cloud site.Get managed topics of the specified type for an Experience Cloud site.Get managed topics of the specified type, including their parent and children managed topics, in an Experience Cloud site.Get managed topics of the specified type, including their parent and children managed topics, that are associated with topics in an Experience Cloud site.Get a page of managed topics.Reorder the relative positions of managed topics in an Experience Cloud site.These methods for ManagedTopics are retired.Get managed topics of the specified type, including their parent and children managed topics, that are associated with a given topic in an Experience Cloud site.
• MarketingIntegration Class: Get, save, and submit a microsites marketing integration form for an Experience Cloud site.The following are methods for MarketingIntegration. All methods are static.Get a marketing integration form for an Experience Cloud site.Save a marketing integration form for an Experience Cloud site.Submit a marketing integration form for an Experience Cloud site.
• Mentions Class: Access information about mentions. A mention is an “@” character followed by a user or group name. When a user or group is mentioned, they receive a notification.These methods are for Mentions. All methods are static.Get the first page of possible users and groups to mention in a feed item body or comment body.Get a page of possible mention proposals of the specified type.Get information about whether the mentions are valid for the context user.These test methods are for Mentions. All methods are static.Register a ConnectApi.MentionCompletionPage object to be returned when getMentionCompletions(String, String, String) is called in a test context.Register a ConnectApi.MentionCompletionPage object to be returned when getMentionCompletions(String, String, String, ConnectApi.MentionCompletionType, Integer, Integer) is called in a test context.
• Missions Class: Export and purge mission activity for users. Get a user’s mission progress. Update mission activity counts for users.These methods are for Missions. All methods are static.Export mission activity for a user.Get mission activity progress for a user.Start a job to purge mission activity for a user.Start a job to purge mission activity for all users.Update the mission activity count for a user.
• NamedCredentials Class: Create, refresh, get, delete, replace, and update credentials. Create and get external credentials. Create and get named credentials. Create, get, delete, and update external auth identity providers. Get the URL for the OAuth token flow for an external credential.These methods are for NamedCredentials. All methods are static.Create a credential.Refresh an OAuth or AWS Roles Anywhere credential.Create an external auth identity provider.Create external auth identity provider credentials.Create an external credential.Create a named credential.Delete a credential.Delete a credential with authentication parameters.Delete an external auth identity provider.Delete an external credential.Delete a named credential.Get a credential.Get an external auth identity provider.Get external auth identity provider credentials.Get a list of external auth identity providers in the org.Get an external credential, including the named credentials and principals associated with it and the type and status of each principal.Get external credentials that the user can authenticate to.Get a named credential.Get a list of named credentials for the org.Get the URL for the OAuth token flow for an external credential.Update custom credentials.Replace a credential.Update an external auth identity provider.Replace external auth identity provider credentials.Update an external credential.Update a named credential.
• NavigationMenu Class: Get navigation menu items for an Experience Cloud site.These methods are for NavigationMenu. All methods are static.Get navigation menu items for an Experience Cloud site.Get navigation menu items for an Experience Cloud based on an effective account.
• NextBestAction Class: Execute recommendation strategies, get recommendations, manage recommendation reactions.These methods are for NextBestAction. All methods are static.Delete a recommendation reaction.Execute a strategy.Execute a strategy and request a trace.Execute a strategy using an input class.Get a recommendation.Get a recommendation reaction.Get recommendation reactions.Record user reactions to recommendations.
• getTextClassificationsBulkResults(ids): Gets text classification results for request IDs.
• OMSAnalytics Class: These methods are for OMSAnalytics. All methods are static.
• productsExpand(scope, products, expand): Fetches expanded details of a product that aren’t found in the sObject. The expanded variable fields, such as return reasons, are added as output. This method supports an extensibility framework that lets the context user override the existing implementation so they can fetch the data from third-party apps. The application doesn’t require two separate APIs to get return reasons.
• productsReturnRate(pageParam, pageSize): Gets pages of data showing the return rates of products that are calculated by the Customer Data Platform. Return data is paginated in descending order.
• productsReturnRate(pageParam, pageSize): Get a page of products and their return rates.
• productsReturnRate(pageParam, pageSize, products): Get a page of products and their return rates for a list of product IDs.
• OMSAnalytics Class: Get products with return rates, get text classified into different classifications using text analysis, and capture the return reasons from external sources based on the product ids.
• submitTextClassificationsRequest(textClassificationsRequestInput, llmType): Submits a text classification request to Einstein
• OmnichannelInventoryService Class: Route orders to inventory locations in Order Management.These methods are for OmnichannelInventoryService. All methods are static.Create an inventory reservation in Omnichannel Inventory.Fulfill one or more inventory reservations.Retrieve inventory availability data for one or more products at one or more inventory locations or location groups.Retrieve the status of an inventory availability upload job.Retrieve the status of a publish location structure job.Asynchronously publish information about your inventory locations and location groups to Omnichannel Inventory. The publish includes records whose IsEnabled and ShouldSyncWithOci fields are both true. This method returns an ID that you can use to retrieve the status of the publish job.Release one or more existing inventory reservations to free up that inventory.Upload an inventory availability data file to Omnichannel Inventory.Transfer one or more inventory reservations between locations or location groups. This API doesn’t change physical quantities, but reduces the reserved quantity at the source and increases it at the destination.Updates an existing reservation in Omnichannel Inventory. Add, remove, and update quantities for existing SKUs in the reservation.
• OptimizationFiles Class: Fetch files associated with optimization requests for Enhanced Scheduling and Optimization. Requires Field Service to be enabled for the org and the running user to have Field Service enabled.These methods are for OptimizationFiles. All methods are static.Fetch the files generated for an optimization request in Enhanced Scheduling and Optimization.
• Orchestration Class: Get orchestration instances.These methods are for Orchestration. All methods are static.Get an orchestration instance associated with an orchestration instance ID.Get orchestration instances associated with a Salesforce record that’s configured as a context record for orchestration interactive steps.Get orchestration instances associated with either a Salesforce record or an orchestration that’s configured as context for orchestration interactive steps.
• OrderPaymentSummary Class: Work with payments in Order Management.These methods are for OrderPaymentSummary. All methods are static.Create an OrderPaymentSummary for an OrderSummary. Specify a payment authorization or payments that share the same payment method. In an org with the multicurrency feature enabled, the OrderPaymentSummary inherits the CurrencyIsoCode value from the OrderSummary.
• OrderSummaryCreation Class: Create Order Summaries in Order Management.These methods are for OrderSummaryCreation. All methods are static.Create an OrderSummary based on an order. That order is considered the original order for the OrderSummary. Subsequent change orders that apply to the OrderSummary are also represented as orders. You can specify whether the order is managed in Salesforce Order Management or by an external system. Most Salesforce Order Management APIs can run only on orders that it manages.
• OrderSummary Class: Work with orders in Order Management.These methods are for OrderSummary. All methods are static.Retrieve the expected results of adjusting the price of one or more OrderItemSummaries from an OrderSummary, without actually executing the adjustment. The response data contains the financial changes that would result from submitting the proposed adjustment.Adjust the price of one or more OrderItemSummaries from an OrderSummary, and create corresponding change orders.Create a credit memo to represent the refund for one or more change orders associated with an OrderSummary.Create Invoices to represent the charges for one or more change orders. Create Invoices for change orders that increase order amounts, such as for return fees. When you ensure the refund for a return, include the invoices for any associated return fees in the request.Ensure funds for an Invoice and apply them to it and optional define a sequence to capture payments in. If needed, capture authorized funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status.Ensure refunds for a CreditMemo or excess funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and don’t affect the background operation status.Ensure and apply funds for one or more Invoices. If needed, capture authorized funds by sending a request to a payment provider. This method inserts a background operation into an asynchronous job queue and returns the ID of that operation so you can track its status. Payment gateway responses appear in the payment gateway log and do not affect the background operation status.Retrieve the expected change order values for canceling one or more OrderItemSummaries from an OrderSummary, without actually executing the cancel.Retrieve the expected change order financial values for changing order summary fields and related entities, without executing the action.Retrieve the expected change order values for a simple return of one or more OrderItemSummaries from an OrderSummary, without actually executing the return.Cancel one or more OrderItemSummaries from an OrderSummary, and create a corresponding change order.Submit changes to an existing order summary's non-financial fields, pre-fulfillment order item summaries, and related adjustments and taxes, including custom fields.Return one or more OrderItemSummaries from an OrderSummary, and create a corresponding change order. This return is a simple return that creates a change order but not a ReturnOrder.
• Organization Class: Access information about an org.These methods are for Organization. All methods are static.Get information about the context user and the org, including which features are enabled.
• PardotBusinessUnitContext Class: Get the Pardot business units the context user has access to.These methods are for PardotBusinessUnitContext. All methods are static.Get the Pardot business units the context user has access to.Get the Pardot business units the context user has access to by specifying the current status.
• Payments Class: Authorize a payment, capture an authorized payment, and refund an authorized payment.These methods are for Payments. All methods are static.Authorize a payment.Confirms that the merchant is ready to capture payment of an existing pre-authorized transaction.Reverses a payment authorization.Capture an authorized payment.Refund an authorized payment.Captures a payment without any prior authorization and creates a payment entity. The payment sale transaction is a combination of an Authorize transaction and Capture transaction. This payment sale method allows merchants to request that the funds are transferred to the merchant account in a single command, with no further action (such as charging a credit card) from the merchant.Method to take the input parameters of the payment method you want to tokenize and then pass them to the payment gateway's tokenization service. The results of the tokenization request are returned as a response from the payment gateway.
• Personalization Class: Get assigned personalization audiences that match the user context. Create, get, update, and delete an audience. Get personalization targets that match the user context, based on the assigned audiences that include the user. Create and update targets. Get and delete a target.These methods are for Personalization. All methods are static.Create an audience.Create targets.Delete an audience.Delete a target.Get an audience.Get audience information for a comma-separated list of audience IDs.Get a list of assigned audiences that match the user context and record information.Get a list of assigned audiences that match the user context.Get a target.Get target information for a comma-separated list of target IDs.Get a list of targets that match the user context, based on the assigned audiences that include the user.Update an audience.Update targets.
• PickTicket Class: Create tickets to fulfill orders.These methods are for PickTicket. All methods are static.Distribute picked quantities among orders in a pick ticket.
• QuestionAndAnswers Class: Access question and answers suggestions.These methods are for QuestionAndAnswers. All methods are static.Get question and answers suggestions.Register a ConnectApi.QuestionAndAnswersSuggestions object to be returned when getSuggestions is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Choose or change the best answer for a question.
• Recommendations Class: Get and reject Chatter, custom, and static recommendations. Create, get, update, and delete custom recommendation audiences, custom recommendation definitions, and scheduled custom recommendations.These methods are for Recommendations. All methods are static.Create an audience for a custom recommendation.Create an audience for a custom recommendation.Create a custom recommendation definition.Create a custom recommendation definition with the specified parameters.Create a scheduled custom recommendation.Create a scheduled custom recommendation with the specified parameters.Delete a custom recommendation audience.Delete a custom recommendation definition.Delete a custom recommendation definition photo.Delete a scheduled custom recommendation.Get information about a custom recommendation audience.Get the members of a custom recommendation audience.Get a page of custom recommendation audience members.Get custom recommendation audiences.Get a page of custom recommendation audiences.Get a custom recommendation definition.Get a custom recommendation definition photo.Get custom recommendation definitions.Get the Chatter, custom, or static recommendation for the context user for the specified action and object ID.Get the Chatter recommendations, such as user, group, file, article, record, and topic recommendations for the context user. Get the custom and static recommendations for the context user.Get the Chatter, custom, and static recommendations for the context user for the specified action.Get the Chatter, custom, and static recommendations for the context user for the specified action and object category.Get a scheduled custom recommendation.Get scheduled custom recommendations.Reject a Chatter, custom, or static recommendation for the context user for the specified action and object ID.Reject a static recommendation for the context user.Update a custom recommendation audience.Update a custom recommendation definition with the specified parameters.Update a custom recommendation definition.Update a custom recommendation definition photo with a file that hasn’t been uploaded.Update a custom recommendation definition photo with an uploaded file.Update a custom recommendation definition photo with an uploaded file that requires cropping.Update a custom recommendation definition photo with a file that hasn’t been uploaded and requires cropping.Update a scheduled custom recommendation.Update a scheduled custom recommendation with the specified parameters.These test methods are for Recommendations. All methods are static.Register a ConnectApi.RecommendationCollection object to be returned when getRecommendationForUser is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.RecommendationCollection object to be returned when getRecommendationsForUser is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.RecommendationCollection object to be returned when getRecommendationsForUser is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.RecommendationCollection object to be returned when getRecommendationsForUser is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.These methods for Recommendations are retired.Create a scheduled custom recommendation with the specified parameters.Get the Chatter recommendations, such as user, group, file, and record recommendations for the context user. Get the custom and static recommendations for the context user.Get the Chatter, custom, and static recommendations for the context user for the specified action.Get the Chatter, custom, and static recommendations for the context user for the specified action and object category.Get scheduled custom recommendations.Register a ConnectApi.RecommendationCollection object to be returned when getRecommendationsForUser is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.RecommendationCollection object to be returned when getRecommendationsForUser is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.Register a ConnectApi.RecommendationCollection object to be returned when getRecommendationsForUser is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.
• RecordFilterCriteriaFamily Class: Filter records on recordset filter criteria.These methods are for RecordFilterCriteriaFamily. All methods are static.Filter records on recordset filter criteria.
• RecordUi Class: Get picklist values by record type.These methods are for RecordUi. All methods are static.Get the values for all the picklist fields of a specific record type.
• Records Class: Access information about record motifs, which are small icons used to distinguish record types in the Salesforce UI.These methods are for Records. All methods are static.Get a motif that contains the URLs for a set of small, medium, and large motif icons for a record. It can also contain a base color for the record.Get a motif for a list of objects.
• RegisterGuestBuyer Class: Register a guest buyer for a webstore using an account ID, enabling a guest buyer to order on behalf of another buyer.These methods are for RegisterGuestBuyer. All methods are static. Your org must have the Order Management Growth license or Order Management as part of Connected Commerce.Register a guest buyer for a webstore using an account ID. This method enables a guest buyer to order on behalf of another buyer.
• Repricing Class: Perform functions related to repricing orders in Order Management.These methods are for Repricing. All methods are static.Get details of a product in a web store.Search products in a webstore.
• ReturnOrder Class: Process ReturnOrders in Order Management, limited to 2,000 requests per hour.These methods are for ReturnOrder. All methods are static.Create a ReturnOrder and ReturnOrderLineItems for items belonging to an OrderSummary.Process ReturnOrderLineItems belonging to a ReturnOrder. Processing a ReturnOrderLineItem generates a change Order and makes that ReturnOrderLineItem read-only. The change order for a returned item or delivery charge has a positive amount and should be used to create a credit memo. The change order for a return fee has a negative amount and should be used to create an invoice. If a processed ReturnOrderLineItem has any remaining expected quantity, then the API creates a separate ReturnOrderLineItem representing that quantity.
• Routing Class: Route orders to inventory locations in Order Management.These methods are for Routing. All methods are static.Confirm held fulfillment order capacity at one or more locations. This call decreases a location’s held capacity and increases its assigned fulfillment order count. Confirm held capacity when you assign a fulfillment order to a location.Returns combinations of inventory locations that can fulfill an order within a specified limit of shipment splits. By default, checks up to 1,000,000 potential routes, returning a maximum of 10,000 results.For one or more order summaries, find inventory availability using Omnichannel Inventory and identify the fulfillment routes with fewest splits. By default, checks up to 1,000,000 potential routes, returning a maximum of 10,000 results. This method combines the functionality of the getInventoryAvailability() and findRoutesWithFewestSplits() methods.Get information about the current fulfillment order capacity of one or more locations.Hold fulfillment order capacity at a location. Holding capacity at a location reserves a space for a fulfillment order that you’ll assign to it.Calculates the average distance from sets of inventory locations to an order recipient, and ranks them. Use this method to compare the average shipping distances for different sets of locations that can fulfill an order. While this method is executing, you can’t invoke another Apex callout.Release held fulfillment order capacity at one or more locations. This call decreases a location’s held capacity without changing its assigned fulfillment order count. Release held capacity when you cancel the assignment of a fulfillment order to a location.
• SalesforceInbox Class: Access information about Automated Activity Capture, which is available in Einstein and Salesforce Inbox.These methods are for SalesforceInbox. All methods are static.Share emails or events with certain groups of users.
• Search Class: Search objects using keywords or a natural language query.These methods are for Search. All methods are static.Search objects using a natural language query and return an answer.Search an object using a natural language query and return an answer.Search an object using a natural language query and display fields.Search objects using keyword search and return result groups.Search objects using keyword search and a configuration. The search returns result groups.Search objects using keyword search, a configuration, and highlights. The search returns result groups.Search an object using keywords and return results.These test methods are for Search. All methods are static.Registers a ConnectApi.SearchAnswer object to be returned when the matching answer(q) method is called in a test context. Use the method with the same parameters or you receive an exception.Registers a ConnectApi.SearchAnswer object to be returned when the matching answer(q, objectApiName) method is called in a test context. Use the method with the same parameters or you receive an exception.Registers a ConnectApi.SearchAnswer object to be returned when the matching answer(q, objectApiName, displayFields) method is called in a test context. Use the method with the same parameters or you receive an exception.Registers a ConnectApi.SearchResultGroups object to be returned when the matching findAndGroup(q) method is called in a test context. Use the method with the same parameters or you receive an exception.Registers a ConnectApi.SearchResultGroups object to be returned when the matching findAndGroup(q, configurationName) method is called in a test context. Use the method with the same parameters or you receive an exception.Registers a ConnectApi.SearchResultGroups object to be returned when the matching findAndGroup(q, configurationName, highlights) method is called in a test context. Use the method with the same parameters or you receive an exception.Registers a ConnectApi.ScopedSearchResults object to be returned when the matching find(objectApiName, request) method is called in a test context. Use the method with the same parameters or you receive an exception.
• Sites Class: Search an Experience Cloud site.These methods are for Sites. All methods are static.Search an Experience Cloud site.
• SmartDataDiscovery Class: Get predictions on Salesforce objects.
• SocialEngagement Class: Manage information about social accounts or fan pages for social networks.These methods are for SocialEngagement. All methods are static.Delete a social post from its social network.Follow a social persona in its social network.Follow a social persona on a social post in its social network.Get available intents for a social post.Get a managed social account that is in the org and assigned to the user.Gets a list of managed social accounts that are in the org and assigned to the user.Get a list of managed social accounts that are in the org and assigned to the user.Get the follow relationship between a managed social account and a social persona.Hide a social post in its social network.Like a social post in its social network.Approve or reject the publishing of a large number of social posts.Recall an approval request to publish a social post.Stop following a social persona in its social network.Stop following a social persona of a social post in its social network.Unhide a social post in its social network.Unlike a social post in its social network.
• Surveys Class: Send survey invitations by email.These methods are for Surveys. All methods are static.Email survey invitations to up to 300 participants. You can email either leads, contacts, or users in your org. Either a link to launch the survey or a question can be embedded in the email invitations.
• TaxPlatform Class: Apply or cancel tax.These methods are for TaxPlatform. All methods are static.Apply tax or cancel tax.
• Topics Class: Access information about topics, such as their descriptions, the number of people talking about them, related topics, and information about groups contributing to the topic. Update a topic’s name or description, merge topics, and add and remove topics from records and feed items.These methods are for Topics. All methods are static.Assign a topic to a record or feed item.Assign a topic to a record or feed item.Create a topic. Create topic and article assignment rules by data category.Delete a topic. Get information about the five groups that most recently contributed to a topic.Get up to five topics most recently used in a group.Get up to five topics most recently used by a user.Get up to five topics most closely related to a topic.Get a topic.Get topic and article assignment rules by data category.Get the first page of topics assigned to a record or feed item.Get the first page of topics for the org or Experience Cloud site.Get the first page of sorted topics for the org or community.Get a page of topics.Get a page of sorted topics.Get the sorted topics that match the search criteria.Get a page of topics that match the search criteria.Get a page of sorted topics that match the search criteria.Get the topic that matches the exact, case-insensitive name.Get the most recent renamed topic match, if there isn’t an exact match.Get up to a specified number of suggested topics for a record or feed item.Get suggested topics for a record or feed item.Get up to a specified number of suggested topics for a string of text.Get suggested topics for a string of text.Get trending topics for the org or Experience Cloud site.Get up to a specified number of trending topics for the org or Experience Cloud site.Merge up to five secondary topics with a primary topic.Reassign topic and article assignment rules by data category by deleting the existing rules and creating new rules.Reassign all the topics on a record or feed item, that is, remove all the assigned topics on a record or feed item and add topics. Optionally, provide a list of suggested topics to assign to a record or feed item to improve future topic suggestions.Remove a topic from a record or feed item.Update the description or name of a topic or merge up to five secondary topics with a primary topic.Assign topics to articles and unassign topics from articles in a data category.These test methods are for Topics. All methods are static.Register a ConnectApi.ChatterGroupSummaryPage object to be returned when the matching ConnectApi.getGroupsRecentlyTalkingAboutTopic method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.​TopicPage object to be returned when the matching ConnectApi.getRecentlyTalkingAboutTopicsForGroup method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.​TopicPage object to be returned when the matching ConnectApi.getRecentlyTalkingAboutTopicsForUser method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.TopicPage object to be returned when the matching ConnectApi.getRelatedTopics method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.TopicSuggestionPage object to be returned when the matching ConnectApi.getTopicSuggestions method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.TopicSuggestionPage object to be returned when the matching ConnectApi.getTopicSuggestions method is called in a test context. Use the method with the same parameters or you receive an exception. Register a ConnectApi.TopicSuggestionPage object to be returned when the matching ConnectApi.getTopicSuggestionsForText method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.TopicSuggestionPage object to be returned when the matching ConnectApi.getTopicSuggestionsForText method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.TopicPage object to be returned when the matching ConnectApi.getTrendingTopics method is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.TopicPage object to be returned when the matching ConnectApi.getTrendingTopics method is called in a test context. Use the method with the same parameters or you receive an exception.
• UserProfiles Class: Access user profile data. The user profile data populates the profile page (also called the Chatter profile page). This data includes user information (such as address, manager, and phone number), some user capabilities (permissions), and a set of subtab apps, which are custom tabs on the profile page.These methods are for UserProfiles. All methods are static.Delete a user’s banner photo.Delete a user’s photo.Get a user’s banner photo.Get a user’s photo. Get the user profile of the context user. Set an uploaded file as a user’s banner photo.Set a file that hasn’t been uploaded as a user’s banner photo.Set and crop an uploaded file as a user’s banner photo.Set and crop a file that hasn’t been uploaded as a user’s banner photo.Set an uploaded file as a user’s photo. Set a file that hasn’t been uploaded as a user’s photo.Set and crop an uploaded file as a user’s photo.Set and crop a file that hasn’t been uploaded as a user’s photo.
• Zones Class: Access information about Chatter Answers zones in your organization. Zones organize questions into logical groups, with each zone having its own focus and unique questions.These methods are for Zones. All methods are static.Get a zone.Get a list of zones.Get a page of zones.Search articles or questions in a zone.Search a page of articles or questions in a zone.Search articles or questions in a zone, and specify the language of the results.These test methods are for Zones. All methods are static.Register a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter) is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter, pageParam, pageSize) is called in a test context. Use the method with the same parameters or you receive an exception.Register a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter, language) is called in a test context. Use the method with the same parameters or you receive an exception.
• DataSource Exceptions: The DataSource namespace contains exception classes.
• apple(alert, sound, badgeCount, userData): Helper method that creates a valid Apple payload from the specified arguments.
• apple(alertBody, actionLocKey, locKey, locArgs, launchImage, sound, badgeCount, userData): Helper method that creates a valid Apple payload from the specified arguments.
• PushNotificationPayload Methods
• PushNotification Constructors
• PushNotification(): Creates a new instance of the Messaging.PushNotification class.
• PushNotification(payload): Creates a new instance of the Messaging.PushNotification class using the specified payload parameters as key-value pairs. When you use this constructor, you don’t need to call setPayload to set the payload.
• PushNotification Methods
• send(application, users): Sends a push notification message to the specified users.
• setPayload(payload): Sets the payload of the push notification message.
• setTtl(ttl): Reserved for future use.
• ProcessRequest Class: The ProcessRequest class is the parent class for the ProcessSubmitRequest and ProcessWorkitemRequest classes. Use the ProcessRequest class to write generic Apex that can process objects from either class.Returns the comments that have been added previously to the approval request.Returns the list of user IDs of user specified as approvers.Sets the comments to be added to the approval request.If the next step in your approval process is another Apex approval process, you specify exactly one user ID as the next approver. If not, you cannot specify a user ID and this method must be null. This method sets the ActorId field of the associated ProcessInstanceWorkItem.
• ProcessResult Class: After you submit a record for approval, use the ProcessResult class to process the results of an approval process.The ID of the record being processed.If an error occurred, returns an array of one or more database error objects including the error code and description.The ID of the approval process that has been submitted for approval.The status of the current approval process. Valid values are: Approved, Rejected, Removed or Pending.The IDs of the new items submitted to the approval process. There can be 0 or 1 approval processes. A Boolean value that is set to true if the approval process completed successfully; otherwise, it is set to false.
• ProcessSubmitRequest Class: Use the ProcessSubmitRequest class to submit a record for approval.Returns the ID of the record that has been submitted for approval. For example, it can return an account, contact, or custom object record.Returns the developer name or ID of the process definition. If getProcessDefinitionNameOrId() returns a value other than null, getSkipEntryCriteria() determines whether to evaluate the entry criteria for the process (true) or not (false).Returns the user ID of the submitter requesting the approval record. The user must be one of the allowed submitters in the process definition setup.Sets the ID of the record to be submitted for approval. For example, it can specify an account, contact, or custom object record.Sets the developer name or ID of the process definition to be evaluated. If the process definition name or ID is not null, setSkipEntryCriteria() determines whether to evaluate the entry criteria for the process (true) or not (false). Sets the user ID of the submitter requesting the approval record. The user must be one of the allowed submitters in the process definition setup. If you don’t set a submitter ID, the process uses the current user as the submitter.
• ProcessWorkitemRequest Class: Use the ProcessWorkitemRequest class for processing an approval request after it is submitted.Returns the type of action already associated with the approval request. Valid values are: Approve, Reject, or Removed. Returns the ID of the approval request that is in the process of being approved, rejected, or removed.Sets the type of action to take for processing an approval request. Sets the ID of the approval request that is being approved, rejected, or removed.
• Reports Exceptions: The Reports namespace contains exception classes.
• Site Exceptions: The Site namespace contains an exception class.
• generateThreadingMessageId(caseId): Returns an RFC 2822-compliant message identifier that contains information used to match the email and its replies to a case.
• getCaseIdFromEmailHeaders(headers): Returns the case ID corresponding to the specified email header information, or returns null if none is found.
• getCaseIdFromEmailThreadId(emailThreadId): Returns the case ID corresponding to the specified email thread ID. (Deprecated. Use getCaseIdFromEmailHeaders and EmailMessages.getRecordIdFromEmail instead.)
• Cases Methods
• getFormattedThreadingToken(recordId): Returns an email threading token that’s formatted with the correct prefix and suffix. This token can be embedded in an outbound email body, email subject, or both the body and subject. When users reply to the email, threading tokens can be used to attach responses to a record, such as a Case record in Email-to-Case.
• getRecordIdFromEmail(subject, textBody, htmlBody): Returns the record ID corresponding to the specified email threading token, or returns null if none is found.
• EmailMessages Methods
• PageReference Constructors
• PageReference(record): Generate a new instance of the PageReference class for the specified sObject record.
• PageReference(partialURL): Creates a new instance of the PageReference class using the specified URL.
• forResource(resourceName, path): Create a PageReference for nested content inside a zip static resource, by name and path.
• forResource(resourceName): Create a PageReference for a static resource, by name.
• getAnchor(): Returns the name of the anchor referenced in the page’s URL. That is, the part of the URL after the hashtag (#).
• getContent(): Returns the output of the page, as displayed to a user in a web browser.
• getContentAsPDF(): Returns the page in PDF, regardless of the <apex:page> component’s renderAs attribute.
• getCookies(): Returns a map of cookie names and cookie objects, where the key is a String of the cookie name and the the value contains the cookie object with that name.
• getHeaders(): Returns a map of the request headers, where the key string contains the name of the header, and the value string contains the value of the header.
• getParameters(): Returns a map of the query string parameters for the PageReference; both POST and GET parameters are included. The key string contains the name of the parameter, while the value string contains the value of the parameter.
• getRedirect(): Returns the current value of the PageReference object's redirect attribute.
• getRedirectCode(): Returns the HTTP redirect code used when getRedirect() is set to true for the PageReference object.
• getUrl(): Returns the relative URL associated with the PageReference when it was originally defined, including any query string parameters and anchors.
• PageReference Methods
• setAnchor(anchor): Sets the URL’s anchor reference to the specified string.
• setCookies(cookies): Creates a list of cookie objects. Used in conjunction with the Cookie class.
• setRedirect(redirect): Sets the value of the PageReference object's redirect attribute. If set to true, a redirect is performed through a client side redirect.
• setRedirectCode(redirectCode): Sets the HTTP redirect code to use for the PageReference object when setRedirect(redirect) is set to true.
• Appendices
• RegistrationHandler Interface: Salesforce provides the ability to use an authentication provider, such as Facebook© or Janrain©, for single sign-on into Salesforce.Returns a User object using the specified portal ID and user information from the third party, such as the username and email address. The User object corresponds to the third party’s user information. It can be a new user that hasn’t been inserted in your org’s database, or it can represent an existing user record in the database. If it’s a new User object, Salesforce inserts a user record for you.Updates the specified user’s information. This method is called if the user has logged in before with the authentication provider and then logs in again.This example implements the Auth.RegistrationHandler interface and shows how to use a custom exception to display an error message in the URL of the page. If you don’t use a custom exception, the error code and description appear in the URL and the error description appears on the page.
• Cache Exceptions: The Cache namespace contains exception classes.
• getCanvasUrl(): Retrieves the fully qualified URL of the canvas app.
• getDeveloperName(): Retrieves the internal API name of the canvas app.
• getName(): Retrieves the name of the canvas app.
• getNamespace(): Retrieves the namespace prefix of the canvas app.
• getVersion(): Retrieves the current version of the canvas app.
• ApplicationContext Methods
• setCanvasUrlPath(newPath): Overrides the URL of the canvas app for the current request.
• excludeContextTypes(): Lets the implementation exclude parts of the CanvasRequest context, if the application does not need it.
• CanvasLifecycleHandler Methods
• onRender(renderContext): Invoked when a canvas app is rendered. Provides the ability to set and retrieve canvas application and environment context information during the application render phase.
• addEntityField(fieldName): Adds a field to the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object.
• addEntityFields(fieldNames): Adds a set of fields to the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object.
• getDisplayLocation(): Retrieves the display location where the canvas app is being called from. For example, a value of Visualforce page.
• getEntityFields(): Retrieves the list of object fields that are returned in the signed request Record object when the component appears on a Visualforce page that’s placed on an object.
• getLocationUrl(): Retrieves the location URL of the canvas app.
• getParametersAsJSON(): Retrieves the current custom parameters for the canvas app. Parameters are returned as a JSON string.
• getSublocation(): Retrieves the display sublocation where the canvas app is being called from.
• EnvironmentContext Methods
• setParametersAsJSON(jsonString): Sets the custom parameters for the canvas app.
• getApplicationContext(): Retrieves the application context information.
• getEnvironmentContext(): Retrieves the environment context information.
• RenderContext Methods
• Test Constants: The Test class provides constants that are used as keys when you set mock application and environment context data.
• Test Methods: The Test class provides methods for creating test contexts and invoking your CanvasLifecycleHandler with mock data.
• mockRenderContext(applicationContextTestValues, environmentContextTestValues): Creates and returns a test Canvas.RenderContext based on the provided application and environment context parameters.
• testCanvasLifecycle(lifecycleHandler, mockRenderContext): Calls the Canvas test framework to invoke a CanvasLifecycleHandler with the provided RenderContext.
• LockResult Class: The result of a record lock returned by a System.Approval.lock() method.If an error occurred, returns an array of one or more database error objects, providing the error code and description.Returns the ID of the sObject you are trying to lock.A Boolean value that is set to true if the lock operation is successful for this object, or false otherwise.
• UnlockResult Class: The result of a record unlock, returned by a System.Approval.unlock() method.If an error occurred, returns an array of one or more database error objects, providing the error code and description.Returns the ID of the sObject you are trying to unlock.A Boolean value that is set to true if the unlock operation is successful for this object, or false otherwise.
• AuthConfiguration Class: Contains methods for configuring settings for users to log in to a Salesforce org using their authentication provider credentials instead of their Salesforce credentials. The authentication provider can be any authentication provider that supports the OpenID Connect protocol, such as Google, Facebook, or Twitter. Users log in to either an Experience Cloud site (https://MyDomainName.my.site.com) or your My Domain login URL (https://MyDomainName.my.salesforce.com).Creates an instance of the AuthConfiguration class using the specified URL for an Experience Cloud site or a My Domain subdomain and the start URL for authenticated users.Indicates whether the Experience Cloud site allows internal users to log in using the Experience Cloud site login page. To enable, admins configure the setting Allow internal users to log in directly to the experience on the Login & Registration page in Experience Workspaces. It’s disabled by default.Returns the AuthConfig sObject, which represents the authentication options for an Experience Cloud site or Salesforce My Domain subdomain.Returns the list of authentication providers configured for an Experience Cloud site or Salesforce My Domain subdomain.Returns the list of authentication providers available for an Experience Cloud site or Salesforce My Domain subdomain.Returns the single sign-on URL for an Experience Cloud site subdomain.Returns the single sign-on URL for an Experience Cloud site or Salesforce My Domain subdomain.Returns the color for the background of the login page for a community.Returns true if certificate-based authentication is enabled for the My Domain URL.Returns the certificate-based authentication endpoint for the My Domain URL if the org has certificate-based authentication enabled.Returns the profile ID assigned to new community users.Returns the text at the bottom of the login page for a community.Returns the URL for the standard or custom Forgot Password page that is specified for an Experience Cloud site or portal by the administrator.Returns true if the Headless Forgot Password Flow is enabled.This method will be deprecated in a future release. Use the getHeadlessForgotPasswordEnabled() method in this class instead.Determines if headless passwordless login is enabled.Determines if the Headless Registration Flow is enabled.Returns the location of the icon image at the bottom of the login page for a community.Returns the URL for the right-frame content to display on the right side of the Experience Cloud site login page. The admin supplies the URL.Returns the list of SAML-based authentication providers available for an Experience Cloud site or Salesforce My Domain subdomain.Returns the single sign-on URL for an Experience Cloud site or Salesforce My Domain subdomain.Indicates whether the current community allows new users to create their own account by filling out a registration form.Returns the location of the self-registration page for new users to sign up for an account with a community.Returns the start page of an Experience Cloud site or Salesforce My Domain subdomain. This URL is the first page that users see when they log in.Indicates whether the current community is set to display a login form asking for a username and password. You can configure the community not to request a username and password if it is for unauthenticated users or users logging in with a third-party authentication provider.Returns true if the Experience Cloud site uses Site.com pages; otherwise, returns false.
• AuthProviderCallbackState Class: Provides request HTTP headers, body, and query parameters to the AuthProviderPlugin.handleCallback method for user authentication. This class allows you to group the information passed in rather than passing headers, body, and query parameters individually.Creates an instance of the AuthProviderCallbackState class using the specified HTTP headers, body, and query parameters of the authentication request.The HTTP body of the authentication request.The HTTP headers of the authentication request.The HTTP query parameters of the authentication request.
• AuthProviderPluginClass Class: Contains methods to create a custom OAuth-based authentication provider plug-in for single sign-on in to Salesforce. Use this class to create a custom authentication provider plug-in if you can’t use one of the authentication providers that Salesforce provides. Returns the custom metadata type API name for a custom OAuth-based authentication provider for single sign-on to Salesforce. Returns information from the custom authentication provider about the current user. This information is used by the registration handler and in other authentication provider flows. Uses the authentication provider’s supported authentication protocol to return an OAuth access token, OAuth secret or refresh token, and the state passed in when the request for the current user was initiated. Returns the URL where the user is redirected for authentication. Returns a new access token, which is used to update an expired access token.
• AuthProviderTokenResponse Class: Stores the response from the AuthProviderPlugin.handleCallback method.Creates an instance of the AuthProviderTokenResponse class for a custom authentication provider plug-in using the specified arguments.Creates an instance of the AuthProviderTokenResponse class for a custom authentication provider plug-in using the specified arguments. This constructor includes a parameter for the ID token.The OAuth secret or refresh token for the currently logged-in user.The OAuth access token.The authentication provider.The state passed in to initiate the authentication request for the user.The ID token from the third party in encoded JWT format.
• AuthToken Class: Contains methods for getting and revoking access and refresh tokens that are issued when a user logs in via a single sign-on (SSO) flow that uses an authentication provider, such as Facebook.Returns an access token for the current user using the specified 18-character identifier of an AuthProvider definition in your org and the proper name of the provider, such as Salesforce or Facebook. Returns a map from the provider’s identifier to the access token for the currently logged-in Salesforce user. The identifier value depends on the provider. For example, for Salesforce, it’s the user ID, while for Facebook, it’s the user number.Returns a map from the third-party provider’s identifier containing a refreshed access token for the currently logged-in Salesforce user.Revokes the access token for a specified SSO user from a provider such as Facebook. You can use this method only if the IsNotSsoUsable field on the associated ThirdPartyAccountLink object is set to false.
• CommunitiesUtil Class: Contains methods for getting information about an Experience Cloud user.Returns the page to display after the current Experience Cloud user logs out.Returns the current user’s Experience Cloud display name.Indicates whether the current user isn’t logged in to the Experience Cloud site. Redirect the user to log in, if necessary.Indicates whether the current user is logged in as a member of the parent Salesforce organization, such as an employee.
• ConnectedAppPlugin Class: Contains methods for extending the behavior of a connected app, for example, customizing how a connected app is invoked depending on the protocol used. This class gives you more control over the interaction between Salesforce and your connected app.Deprecated and available only in API versions 35.0 and 36.0. As of version 37.0, use authorize(userId, connectedAppId, isAdminApproved, context) instead.Authorizes the specified user to access the connected app. If the connected app is set for users to self-authorize, this method isn’t invoked.Deprecated and available only in API versions 35.0 and 36.0. As of version 37.0, use customAttributes(userId, connectedAppId, formulaDefinedAttributes, context) instead.Sets new attributes for the specified user. When the connected app gets the user’s attributes from the UserInfo endpoint or through a SAML assertion, use this method to update the attribute values.Modifies the XML generated by the Salesforce SAML Identity Provider (IDP) before it’s sent to the service provider.Deprecated and available only in API versions 35.0 and 36.0. As of version 37.0, use refresh(userId, connectedAppId, context) instead.Salesforce calls this method during a refresh token exchange.
• ExternalClientAppOauthHandler Class: Contains methods for extending the behavior of an external client app. For example, customize how an external client app is invoked depending on the protocol used. This class gives you more control over the interaction between Salesforce and your external client app.Authorizes the specified user to access the external client app. If the external client app is set for users to self-authorize, this method isn’t invoked.Sets new attributes for the specified user. When the external client app gets the user’s attributes from the UserInfo endpoint, use this method to update the attribute values.Salesforce calls this method during a refresh token exchange.
• GeneratedUserData Class: Stores the output of the Generate User Data invocable action, which you can access in Flow Builder.The Generate User Data action in Flow Builder uses this constructor to create an instance of the Auth.GeneratedUserData class.Stores a generated placeholder value for the user's alias. The placeholder value is alias. Stores a generated placeholder value for the user's email address. The placeholder value is placeholder-email@example.com.Stores the default value for the email encoding type for the user, such as UTF-8. The email encoding type determines how Salesforce encodes characters in outgoing emails. The default value is the email encoding key for the execution user specified in the Run As field in the authentication provider definition.Stores a generated placeholder value for the user's first name. The placeholder value is placeholder-first-name.Stores the default value for the user's language, such as en_US for English. The default value is the language for the registration handler execution user. The execution user is specified in the Run As field in the authentication provider definition.Stores a generated placeholder value for the user's last name, also known as family name. The placeholder value is placeholder-last-name.Stores the default value for the user's locale, defined using two-letter International Organization for Standardization (ISO) codes. For example, en_US indicates English (United States). The default value is the language for the registration handler execution user. The execution user is specified in the Run As field in the authentication provider definition.Stores the default value for the user's time zone, such as (GMT-07:00) Pacific Daylight Time (America/Los_Angeles). The time zone is defined using region and key city according to ISO standards. The default value is the time zone for the registration handler execution user. The execution user is specified in the Run As field in the authentication provider definition.Stores a generated placeholder value for the user's username. The placeholder value is placeholder-username<unique 14-character number>@example com, such as placeholder-username17370000000000@example com.
• HeadlessUserDiscoveryResponse Class: Contains methods to describe the result of headless user discovery using a handler that implements the Auth.HeadlessUserDiscoveryHandler interface during headless login, passwordless login, and forgot password flows.Creates an instance of the Auth.HeadlessUserDiscoveryResponse class to describe the result of headless user discovery based on data passed into the login_hint during headless login, passwordless login, and forgot password flows.A custom error message that's returned if headless user discovery fails. For example, write custom logic in your headless user discovery handler to see if the user's email address is verified. Then return a custom error message for when it isn't verified.The user ID for the external user that's associated with the data passed into the login_hint parameter. If there are multiple users associated with the data, it can return multiple IDs, but headless user discovery fails.
• HttpCalloutMockUtil Class: Contains a method to send fake HTTP callouts for classes in the Auth namespace.Mocks an HTTP callout using an implementation of the System.HttpCalloutMock interface.
• JWS Class: Contains methods that apply a digital signature to a JSON Web Token (JWT), using a JSON Web Signature (JWS) data structure. This class creates the signed JWT bearer token, which can be used to request an OAuth access token in the OAuth 2.0 JWT bearer token flow.Creates an instance of the JWS class using the specified Auth.JWT payload and the certificate used for signing the JWT bearer token.Creates an instance of the JWS class using the specified payload and certificate used for signing the JWT bearer token.Makes a duplicate copy of the JWS object.Returns the compact serialization representation of the JWS as a concatenated string, with the encoded JWS header, encoded JWS payload, and encoded JWS signature strings separated by period ('.') characters.
• JWT Class: Generates the JSON Claims Set in a JSON Web Token (JWT). The resulting Base64-encoded payload can be passed as an argument to create an instance of the Auth.JWS class.Makes a duplicate copy of the JWT object.Returns a map of additional claims in the JWT, where the key string contains the name of the claim, and the value contains the value of the claim.Returns the audience (aud) claim that identifies the intended recipients of the JWT.Returns the issuer (iss) claim that identifies the issuer of the JWT.Returns the not before (nbf) claim that identifies the time before which the JWT must not be accepted for processing, while allowing some leeway for clock skew. This method returns a NoAccess exception for JWTs generated using methods in the Auth.JWTUtil class. To return the nbf claim for these JWTs, use the getAdditionalClaims method instead.Returns the subject (sub) claim that identifies the current user of the JWT.Returns the length of time (in seconds) that the JWT is valid, which affects the expiration (exp) claim. This method returns a NoAccess exception for JWTs generated using methods in the Auth.JWTUtil class. To return the validity length for these JWTs, use the getAdditionalClaims method instead.Sets the additional claims in the JWT. Returned by the getAdditionalClaims method.Sets the audience (aud) claim in the JWT. Returned by the getAud method.Sets the issuer (iss) claim in the JWT. Returned by the getIss method.Sets the not before (nbf) claim in the JWT. Returned by the getNbfClockSkew method. This method returns a NoAccess exception for JWTs generated using methods in the Auth.JWTUtil class. For these JWTs, the incoming JWT determines the nbf claim.Sets the subject (sub) claim in the JWT. Returned by the getSub method.Sets the length of time (in seconds) that the JWT is valid, which affects the expiration (exp) claim. Returned by the getValidityLength method. This method returns a NoAccess exception for JWTs generated using methods in the Auth.JWTUtil class. For these JWTs, the incoming JWT determines the validity length.Generates the JSON object representation of the Claims Set as an encoded JWT payload.
• JWTBearerTokenExchange Class: Contains methods that POST the signed JWT bearer token to a token endpoint to request an access token, in the OAuth 2.0 JWT bearer token flow.Creates an instance of the JWTBearerTokenExchange class using the specified token endpoint and the signed JWT bearer token.Creates an instance of the Auth.JWTBearerTokenExchange class.Makes a duplicate copy of the JWTBearerTokenExchange object.Returns the access_token in the token response to the JWT bearer token request.Returns the grant type specified in the JWT bearer token request. The grant type value defaults to urn:ietf:params:oauth:grant-type:jwt-bearer.Returns the full System.HttpResponse token response to the JWT bearer token request.Returns the JWS specified in the JWT bearer token request.Returns the token endpoint that the JWT bearer token request is POSTed to.Sets the grant type in the JWT bearer token request. Returned by the getGrantType() method.Sets the JWS in the JWT bearer token request. Returned by the getJWS() method.Sets the token endpoint that the JWT bearer token request is POSTed to. Returned by the getTokenEndpoint() method.
• JWTUtil Class: Contains methods for validating a JSON Web Token (JWT) from an external identity provider as part of the OAuth 2.0 token exchange flow. Use these methods as part of the validateIncomingToken method in the Auth.Oauth2TokenExchangeHandler class. Generates a DPoP proof JWT from a public-private key pair. Use this method to help you implement the OAuth 2.0 Demonstrating Proof-of-Possession (DPoP) extension. To use this Apex method, the client certificate must be saved in the Certificate and Key Management page in Setup. Parses a JWT from an encoded string into a header, payload, and signature. Use this method to decode the JWT without validating it.Parses and validates the JWT using a certificate saved in Salesforce. The certificate can be self-signed or signed by a certificate authority.Parses and validates the JWT using a public key from the external identity provider.Parses and validates the JWT using a remote JSON Web Key Set (JWKS) endpoint on your external identity provider.
• JsonValueOutput Class: Stores the output of the Get User Data from JSON String invocable action, which you can access in Flow Builder..The Get User Data from JSON String action in Flow Builder uses this constructor to create an instance of the Auth.JsonValueOutput class.If the attribute returned by the action is a boolean value, it's stored in this property.If the attribute returned by the action is a Double value, it's stored in this property.If the attribute returned by the action is an integer, it's stored in this property.If the attribute returned by the action is a JSON array, it's formatted as a string and stored in this property.If the attribute returned by the action is a JSON string, it's stored in this property.If the attribute returned by the action is a string, it's stored in this property.
• OAuthRefreshResult Class: Stores the result of an AuthProviderPluginClass refresh method. OAuth authentication flow provides a refresh token that can be used to get a new access token. Access tokens have a limited lifetime as specified by the session timeout value. When an access token expires, use a refresh token to get a new access token.Creates an instance of the OAuthRefreshResult class using the specified access token, refresh token, and error for a custom authentication provider plug-in.Creates an instance of the OAuthRefreshResult class using the specified access token and refresh token for a custom authentication provider plug-in. Use this method when you know that the refresh was successful. The OAuth access token for the user who is currently logged in. Error that occurs when a user unsuccessfully attempts to authenticate with the custom authentication provider.The OAuth refresh token for the user who is currently logged in.
• Oauth2TokenExchangeHandler Class: Use this class to create a token exchange handler that validates tokens from an external identity provider and maps the token’s subject to a Salesforce user during the OAuth 2.0 token exchange flow. The handler can also be used to create users by setting up a new User object and returning it to Salesforce for automatic insertion.Finds the subject defined in the external identity provider’s token so that it can be mapped to a Salesforce subject.Validates an access token, refresh token, ID token, SAML 2.0 assertion, or JWT passed from an external identity provider during the OAuth 2.0 token exchange flow.
• OauthToken Class: Contains a method to revoke OAuth access tokens and refresh tokens. This method supports opaque tokens and JSON Web Token (JWT)-based access tokens, including guest and named user JWT-based access tokens.Revokes Salesforce-issued OAuth tokens.
• SessionManagement Class: Contains methods for verifying users’ identity, creating custom login flows, customizing security levels, and defining trusted IP ranges for a current session.Finishes the My Domain Login Discovery login process.Finish the Visualforce Page login flow process, and redirect the user to the default home page.Finish the Visualforce Page login flow process, and redirect the user to the specified start URL.Initiates a user identity verification flow with the verification method that the user registered with, and returns a URL to the identity verification screen. For example, if you have a custom Visualforce page that displays sensitive account details, you can prompt the user to verify identity before viewing it.Returns a map of attributes for the current session.Returns the eligibility status for a user who’s logging in with Lightning Login when you set up your org with My Domain and use the Login Discovery page type. Use this method to redirect the user to a custom login flow. For example, use after a login attempt to redirect the user to password flow if the user is ineligible for Lightning Login.Returns a map containing a URL to a quick response (QR) code and a time-based one-time password (TOTP) shared secret to configure authenticator apps or devices for multi-factor authentication (MFA).Indicates the required login security session level for the given profile.This method is reserved for internal Salesforce use.Indicates whether the given IP address is within the organization's trusted IP range according to the organization's Network Access settings.Indicates whether the given IP address is within the trusted IP range for the given profile.Sets the user's current session security level.Deprecated. Use validateTotpTokenForKey(totpSharedKey, totpCode, description) instead.Indicates whether a time-based one-time password (TOTP) code (token) is valid for the given shared key.Deprecated. Use validateTotpTokenForUser(totpCode, description) instead.Indicates whether a time-based one-time password (TOTP) code (token) is valid for the current user.Verifies the user code entered during the device authentication flow and redirects users to the OAuth approval page. If users aren’t logged in, they must log in. After successful login, users are prompted to allow the device to access Salesforce data.
• TokenValidationResult Class: Contains methods that describe the result of the token validation performed by a token exchange handler using the validateIncomingToken method in the Auth.Oauth2TokenExchangeHandler class during the OAuth 2.0 token exchange flow.Creates an instance of the Auth.TokenValidationResult class to describe the result of token validation performed during the OAuth 2.0 token exchange flow.Creates an instance of the Auth.TokenValidationResult class to describe a valid token validation result during the OAuth 2.0 token exchange flow.A custom error message that’s returned if token validation fails.Contains information about the user that isn’t stored in the Auth.UserData class, such as information obtained via callouts to the external identity provider.Indicates whether the token is valid or not, based on the custom validation logic in your token exchange handler.The token from the external identity provider.The type of token from the external identity provider. It can be an access token, refresh token, ID token, SAML 2.0 assertion, or a JSON Web Token (JWT).Information about the user that’s obtained from the identity provider’s token.Retrieves the CustomErrorMsg that’s returned when token validation fails.Retrieves data from the identity provider token. This data can include custom data that isn’t stored in the userData property.Retrieves the token that was passed from the external identity provider.Retrieves the type of token that was passed from the external identity provider.Retrieves information about the user. The user information can be obtained from the identity provider’s token or from callouts to the identity provider, if applicable.Indicates whether the token is valid or not, based on the custom validation logic in your token exchange handler.
• UserData Class: Stores user information for authentication provider registration handlers, including handlers that implement the Auth.RegistrationHandler interface and handlers built using Flow Builder.Creates a new instance of the Auth.UserData class using the specified arguments.Creates an instance of the Auth.UserData class that includes the ID token and user info response from the identity provider, if returned during single sign-on.An identifier from the third party for the authenticated user, such as the Facebook user number or the Salesforce user ID.The first name of the authenticated user, according to the third party.The last name of the authenticated user, according to the third party.The full name of the authenticated user, according to the third party.The email address of the authenticated user, according to the third party.A stable link for the authenticated user such as https://www.facebook.com/MyUsername.The username of the authenticated user in the third party.The standard locale string for the authenticated user.The service used to log in, such as Facebook or Janrain.The site login page URL passed in if used with a site; null otherwise.A map of data from the third party, in case the handler has to access non-standard values. For example, when using Janrain as a provider, the fields Janrain returns in its accessCredentials dictionary are placed into the attributeMap. These fields vary by provider.If provided, the ID token from the third party, formatted as an encoded JWT. The ID token contains claims with information about the authenticated user.If provided, the user info response from the third party. The user info response is a JSON object containing user attributes. When used in this property, the JSON object is serialized into a string.If provided, the ID token from the third party. The ID token is formatted as a JSON Web Token (JWT) containing claims with information about the user. When used in this property, the ID token is serialized into a string.
• VerificationResult Class: Contains the result of a verification challenge that you invoke when you create your own Verify page. The challenge can be initiated by either the System.UserManagement.verifyPasswordlessLogin or System.UserManagement.verifySelfRegistration method.Creates an instance of the VerificationResult class that contains the verification result from System.UserManagement.verifySelfRegistration.Message that displays as a result of a verification challenge. Token is valid if the identity verification is successful. Other values are FAILURE, PENDING, RATE_LIMITED, or FAILURE_REPORT.Where the user is directed after entering the verification code successfully, for example, the Experience Cloud site’s home page or location specified by the start URL.The verification challenge is successful.Duplicates the Auth.VerificationResult object.
• BuyerGroupEvaluationService Class: The BuyerGroupEvaluationService class allows you define and execute custom business logic for dynamically assigning users to buyer groups. Unlike out-of-the-box configurations limited to account, market, or data segment-based buyer groups, this service supports extensibility and empowers you to implement tailored buyer group evaluation strategies. It supports both guest and logged-in user scenarios, enabling highly customizable and context-specific buyer group determination.Retrieves a list of evaluated buyer group IDs assigned to a user based on custom or predefined business logic.
• BuyerGroupRequest Class: Contains methods to retrieve account and store details used to identify the buyer groups associated with a user.Returns the account ID of a user.Returns the ID of the web store.Returns a map of user context parameters evaluated at runtime, includingisGuestUser, locale, and guest_uuid_essential_{siteId}.
• BuyerGroupResponse Class: Contains constructors and methods to retrieve the buyer groups associated with a user.Creates a new instance of the CommerceBuyGrp.BuyerGroupResponse class using the specified buyerGroupIds payload parameter.Creates a new instance of the CommerceBuyGrp.BuyerGroupResponse class.Retrieves a list of evaluated buyer group IDs assigned to a user.Sets a list of evaluated buyer group IDs assigned to a user.Sets the error message to be returned when the evaluation of buyer group IDs fails.
• ExtensionInfo Class: Contains static methods to expose extension-related context information.Returns the version number of the Client API for the extension context.Returns a custom parameter field value, if available, for the extension context. Returns the locale for the extension context.Indicates whether custom parameters are available for the extension context.
• Resolution Class: Resolution of a resolution strategy, which conditionally invokes default domain logic, logic provided by an extension provider, or no logic.Constructor that takes a CommerceExtension.ResolutionStates object as an argument.Constructor that takes the name of an extension provider as an argument.Default constructor for the Resolution class.Returns the name of an extension provider.Returns the resolution state of the resolution.
• ResolutionException Class: Exception indicating a problem with the execution of a resolution strategy. Constructor that takes two arguments: an error message and an exception.Constructor that takes an exception as an argument,Constructor that takes an error message as an argument.Default constructor for the ResolutionException class.Returns the type of the exception.
• AsyncDeleteCallback Class: A callback class that the Database.deleteAsync method references. Salesforce calls this class after the remote deleteAsync operation is completed. This class provides the compensating transaction in the completion context of the delete operation. Extend this class to define the actions to execute after the remote delete operation finishes execution.Override this method to define actions that Salesforce executes after a remote Database.deleteAsync operation is completed. For example, based on the results of the remote operation, you can update custom object data or other data that's stored in the Salesforce org..
• AsyncSaveCallback Class: A callback class that the Database.insertAsync or Database.updateAsync method references. Salesforce calls this class after the remote operation is completed. This class provides the compensating transaction in the completion context of the insert or update operation. Extend this class to define the actions to execute after the remote insert or update operation finishes execution.Override this method to define actions that Salesforce executes after the remote Database.insertAsync or Database.updateAsync operation is completed. For example, based on the results of the remote operation, you can update custom object data or other data that's stored in the Salesforce org.
• Column Class: Describes a column on a DataSource.Table. This class extends the DataSourceUtil class and inherits its methods.If the data type is numeric, the number of decimal places to the right of the decimal point.Description of what the column represents.Whether a result set can be filtered based on the values of the column.Returns true if the picklist is sorted alphabetically, false otherwise.Returns true if the picklist is restricted, false otherwise. User-friendly name for the column that appears in the Salesforce user interface.If the column is a string data type, the number of characters in the column. If the column is a numeric data type, the total number of digits on both sides of the decimal point, but excluding the decimal point.Name of the column in the external system.If the data type is a picklist, the picklist values.API name of the custom field on the parent object whose values are compared against this column’s values. Matching values identify related records in an indirect lookup relationship. Applies only when the column’s data type is INDIRECT_LOOKUP_TYPE. For other data types, this value is ignored.API name of the parent object in the relationship that’s represented by this column. Applies only when the column’s data type is LOOKUP_TYPE, EXTERNAL_LOOKUP_TYPE, or INDIRECT_LOOKUP_TYPE. For other data types, this value is ignored.Whether a result set can be sorted based on the values of the column via an ORDER BY clause.Data type of the column.Returns a new column of data type BOOLEAN_TYPE.Returns a new column of data type CURRENCY_TYPE.Returns a new column of data type DATE_TYPE.Returns a new column of data type DATETIME_TYPE.Returns a new column of data type EMAIL_TYPE.Returns a new column of data type EXTERNAL_LOOKUP_TYPE.Returns a new column with the 13 specified Column property values.Returns a new column with the ten specified Column property values.Returns a new column with the eight specified Column property values.Returns a new column with the seven specified Column property values.Returns a new column of data type INDIRECT_LOOKUP_TYPE.Returns a new numeric column with no decimal places using the specified name and length.Returns a new column of data type LOOKUP_TYPE.Returns a new column of data type PICKLIST_MULTISELECT_TYPE with the specified name and picklist values. You can also specify whether the picklist is sorted alphabetically or if the picklist is restricted.Returns a new column of data type PICKLIST_MULTISELECT_TYPE with the specified name and picklist values.Returns a new column of data type NUMBER_TYPE.Returns a new column of data type PERCENT_TYPE.Returns a new column of data type PHONE_TYPE.Returns a new column of data type PICKLIST_TYPE with the specified name and picklist values. You can also specify whether the picklist is sorted alphabetically or if the picklist is restricted.Returns a new column of data type PICKLIST_TYPE with the specified name and picklist values.Returns a new column of data type STRING_SHORT_TYPE or STRING_LONG_TYPE, with the specified name, label, and length.Returns a new column of data type STRING_SHORT_TYPE or STRING_LONG_TYPE, with the specified name and length.Returns a new column of data type STRING_SHORT_TYPE with the specified name and the length of 255 characters.Returns a new column of data type STRING_LONG_TYPE with the specified name and the length of 32,000 characters.Returns a new column of data type Time with the specified name.Returns a new column of data type URL_TYPE with the specified name and length.Returns a new column of data type URL_TYPE with the specified name and the length of 1,000 characters.
• ColumnSelection Class: Identifies the list of columns to return during a query or search.How to aggregate the column’s data.Name of the selected column.Name of the column’s table.
• Connection Class: Extend this class to enable your Salesforce org to sync the external system’s schema and to handle queries, searches, and write operations (upsert and delete) of the external data. This class extends the DataSourceUtil class and inherits its methods.Invoked when external object records are deleted via the Salesforce user interface, APIs, or Apex.Invoked by a SOQL query of an external object. A SOQL query is generated and executed when a user visits an external object’s list view or record detail page in Salesforce. Returns the results of the query.Invoked by a SOSL query of an external object or when a user performs a Salesforce global search that also searches external objects. Returns the results of the query.Invoked when an administrator clicks Validate and Sync on the external data source detail page. Returns a list of tables that describe the external system’s schema.Invoked when external object records are created or updated via the Salesforce user interface, APIs, or Apex.
• ConnectionParams Class: Contains the credentials for authenticating to the external system.The name of the certificate for establishing each connection to the external system.The URL of the external system.The OAuth token that’s issued by the external system.The password for authenticating to the external system.An instance of DataSource.IdentityType, which determines which set of credentials to use to access the external system.The type of protocol that’s used to authenticate to the external system.Reserved for future use.The username for authenticating to the external system.
• DataSourceUtil Class: Parent class for the DataSource.Provider, DataSource.Connection, DataSource.Table, and DataSource.Column classes.Logs the error message in the debug log.Throws a DataSourceException and displays the provided message to the user.
• DeleteContext Class: An instance of DeleteContext is passed to the deleteRows() method on your Database.Connection class. The class provides context information about the delete request to the implementor of deleteRows().The external IDs of the rows representing external object records to delete.The name of the table to delete rows from.
• DeleteResult Class: Represents the result of a delete operation on an sObject record. The result is returned by the DataSource.deleteRows method of the DataSource.Connection class.The error message that’s generated by a failed delete operation. Recorded with a result of type DataSource.DeleteResult.The unique identifier of a row that represents an external object record to delete.Indicates whether a delete operation succeeded or failed.Maintains the integrity of lists of type DeleteResult by determining the equality of external objects in a list. This method is dynamic and is based on the equals method in Java.Creates a delete result indicating the failure of a delete request for a given external ID.Maintains the integrity of lists of type DeleteResult by determining the uniqueness of the external object records in a list.Creates a delete result indicating the successful completion of a delete request for a given external ID.
• Filter Class: Represents a WHERE clause in a SOSL or SOQL query. Name of the column that’s being evaluated in a simple comparative type of filter.Value that the filter compares records against in a simple comparative type of filter.List of subfilters for compound filter types, such as NOT_, AND_, and OR_.Name of the table whose column is being evaluated in a simple comparative type of filter.Type of filter operation that limits the returned data.
• Order Class: Contains details about how to sort the rows in the result set. Equivalent to an ORDER BY statement in a SOQL query.Name of the column whose values are used to sort the rows in the result set.Direction for sorting rows based on column values.Name of the table whose column values are used to sort the rows in the result set.Creates an instance of the DataSource.Order class.
• Provider Class: Extend this base class to create a custom adapter for Salesforce Connect. The class informs Salesforce of the functional and authentication capabilities that are supported by or required to connect to the external system. This class extends the DataSourceUtil class and inherits its methods.Returns the types of authentication that can be used to access the external system.Returns the functional operations and endpoint settings that the external system supports.Returns a connection that points to an instance of the external data source.
• QueryContext Class: An instance of QueryContext is provided to the query method on your DataSource.Connection class. The instance corresponds to a SOQL request.Query token that’s used for server-driven paging to determine and fetch the subsequent batch of results.Query details that represent the FROM, ORDER BY, SELECT, and WHERE clauses in a SOQL or SOSL query.Creates an instance of the QueryContext class.
• QueryUtils Class: Contains helper methods to locally filter, sort, and apply limit and offset clauses to data rows. This helper class is provided for your convenience during early development and tests, but it isn’t supported for use in production environments.Returns a subset of data rows after locally applying limit and offset clauses from the query. This helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments.Returns a subset of data rows after locally ordering and applying filters from the query. This helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments.Returns data rows after locally filtering, sorting, ordering, and applying limit and offset clauses from the query. This helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments.Returns data rows after locally sorting and applying the order from the query. This helper method is provided for your convenience during early development and tests, but it isn’t supported for use in production environments.
• ReadContext Class: Abstract base class for the QueryContext and SearchContext classes.Maximum number of rows that the query can return.Describes the external system’s tables to query. The starting row offset into the query’s result set. Used for client-driven paging.
• SearchContext Class: An instance of SearchContext is provided to the search method on your DataSource.Connection class. The instance corresponds to a search or SOSL request.Creates an instance of the SearchContext class with the specified parameter values.Creates an instance of the SearchContext class.The user-entered search string as a case-sensitive single phrase, with all non-alphanumeric characters removed.List of queries and their details. The details represent the FROM, ORDER BY, SELECT, and WHERE clauses in each SOQL or SOSL query.
• SearchUtils Class: Helper class for implementing search on a custom adapter for Salesforce Connect.Queries all the tables and returns each row whose designated name field contains the search phrase.
• Table Class: Describes a table on an external system that the Salesforce Connect custom adapter connects to. This class extends the DataSourceUtil class and inherits its methods.List of table columns.Description of what the table represents.Plural form of the user-friendly name for the table. The labelPlural becomes the object’s plural label in the Salesforce user interface.Singular form of the user-friendly name for the table. The labelSingular becomes the object label in the Salesforce user interface. We recommend that you make object labels unique across all standard, custom, and external objects in the org.Name of the table on the external system.Name of the table column that becomes the name field of the external object when the administrator syncs the table.Returns the table metadata with the specified parameter values.Returns the table metadata with the specified parameter values, using the name for the labels and description.
• TableResult Class: Contains the results of a search or query.errorMessage Query token that’s used for server-driven paging to determine and fetch the subsequent batch of results. This token is passed back to the Apex data source on subsequent queries in the queryMoreToken property on the QueryContext.​ Rows of data.Whether the search or query was successful.Name of the table that was queried.The total number of rows that meet the query criteria, even when the external system is requested to return a smaller batch size.Returns failed search or query results with the provided error message.Returns a subset of data rows in a TableResult with the provided property values and the number of rows in the table.Returns a subset of data rows in a TableResult with the provided property values.Returns the subset of data rows that meet the query criteria, and the number of rows in the table, in a TableResult.Returns the subset of data rows that meet the query criteria, and the number of rows in the table, in a TableResult.
• TableSelection Class: Contains a breakdown of the SOQL or SOSL query. Its properties represent the FROM, ORDER BY, SELECT, and WHERE clauses in the query.List of columns to query. Corresponds to the SELECT clause in a SOQL or SOSL query.Identifies the query filter, which can be a compound filter that has a list of subfilters. The filter corresponds to the WHERE clause in a SOQL or SOSL query.Identifies the order for sorting the query results. Corresponds to the ORDER BY clause in a SOQL or SOSL query.Name of the table to query. Corresponds to the FROM clause in a SOQL or SOSL query.
• UpsertContext Class: An instance of UpsertContext is passed to the upsertRows() method on your Datasource.Connection class. This class provides context information about the upsert request to the implementor of upsertRows().List of rows corresponding to the external object records to upsert.The name of the table to upsert rows in.
• UpsertResult Class: Represents the result of an upsert operation on an external object record. The result is returned by the upsertRows method of the DataSource.Connection class.The error message that’s generated by a failed upsert operation.The unique identifier of a row that represents an external object record to upsert.Indicates whether a delete operation succeeded or failed.Maintains the integrity of lists of type UpsertResult by determining the equality of external object records in a list. This method is dynamic and is based on the equals method in Java.Creates an upsert result that indicates the failure of a delete request for a given external ID.Maintains the integrity of lists of type UpsertResult by determining the uniqueness of the external object records in a list.Creates a delete result that indicates the successful completion of an upsert request for a given external ID.
• DmlOptions.AssignmentRuleHeader Class: Enables setting assignment rule options.Specifies the ID of a specific assignment rule to run for the case or lead. The assignment rule can be active or inactive.If specified as true for a case or lead, the system uses the default (active) assignment rule for the case or lead. If specified, do not specify an assignmentRuleId.
• Cursor Class: Contains methods to fetch records and to get the number of cursor rows returned from a SOQL query. Fetches cursor rows that correspond to the offset position and the specified record count. The maximum number of rows per cursor is 50 million, regardless of whether the operation is synchronous or asynchronous. Calling the Cursor.fetch() method counts against the SOQL query limit, and the rows fetched count against the SOQL query row limit. You can make a maximum of 100 Cursor.fetch() calls per transaction.Gets the number of rows returned in an Apex cursor from a Cursor.fetch(position, count) operation.
• CursorFetchResult Class: This class encapsulates the result of a PaginationCursor.fetchPage() call. It contains methods that get the rows for the current page, the start index of the next page, and the number of deleted rows skipped during the fetch operation. It also contains a method that indicates whether the pagination cursor has fetched all available rows in the result set.Gets the start index required to fetch the next page of results. Use this value as the start parameter in the call to PaginationCursor.fetchPage(start, pageSize) to fetch the next page of results. Gets the number of deleted rows that were skipped during the fetch operation.Gets the list of records that comprise the rows on the current page.Returns true if the pagination cursor has reached either the page size passed to PaginationCursor.fetchPage(start, pageSize) or the end of the result set. Otherwise returns false.
• DMLOptions.DuplicateRuleHeader Class: Determines options for using duplicate rules to detect duplicate records. Duplicate rules are part of the Duplicate Management feature.For a duplicate rule, when the Alert option is enabled, bypass alerts and save duplicate records by setting this property to true. Prevent duplicate records from being saved by setting this property to false.Determine whether sharing rules for the current user are enforced when duplicate rules run (true) or not (false). If no sharing rules are specified, Apex code runs in user mode and sharing rules for the current user are enforced.
• DuplicateError Class: Contains information about an error that occurred when an attempt was made to save a duplicate record. Use if your organization has set up duplicate rules, which are part of the Duplicate Management feature.Returns the details of a duplicate rule and duplicate records found by the duplicate rule. Returns an array of one or more field names. Identifies which fields in the object, if any, affected the error condition.Returns the error message text.Returns a code that characterizes the error.
• DmlOptions.EmailHeader Class: Enables setting email options.Indicates whether to trigger auto-response rules (true) or not (false), for leads and cases.Indicates whether to trigger email outside the organization (true) or not (false).Indicates whether to trigger email that is sent to users in the organization (true) or not (false).
• PaginationCursor Class: This class represents a pagination cursor that can traverse a SOQL query result set. It contains methods that fetch rows by page. It also contains a method that returns the total number of rows in the result set. Fetches the number of deleted rows within the specified range. The method counts only rows deleted after the creation of the pagination cursor. Calling the PaginationCursor.fetchDeleted() method counts against the SOQL query limit, and the rows fetched count against the SOQL query row limit. Fetches a page of rows from the result set. By default, the method skips rows deleted after the creation of the pagination cursor. The method also returns information used to fetch the next page. Calling the PaginationCursor.fetchPage() method counts against the SOQL query limit, and the rows fetched count against the SOQL query row limit.Gets the total number of rows in the SOQL query result set.
• QueryOptions Class: Contains an immutable configuration for the SOQL SET OPTIONS clause.Returns a new Database.QueryOptionsBuilder with no options set.Returns the dataspace name set on the builder, or null if unset.Returns whether explicit namespace resolution is enabled, or null if unset.Returns whether empty-string filter values are honored, or null if unset.
• QueryOptionsBuilder Class: Contains methods to build an immutable Database.QueryOptions instance.Returns an immutable Database.QueryOptions object that reflects the current builder state.Sets the dataspace context for the query.Sets whether explicit namespace resolution is enabled for the query.Sets whether empty-string filter values are treated as meaningful rather than as null.
• AdditionalInformationMap Class: Represents other information, if any, about matched records.Returns the element name.Returns the value of the element.
• DuplicateResult Class: Represents the details of a duplicate rule that detected duplicate records and information about those duplicate records. Returns the developer name of the executed duplicate rule that returned duplicate records.Returns the error message configured by the administrator to warn users they may be creating duplicate records. This message is associated with a duplicate rule.Returns the duplicate records and match information.Indicates whether the duplicate rule will allow a record that’s identified as a duplicate to be saved. Set to true if duplicate rule should allow save; otherwise, false.
• FieldDiff Class: Represents the name of a matching rule field and how the values of the field compare for the duplicate and its matching record.Returns how the field values compare for the duplicate and its matching record.Returns the name of a field on a matching rule that detected duplicates.
• FindDuplicates Class: Performs rule-based searches for duplicate records. The input is an array of sObjects. Each sObject represents a record you want to find duplicates of. The output identifies the detected duplicates for each input sObject based on active duplicate rules for the given object.Identifies duplicates for sObjects provided and returns a list of FindDuplicatesResult objects.
• FindDuplicatesByIds Class: Performs rule-based searches for duplicate records. The input is an array of IDs. Each ID specifies records to search for duplicates among. The duplicates are detected based on the active duplicate rules applicable to the object type corresponding to the input IDs.Identifies duplicates of record IDs provided and returns a list of FindDuplicatesResult objects.
• FindDuplicatesResult Class: Output for rule-based searches for duplicate records. FindDuplicatesResult contains results of detecting duplicates using instances of FindDuplicates or FindDuplicatesByIds classes.A list of DuplicateResult objects representing the results of calling FindDuplicates.findDuplicates(sObjects) or FindDuplicatesByIds.findDuplicatesByIds(ids). Elements in the list correspond to sObjects or IDs in the input list.A list of Database.Error objects holding errors resulting from calling FindDuplicates.findDuplicates(sObjects) or FindDuplicatesByIds.findDuplicatesByIds(ids).Boolean signifying whether the call to FindDuplicates.findDuplicates(sObjects) or FindDuplicatesByIds.findDuplicatesByIds(ids) was successful.Returns a list of DuplicateResult objects representing the results of calling FindDuplicates.findDuplicates(sObjects) or FindDuplicatesByIds.findDuplicatesByIds(ids). Elements in the list correspond to sObjects or IDs in the input list.Returns a list of DatabaseError objects containing errors resulting from calling FindDuplicates.findDuplicates(sObjects) or FindDuplicatesByIds.findDuplicatesByIds(ids), if errors were encountered.Returns a Boolean signifying whether the call to FindDuplicates.findDuplicates(sObjects) or FindDuplicatesByIds.findDuplicatesByIds(ids) was successful.
• MatchRecord Class: Represents a duplicate record detected by a matching rule. Returns other information about a matched record. For example, a matchGrade represents the quality of the data for the D&B fields in the matched record. Returns all matching rule fields and how each field value compares for the duplicate and its matching record.Returns the ranking of how similar a matched record’s data is to the data in your request. Must be equal to or greater than the value of the minMatchConfidence specified in your request. Returns -1 if unused.Returns the fields and field values for the duplicate.
• MatchResult Class: Represents the duplicate results for a matching rule.Returns the entity type of the matching rule.Returns errors that occurred during matching for the matching rule.Returns the match engine for the matching rule.Returns information about the duplicates for the matching rule.Returns the developer name of the matching rule.Returns the number of duplicates detected by the matching rule.Returns false if there’s an error with the matching rule, and true if the matching rule successfully ran.
• Action Class: Contains methods to create, update, and retrieve information about invocable actions.Creates an empty invocation in preparation for calling an invocable action. After you create the invocation, you can add parameters to the invocation.Clears the existing invocations from the action.Creates a copy of the Invocable.Action.Creates a wrapper for the specified version of a custom invocable action in a specified package namespace.Creates a wrapper for a custom invocable action in a specified package namespace.Creates a wrapper for a custom invocable action.Creates a wrapper for a standard invocable action.Creates a wrapper for a standard invocable action.Gets metadata related to an invocable action.Gets the name of an invocable action.Gets the namespace of a custom invocable action.Gets the type of an invocable action.Gets the version of an invocable action.Invokes an invocable action from Apex code.Determines whether an invocable action is a standard invocable action.Sets a value for an invocable action parameter.Initializes the invocations for an action from a pre-existing list of invocations.
• Action.AdditionalAttribute Class: Contains methods to get metadata about attributes associated with invocable action parameters.Gets the Apex class name of an additional attribute for an invocable action parameter.Gets the data type of an additional attribute for an invocable action parameter.Indicates whether an additional attribute for an invocable action parameter contains a collection of values.Gets the name of an additional attribute for an invocable action parameter.Gets the value for an additional attribute for an invocable action parameter.Returns a value as a list of Booleans when isCollection is true and dataType is BOOLEAN.Returns a value as a list of dates when isCollection is true and dataType is DATE.Returns a value as a list of doubles when isCollection is true and dataType is DOUBLE.Returns a value as a list of integers when isCollection is true and dataType is INTEGER.Returns a value as a list when isCollection is true. The list elements have the type specified by the dataType property. Returns a value as a list of longs when isCollection is true and dataType is LONG.Returns a value as a list of strings when isCollection is true and dataType is STRING.
• Action.DescribeResult Class: Contains methods to get metadata about invocable actions.Gets the invocable action that was invoked and caused a result to be returned.Indicates whether the invocable action allows transaction control.Gets the capability types supported by an invocable action.Gets the category of an invocable action.Gets the type of an invocable action.Gets the description of an invocable action.Gets a list of the generic types defined for an invocable action.Indicates whether an invocable action makes external callouts.Indicates whether an invocable action is a standard invocable action.Gets the icon ID for an invocable action.Gets the icon name for an invocable action.Gets a list of input parameters for an invocable action.Gets the type of an invocable action.Gets the description of an invocable action method.Gets the label of an invocable action method.Gets the name of an invocable action method.Gets the name of an invocable action.Gets a list of output parameters for an invocable action.Gets the target entity name for an invocable action.Gets the type of an invocable action.
• Action.Error Class: Contains methods to retrieve errors returned by invocable actions.Creates a copy of the Invocable.Action.Error.Gets the error code returned by an invocable action.Gets the error message returned by an invocable action.
• Action.GenericType Class: Contains methods to get metadata about generic type parameters for invocable actions.Gets the description of a generic type parameter of an invocable action.Gets the label of a generic type parameter of an invocable action.Gets the name of a generic type parameter of an invocable action.Gets the super type of a generic type parameter of an invocable action.
• Action.InputParameter Class: Contains methods to get metadata about input parameters for invocable actions.Gets a list of additional attributes for an invocable action input parameter.Gets the Apex class name of an input parameter for an invocable action.Gets the maximum byte length of an input parameter of an invocable action.Indicates whether an input parameter of an invocable action is a configuration parameter.Gets the default value for an input parameter of an invocable action.>Gets the description of an input parameter of an invocable action.Gets the label of an input parameter of an invocable action.Gets the maximum number of occurrences for an input parameter of an invocable action.Gets the name of an input parameter of an invocable action.Gets a list of picklist values for an input parameter of an invocable action.Gets the placeholder text of an input parameter of an invocable action.Indicates whether an input parameter of an invocable action is required.Gets the sObject type of an input parameter of an invocable action.Gets the setup reference types of an input parameter of an invocable action.Gets the tooling type of and input parameter of an invocable action.Gets the data type of an input parameter of an invocable action.
• Action.OutputParameter Class: Contains methods about metadata returned by invocable actions.Gets a list of additional attributes for an invocable action output parameter.Gets the Apex class name of an output parameter for an invocable action.Gets the description of an output parameter of an invocable action.Gets the label of an output parameter of an invocable action.Gets the maximum number of occurrences for an output parameter of an invocable action.Gets the name of an output parameter of an invocable action.Gets a list of picklist values for an output parameter of an invocable action.Gets the sObject type of an output parameter of an invocable action.Gets the data type of an output parameter of an invocable action.
• Action.PicklistValue Class: Contains methods to get metadata about a single value in a picklist used by invocable action parameters.Indicates whether a picklist value used by an invocable action parameter is active.Indicates whether a picklist value used by an invocable action parameter is the default value.Gets the label of a picklist value used by an invocable action parameter.Gets the valid-for dependency information for a picklist value used by an invocable action parameter.Gets the API value of a picklist option used by an invocable action parameter.
• Action.Result Class: Contains methods to retrieve results from invocable actions called from Apex code.Creates a copy of the Invocable.Action.Result.Gets the invocable action that was invoked and caused a result to be returned.Gets a list of errors that were returned by an invocable action.Gets a list of the parameter values set for an invocable action. This method returns a list that contains the input parameter values for each invocation of an action. Each map in the list contains a key for the name of each input parameter.Gets a list of the parameter values returned by an invocable action. This method returns a list that contains the result for each invocation of an action. Each map in the list contains a key for the name of each output parameter.Determines if an invocable action ran without errors.
• AppAnalytics Class: Contains methods to help with AppExchange App Analytics use cases, such as minimizing subscriber attrition and obtaining product insights.Logs the custom interaction using a label that you provide as an enum value and an interaction ID.Logs the custom interaction using a label that you provide as an enum value and an interaction ID that you provide as an Apex UUID.Logs the custom interaction using a label that you provide as an enum value.
• ActionResult Class: Contains information about the execution of an actionable notification. If an error occurred, returns an object that provides the error code and a description.Returns the success or error message that displays for the user.Returns true if the action executed successfully; otherwise returns false.
• ActionResult.Builder Class: Contains methods to build and validate an instance of the Messaging.ActionResult class.Validates and returns the action result instance created by using the ActionResult.Builder methods.Sets the error message associated with the action error.Sets the success or error message associated with the execution of the action.Sets a Boolean that informs the user whether the execution of the action was successful (true) or not (false).
• ActionableNotification Class: Contains information about an actionable custom notification.Return the unique action identifier (API name) for the custom notification action. Return the ID of the custom notification type used for the notification.Return the user ID of the recipient of the notification.Return the user ID of the sender of the notification.Return the record ID for the target record of the notification.Return the PageReference for the navigation target of the notification.
• ActionableNotification.Builder Class: Contains methods to build an instance of the Messaging.ActionableNotification class, which is used to configure actionable notifications for mobile devices.Returns an instance of the Messaging.ActionableNotification class. Sets the unique action identifier (API name) for the custom notification action.Sets the ID of the custom notification type.Sets the user ID of the custom notification recipient.Sets the sender of the custom notification.Sets the record ID for the target record of the notification. The PageReference for the navigation target of the notification.
• CustomNotification Class: CustomNotification is used to create, configure, and send custom notifications from Apex code.Creates a new instance of the Messaging.CustomNotification class.Creates an instance of the Messaging.CustomNotification class using the specified parameters. When you use this constructor, you don’t need to call the various setter methods to define the custom notification attributes.Sends a custom notification to the specified users.Sets the type of the custom notification.Sets the title of the custom notification.Sets the body of the custom notification.Sets the sender of the custom notification.Sets the target record of the custom notification.Sets the target page of the custom notification.
• InboundEmail.AuthenticationResult Class: Contains the authentication type and response for inbound emails.Creates a new instance of the Messaging.InboundEmail.AuthenticationResult class.Additional information in authentication result headers. Examples include: name: smtp.mailfrom and value: example.com.The authentication method used for the security check. Possible values include dkim, dmarc, or spf. The result of the authentication check. When the email service is configured to verify the legitimacy of the sending server before processing a message, possible values include pass or fail. Otherwise, the value returned is none.
• InboundEmail.AuthenticationResultField Class: Contains field data from the authentication result response for inbound emails.Creates a new instance of the Messaging.InboundEmail.AuthenticationResultField class.The authentication result field name. For example: smtp.mailfrom.The authentication result field value. For example: example.com.
• RenderEmailTemplateBodyResult Class: Contains the results for rendering email templates.If an error occurred during the renderEmailTemplate method, a RenderEmailTemplateError object is returned.Returns the rendered body text with merge field references replaced with the corresponding record data.Indicates whether the operation was successful.
• RenderEmailTemplateError Class: Represents an error that the RenderEmailTemplateBodyResult object can contain.Returns the name of the merge field in the error.Returns a message describing the error.Returns the offset within the supplied body text where the error was discovered. If the offset cannot be determined, -1 is returned.Returns a Salesforce API status code.
• AnalyticsCloudComponentLayoutItem Class: Represents the settings for a Wave Analytics dashboard on a standard or custom page.Specifies the type of Wave Analytics asset.Unique development name of the dashboard to add.An error string that is populated only when an error occurred in the underlying dashboard.Dashboard filters for mapping data fields in the dashboard to the object’s fields.Specifies the height of the dashboard, in pixels.Controls whether users see a dashboard that has an error.If true, includes the dashboard’s header bar. If false, the dashboard appears without a header bar.If set to true, and the dashboard is shareable the dashboard shows the Share icon. If set to false, the dashboard doesn’t show the Share icon.If true, includes the dashboard’s title above the dashboard. If false, the dashboard appears without a title.Specifies the width of the dashboard, in pixels or percentage.Makes a duplicate copy of the Metadata.AnalyticsCloudComponentLayoutItem.
• ConsoleComponent Class: Represents a custom console component on a section of a page layout.The height of the custom console component in pixels.The location of the custom console component on the page layout. Valid values are right, left, top, and bottom.The unique name of the custom console component.The width of the custom console component in pixels.Makes a duplicate copy of the Metadata.ConsoleComponent.
• Container Class: Represents a location and style in which to display more than one custom console component in the sidebars of the console.The height of the component’s container. The unit property determines the unit of measurement, in pixels or percent.If set to true, stacked console components in the sidebars autosize vertically.The location of the component’s container (right, left, bottom, top).Represents a specific custom console component to display in the components’ container. The style of the container in which to display multiple components (stack, tab, accordion).The unit of measurement, in pixels or percent, for the height or width of the components’ container.The width of the component’s container. The unit property determines the unit of measurement, in pixels or percent.Makes a duplicate copy of the Metadata.Container.
• CustomConsoleComponents Class: Represents custom console components (Visualforce pages, lookup fields, or related lists) on a page layout.Represents custom console components on primary tabs in the Salesforce console.Represents custom console components on subtabs in the Salesforce console.Makes a duplicate copy of the Metadata.CustomConsoleComponents.
• CustomMetadata Class: Represents records of custom metadata types.The description of the custom metadata.The label of the custom metadata record.Property that describes whether the custom metadata record is a protected component.A list of custom metadata values, such as custom fields, for the custom metadata record.Makes a duplicate copy of the Metadata.CustomMetadata.
• CustomMetadataValue Class: Represents custom metadata values for a custom metadata component.The field name for the custom metadata value.The field value for the custom metadata value.Makes a duplicate copy of the Metadata.CustomMetadataValue.
• DeployCallbackContext Class: Represents context information for a deployment job.Makes a duplicate copy of the Metadata.DeployCallbackContext.Gets the asynchronous Apex job ID for the callback job.
• DeployContainer Class: Represents a container for custom metadata components to be deployed.Add a custom metadata component to the container.Makes a duplicate copy of the Metadata.DeployContainer.Retrieves a list of custom metadata components from the container.Removes a metadata component from the container.Removes a metadata component from the container using the component’s full name.
• DeployDetails Class: Contains detailed information on deployed components.Contains a list of information about components that failed to deploy.Contains a list of information about components that deployed successfully.Makes a duplicate copy of the Metadata.DeployDetails.
• DeployMessage Class: Represents result information for the deployment of a metadata component.Determines whether the component was changed after deployment. If true, the component was changed as a result of the deployment. If false, the deployed component was the same as the corresponding component already in the org.Each component is represented by a text file. If an error occurs during deployment, this property represents the column of the text file where the error occurred.The metadata type of the component in the deployment.If true, the component was created as a result of the deployment. If false, the component was modified as a result of the deployment.The date and time when the component was created as a result of the deployment.If true, the component was deleted as a result of the deployment. If false, the component was either new or modified as result of the deployment.The name of the file in the metadata archive used to deploy the component.Full name for the custom metadata component.ID of the component that was deployed.Each component is represented by a text file. If an error occurs during deployment, this field represents the line number of the text file where the error occurred.If an error or warning occurred, this field contains a description of the problem that caused the deployment to fail.Indicates the problem type, for example, an error or warning.Indicates whether the component was successfully deployed (true) or not (false).Makes a duplicate copy of the Metadata.DeployMessage.
• DeployResult Class: Represents the results of a metadata deployment.ID of the user who canceled the queued deployment.Full name of the user who canceled the queued deployment.Indicates whether the deployment checked only the validity of the deployed files without making changes in the org. A check-only deployment does not deploy components or change the org in any way.Date and time for when the deployment process ended.ID of the user who created the deployment job.Full name of the user who created the deployment job.Date and time the deployment job was first queued.Provides the details for components in a completed deployment.Indicates whether Salesforce finished processing the deployment.Message corresponding to the values in the errorStatusCode property, if any.If an error occurs during deployment, a status code is returned. The message corresponding to the status code is returned in the errorMessagefield property.ID of the deployment job.Specifies whether a deployment continues, even if the deployment generates warnings.Date and time of the last update for the deployment process. A list of all the detail messages for a deployment. The number of components that generated errors during the deployment.The number of components deployed in the deployment process. Use this value with the numberComponentsTotal property to get an estimate of the deployment’s progress.The total number of components in the deployment. Use this value with the numberComponentsDeployed property to get an estimate of the deployment’s progress.Indicates whether any failure causes a complete rollback (true) or not (false) of the deployment.Date and time the deployment process began.Indicates which component is being deployed.Indicates the current state of the deployment.Indicates whether the deployment was successful (true) or not (false).Makes a duplicate copy of the Metadata.DeployResult.
• FeedLayout Class: Represents the values that define the feed view of a feed-based page layout. Feed-based layouts are available on Account, Case, Contact, Lead, Opportunity, custom, and external objects. They include a feed view and a detail view.Specifies whether the publisher is collapsed when the page loads (true) or not (false).Specifies whether the feed-based page layout uses a compact feed (true) or not (false). If set to true, feed items on the page are collapsed by default, and the feed view has an updated design.Indicates where the feed filters list is included in the layout.The individual filters displayed in the feed filters list.Specifies whether the feed expands horizontally to take up all available space on the page (true) or not (false).Specifies whether the sidebar is hidden (true) or not (false).Controls whether to highlight external feed items (true) or not (false).The individual components displayed in the left column of the feed view.Lists the individual components displayed in the right column of the feed view.Indicates whether to use inline filters in the Salesforce console.Makes a duplicate copy of the Metadata.FeedLayout.
• FeedLayoutComponent Class: Represents a component in the feed view of a feed-based page layout.Represents a component in the feed view of a feed-based page layout. The type of component is required.The height, in pixels, of the component. Doesn’t apply to standardComponentsThe name of the Visualforce page used as a custom component.Makes a duplicate copy of the Metadata.FeedLayoutComponent.
• FeedLayoutFilter Class: Represents a feed filter option in the feed view of a feed-based page layout. A filter can have only standardFilter or feedItemType set. The name of a CustomFeedFilter component. Names are prefixed with the name of the parent object. For example, Case.MyCustomFeedFilter.The type of filter.The type of feed item to display.Makes a duplicate copy of the Metadata.FeedLayoutFilter.
• Layout Class: Represents the metadata associated with a page layout.The custom buttons for this layout.Represents custom console components (Visualforce pages, lookup fields, or related lists) on a page layout.Default value for the email checkbox. Only relevant if the showEmailCheckbox property is set.List of standard buttons to exclude from this layout.Represents the values that define the feed view of a feed-based page layout.Represents the layout headers used for tagging.The main sections of the layout containing fields, s-controls, and custom links. The order here determines the layout order.Represents a minilayout, which is used in the mini view of a record in the Console tab, hover details, and event overlays.Fields for special multiline layout fields which appear in OpportunityProduct layouts.The list of actions, and their order, that display in the Salesforce mobile action bar for the layout.The list of quick actions that display in the full Salesforce site for the page layout.The Related Content section of the page layout. The related lists for the layout, listed in the order they appear in the user interface.The list of related objects that appears in the mini view of the console.Default value for the “run assignment rules” checkbox. Only relevant if the showRunAssignmentRulesCheckbox property is set.Controls whether to show the email checkbox. Only allowed on Case, CaseClose, and Task layouts. The default state of checkbox is controlled by the emailDefault property.If set, the highlights panel displays on pages in the Salesforce console.If set, the interaction log displays on pages in the Salesforce console.Only allowed on Case layouts. If set, the Knowledge sidebar displays on cases in the Salesforce console.Controls whether to show the Run Assignment Rules checkbox. Only allowed on Lead and Case layouts. The default state of checkbox is controlled by the runAssignmentRulesDefault property.Only allowed on CaseClose layout. If set, the built-in solution information section shows up on the page.For Cast layouts only. If set, the Submit & Add Attachment button displays on case edit pages to portal users in the Customer Portal.The summary layout for this layout.Makes a duplicate copy of the Metadata.Layout.
• LayoutColumn Class: Represents the items in a column within a layout section.The individual items within a column (ordered from top to bottom).This field is reserved for Salesforce.Makes a duplicate copy of the Metadata.LayoutColumn.
• LayoutItem Class: Represents the valid values that define a layout item.A Wave Analytics dashboard component on a page.Determines the field behavior.References a canvas app.References a component.The custom link reference.Controls if this layout item is a blank space.The field name reference, relative to the layout, for example “Description” or “MyField__c”.For s-controls and pages only, the height in pixels.Reference to a Visualforce page.Refers to a report chart that you can add to a standard or custom object page.Reference to an s-control.For s-control and pages only, whether to show the label.For s-control and pages only, whether to show scrollbars.For s-control and pages only, the width in pixels or percent. Pixel values are simply the number of pixels, for example, 500. Percentage values must include the percent sign, for example, 20%.Makes a duplicate copy of the Metadata.LayoutItem.
• LayoutSection Class: Represents a section of a page layout, such as the Custom Links section.Indicates if this section's label is custom or standard (built-in).Controls whether this heading appears on the detail page.Controls whether this heading appears on the edit page.The label; either standard or custom, based on the customLabel property.Lists the layout columns. You can have one, two, or three columns, ordered left to right, are possible.The style of the layout for this section.Makes a duplicate copy of the Metadata.LayoutSection.
• Metadata Class: An abstract base class that represents a custom metadata component.The full name of the custom metadata, which can include the namespace, type, and component name.Makes a duplicate copy of the Metadata.Metadata.
• MetadataValue Class: An abstract base class that represents a custom metadata component field.Makes a duplicate copy of the Metadata.MetadataValue.
• MiniLayout Class: Represents a mini view of a record in the Console tab, hover details, and event overlays.The fields for the mini-layout, listed in the order they appear in the UI. Fields that appear in the mini-layout must appear in the main layout.The mini related lists, listed in the order they appear in the UI. You cannot set sorting on mini related lists. Fields that appear in the mini related lists must appear in the main layout.Makes a duplicate copy of the Metadata.MiniLayout.
• Operations Class: Represents a class to execute metadata operations, such as retrieving or deploying custom metadata.Makes a duplicate copy of the Metadata.Operations.Deploys custom metadata components asynchronously.Retrieves a list of custom metadata components.
• PlatformActionList Class: Represents the list of actions, and their order, that display in the Salesforce mobile action bar for the layout.The context of the action list.The actions in the platform action list.When the actionListContext property is “RelatedList” or” “RelatedListRecord”, this field represents the API name of the related list to which the action belongs.Makes a duplicate copy of the Metadata.PlatformActionList.
• PlatformActionListItem Class: Represents an action in the platform action list for a layout.The API name for the action in the list.The type of action.The placement of the action in the list.The subtype of the action.Makes a duplicate copy of the Metadata.PlatformActionListItem.
• PrimaryTabComponents Class: Represents custom console components on primary tabs in the Salesforce console.Represents a custom console component (Visualforce page, lookup field, or related lists) on a section of a page layout. Represents a location and style in which to display more than one custom console component on the sidebars of the Salesforce console.Makes a duplicate copy of the Metadata.PrimaryTabComponents.
• QuickActionList Class: Represents the list of actions associated with the page layout.List of QuickActionList objects.Makes a duplicate copy of the Metadata.QuickActionList.
• QuickActionListItem Class: Represents an action in the QuickActionList.The API name of the action.Makes a duplicate copy of the Metadata.QuickActionListItem.
• RelatedContent Class: Represents the Mobile Cards section of the page layout.A list of layout items in the Mobile Cards section of the page layout.Makes a duplicate copy of the Metadata.RelatedContent.
• RelatedContentItem Class: Represents an individual item in the RelatedContent list.An individual layout item in the Mobile Cards section.Makes a duplicate copy of the Metadata.RelatedContentItem.
• RelatedList Class: Represents related list custom components on the sidebars of the Salesforce console.When set to true, the related list is hidden from detail pages where it appears as a component to prevent duplicate information from showing.The name of the component as it appears to console users.Makes a duplicate copy of the Metadata.RelatedList.
• RelatedListItem Class: Represents an item in the related list in a page layout.A list of custom buttons used in the related list.A list of excluded related-list buttons.A list of fields displayed in the related list. Uses aliases instead of field or API names.A list of quick actions used on the related list.The name of the related list.The name of the field used for sorting.When sortField is set, the sortOrder property determines the sort order.Makes a duplicate copy of the Metadata.RelatedListItem.
• ReportChartComponentLayoutItem Class: Represents the settings for a report chart on a standard or custom page.Indicates whether to use cached data when displaying the chart. When the attribute is set to true, data is cached for 24 hours. When the attribute is set to false, the report is run every time the page is refreshed.Unique development name of the field by which a report chart is filtered to return data relevant to the page. If set, the ID field for the parent object of the page or report type is the chart data filter. The parent object for the report type and the page must match for a chart to return relevant data.Error string that is populated only when an error occurs in the underlying report.Controls whether users see a chart that has an error. When an error occurs and this attribute is not set, the chart doesn’t show any data except the error. Set the attribute to true to hide the chart from a page on error.If true, filters the report chart to return data that’s relevant to the page.Unique development name of a report that includes a chart.If true, applies the title from the report to the chart.Size of the displayed chart. The default is medium.Makes a duplicate copy of the Metadata.ReportChartComponentLayoutItem.
• SidebarComponent Class: Represents a specific custom console component to display in a container that hosts multiple components in one of the sidebars of the Salesforce console.Specifies the component type. Valid values are “KnowledgeOne”, “Lookup”, “Milestones”, “RelatedList”, “Topics”, “Files”, and “CaseExperts”. If the component is a lookup field, the name of the quick action used to create a record.If the component is a lookup field, lets users associate a record with this field.The height of the component in the container. The unit property determines the unit of measurement, in pixels or percent.Indicates if the component is enabled for Knowledge One.The name of the component as it displays to console users. Available for components in a container with the style of tabs or accordion.If the component is a lookup field, the name of the field.If the component is a Visualforce page, the name of the Visualforce page.If the component is a related list component, the list of related list names.The unit of measurement (pixels or percent) for the height and width of the component in the container.If the component is a lookup field, the name of the quick action used to update a record.The width of the component in the container. The unit property determines the unit of measurement, in pixels or percent.Makes a duplicate copy of the Metadata.SidebarComponent.
• SubtabComponents Class: Represents custom console components on subtabs in the Salesforce console.Represents a custom console component (Visualforce page, lookup field, or related lists) on a section of a page layout. Represents a location and style in which to display more than one custom console component on the sidebars of the Salesforce console.Makes a duplicate copy of the Metadata.SubtabComponents.
• SummaryLayout Class: Controls the appearance of the highlights panel, which summarizes key fields in a grid at the top of a page layout, when Case Feed is enabled.The name of the layout label.Number of columns in the highlights pane, between 1 and 4 (inclusive).Number of rows in each column, either 1 or 2.If provided, the setting is not visible to users.Controls the appearance of an individual field and its column and row position within the highlights panel grid, when Case Feed is enabled. At least one is required.Specifies the panel style.Makes a duplicate copy of the Metadata.SummaryLayout.
• SummaryLayoutItem Class: Controls the appearance of an individual field and its column and row position within the highlights panel grid, when Case Feed is enabled. You can have two fields per each grid in a highlights panel.The custom link reference.The field name reference, relative to the page layout. Must be a standard or custom field that also exists on the detail page.The item's column position in the highlights panel grid. Must be within the range of sizeX.The item's row position in the highlights panel grid. Must be within the range of sizeY.Reserved for future use. If provided, the setting is not visible to users.Makes a duplicate copy of the Metadata.SummaryLayoutItem.
• PluginDescribeResult Class: Describes the input and output parameters for Process.PluginResult.Creates a new instance of the Process.PluginDescribeResult class.This optional field describes the purpose of the plug-in.The input parameters passed by the Process.PluginRequest class from a flow to the class that implements the Process.Plugin interface.Unique name of the plug-in.The output parameters passed by the Process.PluginResult class from the class that implements the Process.Plugin interface to the flow.
• PluginDescribeResult.InputParameter Class: Describes the input parameter for Process.PluginResult.Creates a new instance of the Process.PluginDescribeResult.InputParameter class using the specified name, description, parameter type, and required option.Creates a new instance of the Process.PluginDescribeResult.InputParameter class using the specified name, parameter type, and required option.This optional field describes the purpose of the plug-in.Unique name of the plug-in.The data type of the input parameter.Set to true for required and false otherwise.
• PluginDescribeResult.OutputParameter Class: Describes the output parameter for Process.PluginResult.Creates a new instance of the Process.PluginDescribeResult.OutputParameter class using the specified name, description, and parameter type.Creates a new instance of the Process.PluginDescribeResult.OutputParameter class using the specified name, description, and parameter type.This optional field describes the purpose of the plug-in.Unique name of the plug-in.The data type of the output parameter.
• PluginRequest Class: Passes input parameters from the class that implements the Process.Plugin interface to the flow.Input parameters that are passed from the class that implements the Process.Plugin interface to the flow.
• PluginResult Class: Returns output parameters from the class that implements the Process.Plugin interface to the flow.Output parameters returned from the class that implements the interface to the flow.
• DescribeQuickActionParameter Class: Represents the parameters corresponding to a quick action. Learn more about the available properties with the CalculateTaxRequest class.Describes the name of the parameter that can be associated with a specific quick action type. For example, User Utterance is a parameter that is associated with agent quick actions.Describes the type of quick action. The type can either be Input or Output. Describes the value of the parameter associated with the quick action. Returns the name of the parameter associated with the quick action. Returns the type of the parameter associated with the quick action. This can either be Input or Output.Returns the value of the parameter associated with the quick action.
• QuickActionDefaults Class: Represents an abstract Apex class that provides the context for running the standard Email Action on Case Feed and the container of the Email Message fields for the action payload. You can override the target fields before the standard Email Action is rendered. Returns the name of the standard Email Action on Case Feed (Case.Email). Returns the type of the standard Email Action on Case Feed (Email).The ID of the context related to the standard Email Action on Case Feed (Case ID).The target object of the standard Email Action on Case Feed (EmailMessage).
• SendEmailQuickActionDefaults Class: Represents an Apex class that provides: the From address list; the original email’s email message ID, provided that the reply action was invoked on the email message feed item; and methods to specify related settings on templates. You can override these fields before the standard Email Action is rendered. Returns a list of email addresses that are available in the From: address drop-down menu for the standard Email Action.Returns the email message ID of the email to which the reply/reply all action has been invoked.Specifies whether the template subject should be ignored (true), thus using the original subject, or whether the template subject should replace the original subject (false). Specifies whether the template body should be inserted above the original body content (true) or whether it should replace the entire content with the template body (false).Sets the email template ID to load into the email body.
• AbstractTiming Class: Parent class for other RichMessaging timing classes.
• Address Class: Represents a postal address.The street address lines (street, unit, etc.) of the postal address.The street address lines variable of the postal address.The sub-locality information associated with the address (defined at the city level).The sub-locality variable of the address.The locality (city) of the postal address.The locality variable of the postal address.The postal code (zip or postal code) of the address.The postal code variable of the address.The sub-administrative area (county or other region) of the address.The sub-administrative area variable of the address.The administrative area (state or province) of the address.The administrative area variable of the address.The country of the address.The country variable of the address.The ISO country code of the address.The country code variable of the address.
• AddressableContact Class: Represents an addressable contact.Creates a new instance of the RichMessaging.AddressableContact class.The contact’s email address.The contact’s surname.The contact’s first name.The contact’s phone number.The phonetic spelling of the contact’s surname.The phonetic spelling of the contact’s first name.The contact’s postal address.
• AuthRequestResponse Class: This class contains authorization request response data.Creates a new instance of the RichMessaging.AuthRequestResponse class.Gets the authorization access token.Get the authorization provider name.Gets the context record ID.
• AuthRequestResult Class: This class contains the result from handling the authorization request response.Creates a new instance of the RichMessaging.AuthRequestResult class.The expiration date and time.The reference to the redirect page.The result status value.
• CurrencyAmount Class: Represents a monetary amount in a specific currency.The numeric amount value.The ISO currency code of the amount.
• DeferredTiming Class: Represents timing for a transaction that occurs in the future.Creates a new instance of the RichMessaging.DeferredTiming class.Creates a new instance of the RichMessaging.DeferredTiming class.The deferred date. Invocable variable.The deferred date. Enabled for Lightning components.Always returns “DeferredTiming”.
• MessageDefinitionInputParameter Class: Represents a messaging component parameter value. This class is used to provide parameter payloads that can be translated to structured content payloads in rich content messages.A boolean input parameter.A list of boolean parameters.A datetime input parameter.A list of datetime input parameters.A date input parameter.A list of date input parameters.A name input parameter.A number input parameter.A list of number input parameters.A record ID input parameter.A list of record ID input parameters.A text input parameter.A list of text input parameters.
• OrderBeneficiary Class: Represents the beneficiary of an order.The legal name of the beneficiary.The legal name variable of the beneficiary.The type of tax identifier of the beneficiary.The tax identifier type variable of the beneficiary.The tax identifier value of the beneficiary.The tax identifier value variable of the beneficiary.
• OrderContext Class: Represents the context information of an order.The type of the order.The order type variable of the order.The checkout behavior for the payment.The payment checkout behavior variable of the order.The expiration information for the order.The order expiration variable for the order.The list of payment method hints for the order.The payment method hints variable for the order.The beneficiary information of the order.The order beneficiary variable for the order.The payment initiation information for the order.The payment initiation variable for the order.
• OrderExpiration Class: Represents the expiration information of an order.The expiration date and time of the order.The expiration date and time variable of the order.The duration after creation when the order expires (in seconds).The duration from creation variable of the order expiration.
• OrderItemCommerceAttributes Class: Represents the commerce attributes of an order item.The retailer ID of the order item.The retailer ID variable for the order item.The category of the order item.The category variable for the order item.The importer information of the order item.The importer variable for the order item.
• OrderItemImporter Class: Represents the importer information for an order item.The country of origin for the imported order item.The country of origin variable for the imported order item.The name of the importer.The name variable of the importer.The address of the importer.The address variable of the importer.
• PaymentError Class: Represents an error that occurred during a payment transaction.The error code returned by the payment gateway.The error message describing the payment failure.
• PaymentGatewayProperties Class: Represents gateway-specific properties for a payment.The return URL for the gateway payment.The return URL variable for the gateway payment.The callback URL for the gateway payment notifications.The callback URL variable for the gateway payment.
• PaymentInitiation Class: Represents the payment initiation information for an order.The mode used to initiate the payment.The initiation mode variable for the payment.The PIX payment initiation details.The PIX payment initiation variable.The Boleto payment initiation details.The Boleto payment initiation variable.The gateway-based payment initiation details.The gateway payment initiation variable.
• PaymentInitiationBoleto Class: Represents Boleto-specific payment initiation details.The Boleto document number.The Boleto document number variable.
• PaymentInitiationGateway Class: Represents gateway-specific payment initiation details.The order ID associated with the gateway payment initiation.The order ID variable for the gateway payment initiation.The currency of the gateway payment.The currency variable of the gateway payment.The amount of the gateway payment.The amount variable of the gateway payment.The gateway-specific properties for the payment.The gateway properties variable for the payment.The cryptographic signature of the gateway payment request.The signature variable of the gateway payment request.Additional metadata for the gateway payment.The metadata variable for the gateway payment.
• PaymentInitiationPix Class: Represents PIX-specific payment initiation details.The PIX key type.The PIX key type variable.The PIX key value.The PIX key variable.The end-to-end identifier of the PIX transaction.The end-to-end ID variable of the PIX transaction.
• PaymentLineItem Class: Represents a payment line item in payment requests sent in enhanced Messaging channels. Creates a new instance of the RichMessaging.PaymentLineItem class.Creates a new instance of the RichMessaging.PaymentLineItem class.Creates a new instance of the RichMessaging.PaymentLineItem class.The amount of the payment line item.The amount value of the payment line item.The automatic reload payment threshold amount of the payment line item.The automatic reload payment threshold amount value of the payment line item.The commerce attributes of the payment line item.The commerce attributes variable for the payment line item.The discount applied to the payment line item.The discount variable for the payment line item.The label of the payment line item.The label value of the payment line item.The line item type of the payment line item. Read-only variable.The quantity of the payment line item.The quantity variable for the payment line item.The sale amount of the payment line item.The sale amount variable for the payment line item.The status of the payment line item.The status value of the payment line item.The timing of the payment line item.The timing value of the payment line item.
• PaymentMethod Class: Represents a payment method.Creates a new instance of the RichMessaging.PaymentMethod class.The display name of the payment method.The network associated with the payment method.The payment type of the payment method.
• PaymentTransaction Class: Represents a payment transaction.The unique identifier of the transaction.The type of the transaction.The status of the transaction.The amount of the transaction.The reference identifier from the payment gateway.The date and time when the transaction occurred.The list of refunds associated with the transaction.
• PostalAddress Class: Represents the postal address.Creates a new instance of the RichMessaging.PostalAddress class.The street address.The administrative area.The country.The country code.The locality of the address.The postal code.The sub-administrative area.The sub-locality of the address.
• ProcessPaymentRequest Class: Represents a request to process a payment.Creates a new instance of the RichMessaging.ProcessPaymentRequest class.The billing contact information for the payment request.The context record ID associated with the payment request.The encrypted payment data for the payment request.The payment method for the payment request.The shipping contact information for the payment request.The shipping method for the payment request.The transaction identifier associated with the payment request.
• ProcessPaymentResult Class: Represents the result of a payment processing operation.Creates a new instance of the RichMessaging.ProcessPaymentResult class.Creates a new instance of the RichMessaging.ProcessPaymentResult class.The error message associated with the payment processing result, if any.The status of the payment processing result.
• ProcessPaymentStatusRequest Class: Represents a request to process a payment status update.The payment method used in the transaction.The order ID associated with the payment.The amount of the payment transaction.The type of payment transaction.The status of the payment transaction.The unique identifier of the payment transaction.The payment transaction details.The error information for a failed payment transaction.
• ProcessPaymentStatusResult Class: Represents the result of processing a payment status update.The processing status of the payment status update.An optional message describing the result.
• RecurringTiming Class: Represents a payment that occurs on a regular basis.Creates a new instance of the RichMessaging.RecurringTiming class.Creates a new instance of the RichMessaging.RecurringTiming class.The end date. Invocable variable.The end date. Enabled for Lightning components.The number of interval units that make up the total payment interval. Invocable variable.The number of interval units that make up the total payment interval. Enabled for Lightning components.The amount of time—in calendar units, such as day, month, or year—that represents a fraction of the total payment interval. Invocable variable.The amount of time—in calendar units, such as day, month, or year—that represents a fraction of the total payment interval. Enabled for Lightning components.The start date. Invocable variable.The start date. Enabled for Lightning components.Always returns “RecurringTiming”.
• Refund Class: Represents a refund for a payment transaction.The unique identifier of the refund.The amount of the refund.The status of the refund.The reason for the refund.The date and time when the refund was processed.The reference identifier from the payment gateway for the refund.
• ShippingMethod Class: Represents a shipping method listed in payment requests sent in enhanced Messaging channels.Creates a new instance of the RichMessaging.ShippingMethod class.Creates a new instance of the RichMessaging.ShippingMethod class.The amount of the shipping method.The amount value of the shipping method.Details about the shipping method.The detail value of the shipping method.The identifier of the shipping method.The identifier value of the shipping method.The label of the shipping method.The label value of the shipping method.The shipping method type. Read only.
• TimeSlotOption Class: Represents a complex time slot option type. This class is used to provide time option payloads that can be translated to structured content payloads in rich content messages.Creates a TimeSlotOption object with a start and end time.Creates a TimeSlotOption object with a start time and a duration.Creates a TimeSlotOption object.The duration in seconds.The duration in seconds. Enabled for Lightning components.The end time. Enabled for Lightning components.The start time.The start time. Enabled for Lightning components.
• ArchiverAccessor Class: Provides access to Archive Apex. In tests, use setMock() to return a simulated response instead of making a live archive callout.Instructs the Apex runtime to send a mock response whenever Archive Apex makes a callout, so you can test your Apex without accessing archived data.
• ArchiverAccessorResponse Class: Represents the response returned by Archive Apex methods. In tests, use the setter methods to build a simulated response for your mock to return.Sets the body of the mock response as a JSON string.Sets the HTTP status code of the mock response.Sets the error message of the mock response, so you can test how your Apex handles a failed Archive Apex callout.
• ChildRelationship Class: Contains methods for accessing the child relationship as well as the child sObject for a parent sObject.Returns the token of the child sObject on which there is a foreign key back to the parent sObject.Returns the token of the field that has a foreign key back to the parent sObject.Returns the name of the relationship.Returns true if the child object is deleted when the parent object is deleted, false otherwise.Reserved for future use. Returns true if the parent object can't be deleted because it is referenced by a child object, false otherwise.
• DataCategory Class: Represents the categories within a category group.Returns a recursive object that contains the visible sub categories in the data category.Returns the label for the data category used in the Salesforce user interface.Returns the unique name used by the API to access to the data category.
• DataCategoryGroupSobjectTypePair Class: Specifies a category group and an associated object.Creates a new instance of the Schema.DataCategoryGroupSobjectTypePair class.Returns the unique name used by the API to access the data category group.Returns the object name associated with the data category group.Specifies the unique name used by the API to access the data category group.Sets the sObject associated with the data category group.
• Describe​DataCategoryGroupResult Class: Contains the list of the category groups associated with KnowledgeArticleVersion and Question.Returns the number of visible data categories in the data category group.Returns the description of the data category group.Returns the label for the data category group used in the Salesforce user interface.Returns the unique name used by the API to access to the data category group.Returns the object name associated with the data category group.
• Describe​DataCategoryGroupStructureResult Class: Contains the category groups and categories associated with KnowledgeArticleVersion and Question.Returns the description of the data category group.Returns the label for the data category group used in the Salesforce user interface.Returns the unique name used by the API to access to the data category group.Returns the name of object associated with the data category group.Returns a Schema.DataCategory object, that contains the top categories visible depending on the user's data category group visibility settings.
• FieldSetMember Class: Contains methods for accessing the metadata for field set member fields.Returns true if the field is required by the field’s definition in its sObject, otherwise, false.Returns a field path string in a format ready to be used in a dynamic SOQL query.Returns the text label that’s displayed next to the field in the Salesforce user interface.Returns true if the field is required by the field set, otherwise, false.Returns the field’s Apex data type. Returns the token for this field.
• PicklistEntry Class: Represents a picklist entry.Returns the display name of this item in the picklist.Returns the value of this item in the picklist.Returns true if this item must be displayed in the drop-down list for the picklist field in the user interface, false otherwise.Returns true if this item is the default value for the picklist, false otherwise. Only one item in a picklist can be designated as the default.
• RecordTypeInfo Class: Contains methods for accessing record type information for an sObject with associated record types.Returns the developer name for this record type.Returns the UI label of this record type. The label can be translated into any language that Salesforce supports.Returns the ID of this record type.Returns true if this record type is active, false otherwise.Returns true if this record type is available to the current user, false otherwise. Use this method to display a list of available record types to the user when he or she is creating a new record.Returns true if this is the default record type for the user, false otherwise.Returns true if this is the master record type and false otherwise. The master record type is the default record type that’s used when a record has no custom record type associated with it.
• SObjectField Class: A Schema.sObjectField object is returned from the field describe result using the getController and getSObjectField methods.Returns the describe field result for this field.Returns the describe field result for this field. This method also provides an option to get all the describe field results for an object.
• SObjectType Class: A Schema.sObjectType object is returned from the field describe result using the getReferenceTo method, or from the sObject describe result using the getSObjectType method.Returns the describe sObject result for this field.Returns the describe sObject result for this field; the parameter value determines whether all child relationships are loaded up-front, or not.Constructs a new sObject of this type.Constructs a new sObject of this type, with the specified ID.Constructs a new sObject of this type, and optionally, of the specified record type ID and with default custom field values.
• KnowledgeSuggestionFilter Class: Filter settings that narrow the results from a call to System.Search.suggest(searchQuery, sObjectType, options) when the SOSL search query contains a KnowledgeArticleVersion object.Adds a filter that narrows suggestion results to display the specified article type. This filter is optional.Adds a filter that narrows suggestion results to display articles in the specified data category. This filter is optional.Specifies the article topic to return. This filter is optional.Sets a channel to narrow the suggestion results to articles in the specified channel. This filter is optional.Adds filters that narrow suggestion results to display articles in the specified data categories. Use this method to set multiple data category group and name pairs in one call. This filter is optional.Sets a language to narrow the suggestion results to display articles in that language. This filter value is required in calls to System.Search.suggest(String, String, Search.SuggestionOption).Sets a publish status to narrow the suggestion results to display articles with that status. This filter value is required in calls to System.Search.suggest(String, String, Search.SuggestionOption).Sets a validation status to narrow the suggestion results to display articles with that status. This filter is optional.
• QuestionSuggestionFilter Class: The Search.QuestionSuggestionFilter class filters results from a call to System.Search.suggest(searchQuery, sObjectType, options) when the SOSL searchQuery contains a FeedItem object.Adds a filter to display questions associated with the single specified group whose ID is passed in as an argument. This filter is optional.Adds a filter to display questions associated with the single specified network whose ID is passed in as an argument. This filter is optional.Adds a filter to display questions belonging to the single specified user whose ID is passed in as an argument. This filter is optional.Sets a new list of groups to replace the current list of groups where the group IDs are passed in as an argument. This filter is optional.Sets a new list of networks to replace the current list of networks where the network IDs are passed in as an argument. This filter is optional.Sets a filter to display questions associated with the single specified topic whose ID is passed in as an argument. This filter is optional.Sets a new list of users to replace the current list of users where the users IDs are passed in as an argument. This filter is optional.
• SearchResult Class: A wrapper object that contains an sObject and search metadata.Returns an sObject from a SearchResult object.Returns a snippet from a Case, Feed, or Knowledge Article SearchResult object based on the specified field name.Returns a snippet from a SearchResult object based on the default field.
• SearchResults Class: Wraps the results returned by the Search.find(String​) method.Returns a list of Search.SearchResult objects that contain an sObject of the specified type.
• SuggestionOption Class: Options that narrow record and article suggestion results returned from a call to System.Search.suggest(String, String, Search.SuggestionOption).Set filters that narrow Salesforce Knowledge article results in a call to System.Search.suggest(String, String, Search.SuggestionOption). The maximum number of record or article suggestions to retrieve.
• SuggestionResult Class: A wrapper object that contains an sObject.Returns the sObject from a SuggestionResult object.
• SuggestionResults Class: Wraps the results returned by the Search.suggest(​String, String, Search.SuggestionOption) method.Returns a list of SuggestionResult objects from the response to a call to Search.suggest(String, String, Search.SuggestionOption).Indicates whether a call to System.Search.suggest(String, String, Search.SuggestionOption) has more results available than were returned.
• ContentDownloadHandler Class: Use ContentDownloadHandler to define a custom download handler that controls how content is downloaded.A customized error message explaining why the download isn’t allowed.Indicates whether or not download is allowed.The URL the user is redirected to when the download action isn't available, for applying Information Rights Management (IRM) control, virus scanning, or other behavior.
• AccessLevel Class: Defines the different modes, such as system or user mode, that Apex database operations execute in. Supports database and search operations to be run with permissions specified in a permission set. Apex enforces field-level security (FLS) and object permissions as per the specified permission set, in addition to the running user’s permissions.Execution mode in which the the object and field-level permissions of the current user are ignored, and the record sharing rules are controlled by the class sharing keywords.Execution mode in which the object permissions, field-level security, and sharing rules of the current user are enforced.
• Assert Class: Contains methods to assert various conditions with test methods, such as whether two values are the same, a condition is true, or a variable is null. Asserts that the first two arguments are the same. Asserts that the two arguments are the same. Asserts that the first two arguments aren’t the same. Asserts that the two arguments aren’t the same. Immediately return a fatal error that causes code execution to halt.Immediately return a fatal error that causes code execution to halt.Asserts that the specified condition is false. Asserts that the specified condition is false. Asserts that the instance is of the specified type. Asserts that the instance is of the specified type. Asserts that the instance isn’t of the specified type. Asserts that the instance isn’t of the specified type. Asserts that the value isn’t null. Asserts that the value isn’t null. Asserts that the value is null. Asserts that the value is null. Asserts that the specified condition is true. Asserts that the specified condition is true.
• AsyncInfo Class: Provides methods to get the current stack depth, maximum stack depth, and the minimum queueable delay for Queueable transactions, and to determine if maximum stack depth is set.Get the current queueable stack depth for queueable transactions.Get the maximum queueable stack depth for queueable transactions.Get the minimum queueable delay for queueable transactions (in minutes).Determine if maximum stack depth is set for your queueable requests.
• AsyncOptions Class: Contains maximum stack depths for queueable transactions and the minimum queueable delay in minutes. Passed as parameter to the System.enqueueJob() method to define a unique queueable job signature, the maximum stack depth for queueable transactions and the minimum queueable delay in minutes.A unique signature for a Queueable job.Maximum stack depth for queueable transactions.Minimum queueable delay for queueable transactions.
• Collator Class: Contains methods to get locale-specific instances that can be used for comparisons and sorting. Use the getInstance() method to obtain the Collator instance for a given locale and pass the Collator as the Comparator parameter to the list.sort() method.Perform string comparisons for a given locale.Gets the Collator instance for the current user’s locale.
• Continuation Class: Use the Continuation class to make callouts asynchronously to a SOAP or REST Web service.Creates an instance of the Continuation class by using the specified timeout in seconds. The timeout maximum is 120 seconds.The name of the callback method that is called after the callout response returns.The timeout of the continuation in seconds. Maximum: 120 seconds.Data that is stored in this continuation and that can be retrieved after the callout is finished and the callback method is invoked.Adds the HTTP request for the callout that is associated with this continuation.Returns all labels and requests that are associated with this continuation as key-value pairs.Returns the response for the request that corresponds to the specified label.
• Domain Class: Represents an existing domain hosted by Salesforce that serves the org or its content. Contains methods to obtain information about these domains, such as the domain type, My Domain name, and sandbox name. Returns the domain’s type, such as CONTENT_DOMAIN, EXPERIENCE_CLOUD_SITES_DOMAIN, or LIGHTNING_DOMAIN.Returns the domain’s My Domain name.For a domain that includes the package name, such as a Lightning Component domain or Visualforce page domain, returns the package name. For a domain that doesn’t contain a package name, this method returns null.For a sandbox org domain, returns the sandbox name. For a production org domain, returns null.For a system-managed Experience Cloud site domain or Salesforce Site domain, returns the sites subdomain name. If enhanced domains are enabled, this method always returns null. When enhanced domains are enabled, the org’s My Domain name is the subdomain for the system-managed domains for Experience Cloud sites and Salesforce Sites domains.
• DomainCreator Class: Use the DomainCreator class to return a hostname specific to the org. For example, get the org’s Visualforce hostname. Values are returned as a hostname, such as MyDomainName.lightning.force.com.Returns the hostname for content stored in the org, such as files.Returns the hostname to access Experience Builder for the org’s Experience Cloud sites.Returns the system-managed hostname for the org’s Experience Cloud sites, such as ExperienceCloudSitesSubdomainName.force.com. If Digital Experiences aren’t enabled, this method throws an InvalidParameterValueException.Returns the hostname to access Experience Builder Live Preview for the org’s Experience Cloud sites.Returns the hostname to access Experience Builder Preview for the org’s Experience Cloud sites.Returns the hostname for the org’s Lightning Container Components.Returns the hostname for the org’s Lightning pages.Returns the hostname for the org’s My Domain login domain.Returns the hostname for the org’s Salesforce Sites. If Salesforce Sites aren’t enabled, this method throws an InvalidParameterValueException.Returns the hostname for the org’s setup domain, which hosts Setup pages in Salesforce. Returns the hostname for the org’s Visualforce pages.
• DomainParser Class: Use the DomainParser class to parse a domain that Salesforce hosts for the org and extract information about the domain. Parses a passed hostname of a domain that Salesforce hosts for the org, and returns the System.Domain.Parses a passed uniform resource locator (URL) of a domain that Salesforce hosts for the org, and returns the System.Domain.
• ExternalServiceTest Class: Provides methods to test an external service's asynchronous callouts, enables sending a mock request, asserts the expected request payload, then triggers the mocked external service’s asynchronous callback response.An instance of the ExternalServiceTest method is used when the test class triggers a mocked external service’s callback response. You can access ExternalServiceTest through Test.getExternalService() Sends the HTTP request back as an external service asynchronous response.
• FeatureManagement Class: Use the methods in the System.FeatureManagement class to check and modify the values of feature parameters, and to show or hide custom objects and custom permissions in your subscribers’ orgs.Hides or reveals custom permissions, or reveals custom objects, in your subscriber’s org.Checks the value__c value of the FeatureParameterBoolean__c record for a feature parameter in your subscriber’s org. You set the record’s value using setPackageBooleanValue(apiName, value). Checks the value__c value of the FeatureParameterDate__c record for a feature parameter in your subscriber’s org. You can set the record’s value using setPackageDateValue(apiName, value). Checks the value__c value of the FeatureParameterInteger__c record for a feature parameter in your subscriber’s org. You can set the record’s value using setPackageIntegerValue(apiName, value). Checks whether a custom permission is enabled.Sets the value__c value of the FeatureParameterBoolean__c record for a subscriber-to-LMO feature parameter in your subscriber’s org. You can check the record’s value using checkPackageBooleanValue(apiName). Sets the value__c value of the FeatureParameterDate__c record for a subscriber-to-LMO feature parameter in your subscriber’s org. You can check the record’s value using checkPackageDateValue(apiName). Sets the value__c value of the FeatureParameterInteger__c record for a subscriber-to-LMO feature parameter in your subscriber’s org. You can check the record’s value using checkPackageIntegerValue(apiName).
• FlexQueue Class: Contains methods that reorder batch jobs in the Apex flex queue.Moves the job with the ID jobToMoveId immediately after the job with the ID jobInQueueId in the flex queue. You can move jobToMoveId forward or backward in the queue. If either job isn’t in the queue, it throws an element-not-found exception. Returns true if the job is moved, or false if jobToMoveId is already immediately after jobInQueueId, so no change is made.Moves the job with the ID jobToMoveId immediately before the job with the ID jobInQueueId in the flex queue. You can move jobToMoveId forward or backward in the queue. If either job isn’t in the queue, it throws an element-not-found exception. Returns true if the job is moved, or false if jobToMoveId is already immediately before jobInQueueId, so no change is made.Moves the specified job the end of the flex queue, to index position (size - 1). All jobs after the job’s starting position move one spot forward. If the job isn’t in the queue, it throws an element-not-found exception. Returns true if the job is moved, or false if the job is already at the end of the queue, so no change is made.Moves the specified job to the front of the flex queue, to index position 0. All other jobs move back one spot. If the job isn’t in the queue, it throws an element-not-found exception. Returns true if the job is moved, or false if the job is already at the front of the queue, so no change is made.
• Formula Class: Contains methods to get a builder for creating a formula instance and to update all formula fields on the input SObjects.Creates an instance of FormulaBuilder for configuring the formula with formula expression, context type, and output data type as inputs. Updates (recalculates) all formula fields on the input SObjects.
• FormulaRecalcFieldError Class: The return type of the FormulaRecalcResult.getErrors method.Returns a message describing the errors encountered during formula recalculation. Returns the name of the formula recalculation error field.
• FormulaRecalcResult Class: The return type of the Formula.recalculateFormulas method.If an error occurs during formula recalculation, an array of one or more database error objects, along with error codes and descriptions, is returned.Returns the sObject with formulas recalculated.Returns a Boolean value that is set to true if the formula recalculation process completed successfully; otherwise, it is set to false.
• IntegrationTest Class (Developer Preview): Contains the commitTestOnly() method that can be called from an @IntegrationMethod to commit data mid-transaction so that it’s visible to service threads such as Agentforce and Data 360.Commits data to the database mid-transaction so it’s visible to service threads such as Agentforce and Data 360. It resets the uncommitted work checkpoint and mixed DML tracking for the new transaction boundary. The method can only be called from an @IntegrationTest method.
• JSON Class: Contains methods for serializing Apex objects into JSON format and deserializing JSON content that was serialized using the serialize method in this class.Returns a new JSON generator.Returns a new JSON parser.Deserializes the specified JSON string into an Apex object of the specified type.Deserializes the specified JSON string into an Apex object of the specified type.Deserializes the specified JSON string into collections of primitive data types.Serializes Apex objects into JSON content.Suppresses null values when serializing Apex objects into JSON content.Serializes Apex objects into JSON content and generates indented content using the pretty-print format.Suppresses null values when serializing Apex objects into JSON content and generates indented content using the pretty-print format.
• JSONGenerator Class: Contains methods used to serialize objects into JSON content using the standard JSON encoding.Closes the JSON generator.Returns the generated JSON content.Returns true if the JSON generator is closed; otherwise, returns false.Writes the specified Blob value as a base64-encoded string.Writes a field name and value pair using the specified field name and BLOB value.Writes the specified Boolean value.Writes a field name and value pair using the specified field name and Boolean value.Writes the specified date value in the ISO-8601 format.Writes a field name and value pair using the specified field name and date value. The date value is written in the ISO-8601 format.Writes the specified date and time value in the ISO-8601 format.Writes a field name and value pair using the specified field name and date and time value. The date and time value is written in the ISO-8601 format.Writes the ending marker of a JSON array (']').Writes the ending marker of a JSON object ('}').Writes a field name.Writes the specified ID value.Writes a field name and value pair using the specified field name and identifier value.Writes the JSON null literal value.Writes a field name and value pair using the specified field name and the JSON null literal value.Writes the specified decimal value.Writes the specified double value.Writes the specified integer value.Writes the specified long value.Writes a field name and value pair using the specified field name and decimal value.Writes a field name and value pair using the specified field name and double value.Writes a field name and value pair using the specified field name and integer value.Writes a field name and value pair using the specified field name and long value.Writes the specified Apex object in JSON format.Writes a field name and value pair using the specified field name and Apex object.Writes the starting marker of a JSON array ('[').Writes the starting marker of a JSON object ('{').Writes the specified string value.Writes a field name and value pair using the specified field name and string value.Writes the specified time value in the ISO-8601 format.Writes a field name and value pair using the specified field name and time value in the ISO-8601 format.
• JSONParser Class: Represents a parser for JSON-encoded content.Removes the current token.Returns the current token as a BLOB value. Returns the current token as a Boolean value. Returns the name associated with the current token. Returns the token that the parser currently points to or null if there's no current token.Returns the current token as a date and time value. Returns the current token as a date value. Returns the current token as a decimal value. Returns the current token as a double value. Returns the current token as an ID value. Returns the current token as an integer value. Returns the last token that was cleared by the clearCurrentToken method.Returns the current token as a long value. Returns the textual representation of the current token or null if there's no current token.Returns the current token as a time value. Returns true if the parser currently points to a token; otherwise, returns false.Returns the next token or null if the parser has reached the end of the input stream.Returns the next token that is a value type or null if the parser has reached the end of the input stream.Deserializes JSON content into an object of the specified Apex type and returns the deserialized object.Deserializes JSON content into an object of the specified Apex type and returns the deserialized object. All attributes in the JSON content must be present in the specified type.Skips all child tokens of type JSONToken.START_ARRAY and JSONToken.START_OBJECT that the parser currently points to.
• JweToken Class: Represents a parsed JWE (JSON Web Encryption) token in the compact serialization form defined by RFC 7516. A JweToken holds the components needed for decryption: protected header, ephemeral public key, wrapped content encryption key, initialization vector, ciphertext, authentication tag, and Additional Authenticated Data (AAD). Creates a new JweToken from the parsed components of a JWE compact serialization token. This constructor is typically invoked internally after Crypto.parseJwe(Blob) has decomposed the token.Returns the Additional Authenticated Data (AAD) associated with the JWE token. Per RFC 7516 §5.1 step 14, the AAD is the US-ASCII byte encoding of the base64url-encoded JWE protected header. This value is bound to the ciphertext by the AEAD algorithm and must match at decryption time. Returns the key management algorithm from the JWE protected header. This is the alg value that governs how the content encryption key (CEK) is protected. Returns the encrypted content of the JWE — the fourth component of the compact serialization (before the authentication tag).Returns the wrapped content encryption key (CEK), the second component of the JWE compact serialization. This value is decrypted using the recipient's key management key (per getAlgorithm()) to recover the CEK, which is then used to decrypt getCiphertext(). Returns the content encryption algorithm from the JWE protected header. This is the enc value that governs how the payload is encrypted.Returns the ephemeral public key from the JWE protected header (the epk JWK). The key is returned in X.509 SubjectPublicKeyInfo DER encoding, suitable for passing to standard key deserialization utilities.Returns the initialization vector used for content decryption — the third component of the JWE compact serialization.Returns the authentication tag — the fifth and final component of the JWE compact serialization. The tag is used by the AEAD algorithm to detect tampering with the ciphertext or AAD.Returns a string representation of the token suitable for debugging and logging. The output contains only metadata (algorithm identifiers and byte lengths) and never exposes the ephemeral public key, wrapped CEK, ciphertext, or authentication tag.
• Label Class: Provides methods to retrieve a custom label or to check if translation exists for a label in a specific language and namespace. Label names are dynamically resolved at run time, overriding the user’s current language if a translation exists for the requested language. You can’t access labels that are protected in a different namespace.Retrieve a custom label for the specified namespace and a default language setting.Retrieve a custom label for the specified namespace and language.Check if translation exists for a label and language in a namespace.
• Object Class: Contains methods that are implemented by all Apex types.Compares an object to the specified object and returns true if both are equal. Otherwise, returns false.Returns a hash code for the object.Returns a string that represents the object. The string includes the class name of which the object is an instance, the at (@) character, and the unsigned hexadecimal representation of the object’s hash code value.
• OrgLimit Class: Contains methods that provide the name, maximum value, and current value of an org limit.Returns the maximum allowed limit value.Returns the limit’s name.Returns the limit usage value. Returns the string representation of the org limit.
• OrgLimits Class: Contains methods that provide a list or map of all OrgLimit instances for Salesforce your org, such as SOAP API requests, Bulk API requests, and Streaming API limits.Returns a list of OrgLimit instances.Returns a map of all OrgLimit instances with the limit name as key.
• Queueable Interface: Enables the asynchronous execution of Apex jobs that can be monitored.Executes the queueable job.
• QueueableDuplicateSignature Class: Used in the AsyncOptions class to store the queueable job signature in the DuplicateSignature property.Returns the duplicate signature as a string value.
• QueueableDuplicateSignature.Builder Class: Build a unique signature for your queueable job using this inner builder class. The build() class method builds a QueueableDuplicateSignature object, with input from the addId(), addInteger(), and addString() methods. Use the DuplicateSignature property in the AsyncOptions class to store the queueable job signature. Enqueue your job by using the System.enqueueJob() with the AsyncOptions parameter. Adds an ID to build a unique signature for a queueable job. You can then enqueue the job by using the signature as the AsyncOptions parameter to System.enqueueJob(). Adds an integer to build a unique signature for a queueable job. You can then enqueue the job by using the signature as the AsyncOptions parameter to System.enqueueJob().Adds a string to build a unique signature for a queueable job. You can then enqueue the job by using the signature as the AsyncOptions parameter to System.enqueueJob(). Builds a unique signature for a queueable job. You can then enqueue the job by using the signature as the AsyncOptions parameter to System.enqueueJob().Gets the maximum size of the queueable job signature in bytes.Gets the remaining size of the queueable job signature in bytes, after subtracting what is already used by the signature from the maximum allowed number.Gets the size of the queueable job signature in bytes.
• Request Class: Contains methods to obtain the request ID and Quiddity value of the current Salesforce request.Returns the current Request object that contains the request ID and Quiddity value. Returns the Quiddity value of the current Request object.Returns the request ID of the current Request object.
• ResetPasswordResult Class: Represents the result of a password reset.Returns the password generated by the System.resetPassword method call.
• SObjectAccessDecision Class: Contains the results of a call to the Security.stripInaccessible method and methods to retrieve those results. Returns the indexes of sObjects that are modified by the stripInaccessible method.Returns a list of new sObjects that are identical to the source records, except that they are stripped of fields that fail the field-level security check for the current user.Returns a map of sObject types to their corresponding inaccessible fields. The map key is a string representation of the sObject type. The map value is a set of strings, which denote the fields names that are inaccessible.
• Security Class: Contains methods to securely implement Apex applications.Creates a list of sObjects from the source records, which are stripped of fields that fail the field-level security checks for the current user. The method also provides an option to enforce an object-level access check.Creates a list of sObjects from the source records, which are stripped of fields that fail the field-level security checks for the current user.Creates a list of sObjects from the source records, which are stripped of fields that fail field-level and object-level access checks. Apex enforces field-level security (FLS) and object permissions as per the specified permission set, in addition to the running user’s permissions.
• SoqlStubProvider Class: Contains a method to create a mock test class for handling SOQL query responses for Data 360 data model objects (DMOs). Defines a mocked response for a SOQL query executed against the specified SObject type.
• Trigger Class: Use the Trigger class to access run-time context information in a trigger, such as the type of trigger or the list of sObject records that the trigger operates on.
• UUID Class: Contains methods to randomly generate a version 4 universally unique identifier (UUID), compare UUIDs, and convert UUID instance to a string.Compares a UUID instance with the specified object and returns true if both are equal. Otherwise, returns false.Converts a 32 character hexadecimal string representation of a UUID to a UUID instance.Returns the hashcode corresponding to the UUID instance. A static method that randomly generates a version 4 UUID.Returns the string representation of the UUID instance.
• UserManagement Class: Contains methods to manage end users, for example, to register their verification methods, verify their identity, or remove their personal information.Makes a duplicate copy of the System.UserManagement object.Deregisters an identity verification method. Use this method to let users delete an existing verification method.Formats a mobile phone number for a user. Call this method to ensure that the phone number is formatted properly before updating a user’s mobile phone number.Invokes a verification challenge for passwordless login when creating custom (Visualforce) Login and Verify pages for customers and partners.Invokes a verification challenge for registering identity verification methods with a custom (Visualforce) page. Users can register either their email address or phone number.Invokes a verification challenge for self-registration when creating a custom (Visualforce) Verify page for Experience Cloud self-registration.Initiates a verification service for email, phone (SMS), and the Salesforce Authenticator verification methods.Initiates a verification service for email, phone (SMS), and the Salesforce Authenticator verification methods.Scrambles users’ data on their request when they no longer want their personal data recognized in Salesforce. When you invoke the method for the user, the data becomes anonymous, and you can never recover it. Use this method to set the username to a specific value after it’s scrambled.Scrambles users’ data on their request when they no longer want their personal data recognized in Salesforce. When you invoke the method for the user, the data becomes anonymous, and you can never recover it.Registers an identity verification method. Verification methods can be a time-based one-time password (TOTP), email or text verification code, Salesforce Authenticator, or U2F-compatible security key. End users register verification methods for themselves.Send an email message to a user’s email address for verification. The message contains a verification link (URL) that the user clicks to verify the email address later on. You can send email verifications in bulk.Completes a verification challenge during a passwordless login that uses a custom Verify page (Visualforce only). If the user who is trying to log in enters the verification code successfully, the user is logged in.Completes registering a user’s email address or phone number as a verification method when customizing the identity verification process.Completes a verification challenge when creating a custom (Visualforce) Verify page for Experience Cloud site self-registration. If the person who is attempting to register enters the verification code successfully, the user is created and logged in.Completes the verification service for email, phone (SMS), Salesforce Authenticator, password, or time-based one-time password (TOTP) verification methods.
• WebServiceCallout Class: Enables making callouts to SOAP operations on an external Web service. This class is used in the Apex stub class that is auto-generated from a WSDL.Invokes an external SOAP web service operation based on an Apex class that is auto-generated from a WSDL.
• EventBus Class: Contains methods for publishing platform events.Returns the event UUID, which identifies a published event message.Publishes the given platform event.Publishes the given list of platform events.Publishes the given platform event using the specified callback. To track asynchronous publish failures, you can implement an Apex publish callback.Publishes the given list of platform events using the specified callback. To track asynchronous publish failures, you can implement an Apex publish callback.Publishes the given platform event.Publishes the given list of platform events.Publishes the given platform event using the specified callback. To track asynchronous publish failures, you can implement an Apex publish callback.Publishes the given list of platform events using the specified callback. To track asynchronous publish failures, you can implement an Apex publish callback.
• Event Class: Contains event information that the evaluate method uses to evaluate a transaction security policy.Creates an instance of the TxnSecurity.Event class.Specifies the action being taken on the resource for an Entity event. For example, a Login IP resource for an Entity event could have an action of create. The action attribute is not used by any other event type.Contains data used by actions. For example, data for a login event includes the login history ID. Returns a map whose keys are the type of event data, like SourceIp.The ID of any entity associated with the event. For example, the entityId of a DataExport event for an Account object contains the Account ID.The name of the object the event acts on.The ID of the Salesforce org where the event occurred.The type of resource for the event. For example, an AccessResource event could have a Connected Application as a resource type. Not all event types have resources.The time the event occurred.Identifies the user that caused the event.
• ConnectorTestUtil Class: Enables developers to write Apex test classes for connectors used by the connected app provisioning solution. This class simulates provisioning for the associated app.Creates an instance of a connected app to simulate provisioning.
• UserProvisioningPlugin Class: The UserProvisioningPlugin base class implements Process.Plugin for programmatic customization of the user provisioning process for connected apps. Use this method to add more input and output parameters to those defined in the base class.Returns a Process.PluginDescribeResult object that describes this method call.Returns the name of the class implementing the plugin.Primary method that the system invokes when the class that implements the interface is instantiated.
• DataRow Class: Contains information about one item in a picklist used in a Lightning component on a Lightning page.Creates an instance of the VisualEditor.DataRow class using the specified label, value, and selected option.Creates an instance of the VisualEditor.DataRow class using the specified label and value.Makes a duplicate copy of the VisualEditor.DataRow object.Compares the current VisualEditor.DataRow object to the specified one. Returns an integer value that is the result of the comparison.Returns the user-facing label of the picklist item.Returns the value of the picklist item.Returns the state of the picklist item, indicating whether it’s selected or not.
• DesignTimePageContext Class: A class that provides context information about a Lightning page. It can be used to help define the values of a picklist in a Lightning component on a Lightning page based on the page’s type and the object with which it’s associated.The API name of the sObject that a Lightning page is associated with, such as Account, Contact, or Custom_object__c. entityName is available only for object pages, and not all Lightning pages are associated with objects.The type of Lightning page, such as HomePage, AppPage, or RecordPage.Makes a duplicate copy of the VisualEditor.DesignTimePageContext object.
• DynamicPickList Class: An abstract class, used to display the values of a picklist in a Lightning component on a Lightning page.Makes a duplicate copy of the VisualEditor.DynamicPicklist object.Returns the picklist item that is set as the default value for the picklist.Returns the user-facing label for a specified picklist value.Returns the list of picklist item values.Returns the valid state of the picklist item’s value. A picklist value is considered valid if it’s a part of any VisualEditor.DataRow in the VisualEditor.DynamicPickListRows returned by getValues().
• DynamicPickListRows Class: Contains a list of picklist items in a Lightning component on a Lightning page.Creates an instance of the VisualEditor.DynamicPickListRows class using the specified parameters.Creates an instance of the VisualEditor.DynamicPickListRows class using the specified parameter.Creates an instance of the VisualEditor.DynamicPickListRows class. You can then add rows by using the class’s addRow or addAllRows methods.Adds a list of picklist items to a dynamic picklist rendered in a Lightning component on a Lightning page.Adds a single picklist item to a dynamic picklist rendered in a Lightning component on a Lightning page.Makes a duplicate copy of the VisualEditor.DynamicPickListRows object.Returns a Boolean value indicating whether all values of the picklist are included when a user does a type-ahead search query (true) or only those values initially displayed when the list is clicked on (false).Returns a picklist element stored at the specified index.Returns a list of picklist items.Sets the value indicating whether all values of the picklist are included when a user does a type-ahead search query (true) or only those values initially displayed when the list is clicked on (false).Returns the size of the list of VisualEditor.DynamicPickListRows.Sorts the list of VisualEditor.DynamicPickListRows.
• Templates Class: The Templates class provides methods for retrieving CRM Analytics template collections, individual templates, and template configurations.Gets a CRM Analytics template by the specified ID or API name. The returned template is a map of the template JSON attributes as name/value pairs.Gets the CRM Analytics template configuration by the specified ID or API name. The returned template configuration is a map of the JSON attributes as name/value pairs.Get a filtered collection of CRM Analytics templates using search options.Gets all CRM Analytics templates.
• TemplatesSearchOptions Class: The TemplatesSearchOptions class provides optional properties to filter the template collection.Specifies the Connect API filter group for CRM Analytics template search options.Specifies the template visibility option to filter the CRM Analytics template collection by.Sets the template type to filter the CRM Analytics template collection by.
• AppMenu Class: Contains methods to set the appearance of apps in the App Launcher.Shows or hides specific apps in the App Launcher.Sets the organization-wide default sort order for the App Launcher based on a List of app menu item IDs in the desired order.Sets an individual user’s default sort order for the App Launcher based on a List of app menu item IDs in the desired order.
• ChangePasswordController Class: This class and its methods are for internal use only.
• CommunityLogoController Class: This class and its methods are for internal use only.
• EmployeeLoginLinkController Class: This class and its methods are for internal use only.
• ForgotPasswordController Class: This class and its methods are for internal use only.
• IdentityHeaderController Class: This class and its methods are for internal use only.
• LoginFormController Class: This class and its methods are for internal use only.
• SelfRegisterController Class: This class and its methods are for internal use only.
• SocialLoginController Class: This class and its methods are for internal use only.
• Org Class: Use the Cache.Org class to add, retrieve, and manage values in the org cache. Unlike the session cache, the org cache is not tied to any session and is available to the organization across requests and to all users.The Org class provides a constant that you can use when setting the time-to-live (TTL) value.Returns true if the org cache contains a cached value corresponding to the specified key.Returns true if the org cache contains values for the specified key entries.Returns true if the org cache contains values for a specified set of keys.Returns the cached value corresponding to the specified key from the org cache.Returns the cached value corresponding to the specified key from the org cache. Use this method if your cached value is a class that implements the CacheBuilder interface. Returns the cached values corresponding to the specified set of keys from the org cache. Returns the average item size of all the keys fetched from the org cache, in bytes.Returns the average time taken to get a key from the org cache, in nanoseconds.Deprecated and available only in API versions 49.0 and earlier. Returns the average item size for keys in the org cache, in bytes.Returns the percentage of org cache capacity that has been used.Returns a set of all keys that are stored in the org cache and visible to the invoking namespace. Returns the maximum item size of all the keys fetched from the org cache, in bytes. Returns the maximum time taken to get a key from the org cache, in nanoseconds.Deprecated and available only in API versions 49.0 and earlier. Returns the maximum item size for keys in the org cache, in bytes.Returns the miss rate in the org cache.Returns the name of the default cache partition.Returns the total number of keys in the org cache.Returns a partition from the org cache that corresponds to the specified partition name.Stores the specified key/value pair as a cached entry in the org cache. The put method can write only to the cache in your org’s namespace.Stores the specified key/value pair as a cached entry in the org cache and sets the cached value’s visibility.Stores the specified key/value pair as a cached entry in the org cache and sets the cached value’s lifetime.Stores the specified key/value pair as a cached entry in the org cache. This method also sets the cached value’s lifetime, visibility, and whether it can be overwritten by another namespace.Deletes the cached value corresponding to the specified key from the org cache.Deletes the cached value corresponding to the specified key from the org cache. Use this method if your cached value is a class that implements the CacheBuilder interface.
• OrgPartition Class: Contains methods to manage cache values in the org cache of a specific partition. Unlike the session cache, the org cache is not tied to any session. It’s available to the org across requests and to all users.
• Partition Class: Base class of Cache.OrgPartition and Cache.SessionPartition. Use the subclasses to manage the cache partition for org caches and session caches.Returns true if the cache partition contains a cached value corresponding to the specified key.Returns true if the cache partition contains values for a specified set of keys.Generates a fully qualified key from the passed-in key components. The format of the generated key string is namespace.partition.key.Generates a fully qualified partition name from the passed-in namespace and partition. The format of the generated partition string is namespace.partition.Returns the cached value corresponding to the specified key from the cache partition.Returns the cached values corresponding to the specified set of keys from the cache partition.Returns the cached value corresponding to the specified key from the partition cache. Use this method if your cached value is a class that implements the CacheBuilder interface. Returns the average item size of all the keys fetched from the partition, in bytes. Returns the average time taken to get a key from the partition, in nanoseconds.Deprecated and available only in API versions 49.0 and earlier. Returns the average item size for keys in the partition, in bytes.Returns the percentage of cache used of the total capacity for this partition.Returns a set of all keys that are stored in the cache partition and visible to the invoking namespace.Returns the maximum item size of all the keys fetched from the partition, in bytes.Returns the maximum time taken to get a key from the partition, in nanoseconds.Deprecated and available only in API versions 49.0 and earlier. Returns the maximum item size for keys in the partition, in bytes.Returns the miss rate in the partition.Returns the name of this cache partition.Returns the total number of keys in the partition.Returns true if the Salesforce session is available. Only applies to Cache.SessionPartition. The session cache isn’t available when an active session isn’t present, such as in asynchronous Apex or code called by asynchronous Apex. For example, if batch Apex causes an Apex trigger to execute, the session cache isn’t available in the trigger because the trigger runs in asynchronous context.Stores the specified key/value pair as a cached entry in the cache partition. The put method can write only to the cache in your org’s namespace.Stores the specified key/value pair as a cached entry in the cache partition and sets the cached value’s visibility.Stores the specified key/value pair as a cached entry in the cache partition and sets the cached value’s lifetime.Stores the specified key/value pair as a cached entry in the cache partition. This method also sets the cached value’s lifetime, visibility, and whether it can be overwritten by another namespace. Deletes the cached value corresponding to the specified key from this cache partition.Deletes the cached value corresponding to the specified key from the partition cache. Use this method if your cached value is a class that implements the CacheBuilder interface.Validates that the specified class implements the CacheBuilder interface.Validates a cache key. This method throws a Cache.InvalidParamException if the key is not valid. A valid key is not null and contains alphanumeric characters.Validates a cache key and ensures that the cache value is non-null. This method throws a Cache.InvalidParamException if the key or value is not valid. A valid key is not null and contains alphanumeric characters.Validates the specified cache keys. This method throws a Cache.InvalidParamException if the key is not valid. A valid key is not null and contains alphanumeric characters.Validates the partition name — for example, that it is not null.
• Session Class: Use the Cache.Session class to add, retrieve, and manage values in the session cache. The session cache is active as long as the user’s Salesforce session is valid (the user is logged in, and the session is not expired).The Session class provides a constant that you can use when setting the time-to-live (TTL) value.Returns true if the session cache contains a cached value corresponding to the specified key.Returns true if the cache contains values for a specified set of keys.Returns the cached value corresponding to the specified key from the session cache.Returns the cached values corresponding to the specified set of keys from the session cache.Returns the cached value corresponding to the specified key from the session cache. Use this method if your cached value is a class that implements the CacheBuilder interface.Returns the average item size of all the keys fetched from the session cache, in bytes.Returns the average time taken to get a key from the session cache, in nanoseconds.Deprecated and available only in API versions 49.0 and earlier. Returns the average item size for keys in the session cache, in bytes.Returns the percentage of session cache capacity that has been used.Returns all keys that are stored in the session cache and visible to the invoking namespace.Returns the maximum item size of all the keys fetched from the session cache, in bytes.Returns the maximum time taken to get a key from the session cache, in nanoseconds.Deprecated and available only in API versions 49.0 and earlier. Returns the maximum item size for keys in the session cache, in bytes.Returns the miss rate in the session cache.Returns the name of the default cache partition.Returns the total number of keys in the session cache.Returns a partition from the session cache that corresponds to the specified partition name.Returns true if the session cache is available for use. The session cache isn’t available when an active session isn’t present, such as in asynchronous Apex or code called by asynchronous Apex. For example, if batch Apex causes an Apex trigger to execute, the session cache isn’t available in the trigger because the trigger runs in asynchronous context.Stores the specified key/value pair as a cached entry in the session cache. The put method can write only to the cache in your org’s namespace.Stores the specified key/value pair as a cached entry in the session cache and sets the cached value’s visibility.Stores the specified key/value pair as a cached entry in the session cache and sets the cached value’s lifetime.Stores the specified key/value pair as a cached entry in the session cache. This method also sets the cached value’s lifetime, visibility, and whether it can be overwritten by another namespace.Deletes the cached value corresponding to the specified key from the session cache.Deletes the cached value corresponding to the specified key from the session cache. Use this method if your cached value is a class that implements the CacheBuilder interface.
• SessionPartition Class: Contains methods to manage cache values in the session cache of a specific partition.
• Test Class: Contains methods for automated testing of your Canvas classes.
• AbstractResponse Class: Contains the normalized response fields from payment gateways that are common to all the other gateway responses.Sets the AVS (address verification system) result code information that the gateway returned. Maximum length of 64 characters.Sets the date that the transaction occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the payment request. Maximum length of 255 characters.Sets a gateway-specific result code. The code may be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.Sets the retry category returned by the payment gateway for the failed payment in a batch flow.Sets the retry decision.
• AbstractTransactionResponse Class: Abstract class for storing normalized information sent from payment gateways about a payment transaction. Holds the common response fields sent from payment gateways for authorization, sale, capture, and refund transactions.Sets the transaction amount. Must be a non-negative value.Sets the AVS (address verification system) result code that the gateway returned. Maximum length of 64 characters.Sets the date that the notification occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the notification request. Maximum length of 255 characters.Sets the payment gateway’s reference details.Sets the payment gateway’s reference number.Sets a gateway-specific result code. You can map the result code to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets the Salesforce-specific result code information.
• AddressRequest Class: Contains address request data that is sent to a gateway adapter during a service call.Constructs a sample address. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.City of the payment method address.Company name of the payment method address.Country for the payment method address.Postal code for the payment method address.State for the payment method address.Street for the payment method address.Maintains the integrity of lists of type AddressRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals method in Java.Maintains the integrity of lists of type AddressRequest.Converts a date to a string.
• AlternativePaymentMethodRequest Class: The class contains information about the alternative payment method that are required for a gateway to process the request.Creates a new instance of the CommercePayments.AlternativePaymentMethodRequest class.Salesforce account ID to which this payment method is linked.Email address of the card holder.A unique, alphanumeric ID, that a payment gateway generates when it first processes a payment.Information about the gateway token.Name that you assign to the PaymentMethod object.Maintains the integrity of lists of type AlternativePaymentMethodRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.Maintains the integrity of lists of type AlternativePaymentMethodRequest by determining the uniqueness of the external object records in a list.Converts a date to a string.
• AlternativePaymentMethodResponse Class: The class contains the response details of the alternative payment method.Sets the ID of the Salesforce payments account to which the payment method is linked.Sets the notes about the payment method added by users.Sets the email ID of the card holder.Sets the token ID that a payment gateway generates when it first processes a payment.Sets the details about the payment gateway token.Sets the name that is assigned to the PaymentMethod object.
• AuditParamsRequest: AuditParamsRequest is used for audit parameters in a transaction request. This is an abstract request class that is extended by the BaseRequest class.This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Email of the client that initiated the request.The customer’s IP address. Gateways often use this data in risk checks.Mac address of the customer’s device. Gateways often use this data in risk checks.Phone number of the client that initiated the request.
• AuthApiPaymentMethodRequest Class: Sends information about a payment method to a gateway adapter during an authorization service call.Constructs a sample cardPaymentMethodRequest. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Constructor for AuthApiPaymentMethodRequest.The card payment method object used in a payment method request.
• AuthorizationRequest Class: Sends information about an authorization request to a gateway adapter during a service call. This class extends the BaseRequest class and inherits all its methods. Constructor for building the amount in an authorization request. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.The customer account where the authorization is performed.The total amount of the authorization. Can be positive or negative.Comments about the authorization. Users can enter comments to provide additional information.The ISO currency code for the authorization request.The payment method used to process the authorization in the authorization request.Payment method data used in the authorize payment request. Maintains the integrity of lists of type AuthorizationRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.Maintains the integrity of lists of type AuthorizationRequest by determining the uniqueness of the external object in a list.Converts a date to a string.
• AuthorizationResponse Class: Response sent by the payment gateway adapter for an authorization service.Sets the amount of the authorization. Must be a non-zero value.Indicates whether the gateway response is received asynchronously (true) or not (false). When set to true, the authorize payment method remains in a pending state until the async notification is received.Sets the expiration date of the authorization request.Sets the authorization code that the gateway returned. Maximum length of 64 characters.Sets the AVS (address verification system) result code information that the gateway returned. Maximum length of 64 characters.Sets the date that the authorization occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the authorization request. Maximum length of 255 characters.Stores data that you can use for subsequent authorizations. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML. Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters.Sets a gateway-specific result code. The code can be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets information from the gateway about the tokenized payment method.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.
• AuthorizationReversalRequest Class: Sends information about an authorization reversal request to a gateway adapter during a service call.Constructor for building the amount in an authorization reversal request. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.References the customer account for the transaction where the authorization reversal was performed.The total amount of the authorization reversal request. Can be positive or negative.References the payment authorization to be reversed.Maintains the integrity of lists of type AuthorizationReversalRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.Maintains the integrity of lists of type AuthorizationReversalRequest by determining the uniqueness of the external object in a list.Converts a date to a string.
• AuthorizationReversalResponse Class: Response sent by the payment gateway following a payment authorization reversal service.Contains the amount of the authorization reversal. Must be a non-zero value.Sets the AVS (Address Verification System) result code that the gateway returned. Maximum length of 64 characters.Sets the date that the authorization reversal request occurred in the payment gateway. Some gateways don't send this value.Sets error messages that the gateway returned for the authorization reversal request. Maximum length of 255 characters.Stores data that you can use for subsequent authorizations. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML. Sets a unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters.Sets a gateway-specific result code. The code can be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.
• BankPaymentMethodRequest Class: Sends data related to a bank payment method to a gateway adapter during a service call.The first name of the account holder for the bank payment method.The last name of the account holder for the bank payment method.The name of the account holder for the bank payment method.The type of the account holder.Salesforce Payments account ID associated with the bank payment method.The unique account number for the bank account.The type for the bank account.Indicates whether a token for recurring payments is being requested (true) or not (false). The token enables the payment method to be used for recurring payments.The routing number is a unique nine-digit code that identifies the bank.The bank type associated with the bank payment method.Additional details about the bank account.The email address of the bank account holder.Authorization from the account holder to debit their payment method.The nick name of the account holder.The three-letter code that identifies the type of electronic payment transaction being processed within the Automated Clearing House (ACH) network.Maintains the integrity of lists of type BankPaymentMethodRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.Maintains the integrity of lists of type BankPaymentMethodRequest.Converts a date to a string.
• BankPaymentMethodResponse Class: This class contains information about the bank payment method response. The gateway adapter reads the gateway response and generates a BankPaymentMethodResponse, populating the required fields to create a bank payment method.Sets the account holder type for the bank payment method.Sets the Payments account ID associated with the bank payment method.Sets the account type for the bank payment method.Sets the unique nine-digit code that identifies the bank code for the bank payment method.Sets the bank name for the bank payment method.Sets the bank type for the bank payment method.Sets any additional details about the bank account.Sets the email address of the bank account holder.Sets the gateway token value that the gateway returned.Sets any additional information that the gateway returned about the payment token.Sets the last four digits of the bank account number.Sets the name of the account holder for the bank payment method.Sets the saved payment method ID for the bank account holder.Sets the code that identifies the type of electronic payment transaction being processed within the Automated Clearing House (ACH) network.
• BaseApiPaymentMethodRequest Class: Abstract class used to send information about a payment method to a gateway adapter during a service call.Constructs a payment method. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.The payment method’s address. ID of the payment method request.ID of the payment method type.Indicates whether the payment method is saved as a record in Salesforce for future use.Maintains the integrity of lists of type BaseApiPaymentMethodRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals method in Java.Maintains the integrity of lists of type BaseApiPaymentMethodRequest by determining the uniqueness of the external object records in a list.Converts a date to a string.
• BaseNotification Class: Abstract class for storing notification information sent from payment gateways.Sets the transaction amount. Must be a non-negative value.Sets the AVS (address verification system) result code that the gateway returned. Maximum length of 64 characters.Sets the date that the notification occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the notification request. Maximum length of 255 characters.Sets the payment gateway’s reference details.Sets the payment gateway’s reference number.Sets a gateway-specific result code. The code can be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets the ID of the notification sent by the gateway.Sets the information about the Salesforce-specific result code used to match a result code from a payment gateway.Sets the status of the notification sent by the gateway.
• BasePaymentMethodRequest Class: Abstract class for storing information about payment methods.Maintains the integrity of lists of type BasePaymentMethodRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.Maintains the integrity of lists of type BasePaymentMethodRequest by determining the uniqueness of the external object records in a list.Converts a date to a string.
• BaseRequest Class: BaseRequest is extended by all the request classes.Used for testing.
• CaptureNotification Class: When a payment gateway sends a notification for a capture transaction, the payment gateway adapter creates the CaptureNotification object to store information about the notification.Sets the transaction amount. Must be a non-negative value.Sets the AVS (address verification system) result code that the gateway returned. Maximum length of 64 characters.Sets the date that the transaction occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the payment request. Maximum length of 255 characters.Sets additional data that you can use for subsequent transactions. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML.Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters.Sets a gateway-specific result code. The code can be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a gateway returned. Maximum length of 1000 characters.Sets the ID of a notification sent by the payment gateway.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.Sets the notification status to the same value that was sent by the gateway.
• CaptureRequest Class: Represents a capture request. This class extends the BaseRequest class and inherits all its methods.This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Account ID value. References an account record.Amount of currency that needs to be captured.ID value that references a PaymentAuthorization.
• CaptureResponse Class: The payment gateway adapter sends this response for the capture request type. This class extends AbstractResponse and inherits its methods.Sets the transaction amount. Indicates whether the payment gateway adapter used in the payment capture was asynchronous (True) or synchronous (False). Sets the payment gateway’s AVS (address verification system) code.Sets the payment gateway’s date.Sets information or messages that the gateway returned.Sets the payment gateway’s reference details.Sets the payment gateway’s reference number.Sets the payment gateway’s result code.Sets the payment gateway’s result code description.Sets Salesforce result code information.
• CardPaymentMethodRequest Class: Sends data related to a card payment method to a gateway adapter during a service call.Sets the cardCategory value for the card payment method request.Customer account for this payment method.Indicates whether a token is being requested so that the payment method can be used for recurring payments.Indicates whether a card payment method is for a credit card or debit card.The first name of the cardholder for the card payment method.The last name of the cardholder for the card payment method.Full name of the cardholder on the card payment method.System-defined unique ID for the card payment method.Defines the credit card bank. Possible values are AmericanExpress, DinersClub, JCB, Maestro, MasterCard, andVisa.The card security code for the credit or debit card on a card payment method.Email address of the cardholder for the credit or debit card on a card payment method.Expiration month for the credit or debit card on a card payment method.Expiration year of the credit or debit card for the card payment method.Input field for the card type. This field doesn’t store the card type directly, but instead populates CardBin, LastFour, and DisplayCardNumber based on the value entered in inputCardType.The credit or debit card becomes valid on the first day of the startMonth in the startYearYear during which the credit or debit card becomes valid.Maintains the integrity of lists of type CardPaymentMethodRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.Maintains the integrity of lists of type CardPaymentMethodRequest.Converts a date to a string.
• CardPaymentMethodResponse Class: This class contains details about the card payment method.Sets the Salesforce payments account to which this payment method is linked.Sets whether a token for recurring payments is being requested or not.Sets the card Bank Identification Number (BIN).Sets the card category.Sets the first name of the card holder.Sets the last name of the card holder.Sets the name of the card holder.Sets the last four digits of the card.Specifies the type of the credit card issuer.Sets the credit card issuer.Sets the notes added by a user for card payment.Sets the display card number.Sets the email address of the card holder.Sets the month of expiry of the card.Sets the year of expiry of the card.Sets the nickname of the card.Sets the month the card becomes active.Sets the year the card becomes active.
• CustomMetadataTypeInfo Class: Access information about custom metadata. The PaymentGatewayAdapter can send CustomMetadataTypeInfo to transaction requests through the response object’s SalesforceResultCodeInfo.Constructor for providing custom metadata type information.
• EnhancedPaymentDataInput Class: Sends enhanced payment data, including Level 2 and Level 3 fields, to the gateway adapter as part of the service call.Map of gateway-specific or custom fields. Discount amount.The total amount charged as duty or import or export tariffs on the transaction.Invoice number associated with the payment.Collection of individual line items associated with the payment.Customer reference or identifier. Sales tax amount.Origin postal code.Destination country code.Destination postal code.Shipping or freight amount.Percentage rate of tax applied to the transaction or line item. Total tax amount for the transaction. Maintains the integrity of lists of type EnhancedPaymentDataInput by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.Maintains the integrity of lists of type EnhancedPaymentDataInput.Converts a date to a string.
• GatewayErrorResponse Class: Use to respond with an error indication following errors from the PaymentGateway adapter, such as request-forbidden responses, custom validation errors, or expired API tokens.Constructor to create a GatewayErrorResponse object that accepts errorCode and errorMessage.
• GatewayNotificationResponse Class: When the payment gateway sends a notification to the payments platform, the platform responds with a GatewayNotificationResponse indicating whether the platform succeeded or failed at receiving the notification.Sets the body of the response to the gateway. Some gateways expect the payments platform to acknowledge the notification with a response regardless of whether the notification was accepted.Sets the HTTP status code sent to the gateway as part of the payments platform’s response notification.
• LineItemInput Class: Sends the list of individual line items associated with the payment to the gateway adapter.Map of additional attributes.Commodity code.Description of the product.Discount applied to the line item level.Specifies whether a discount was applied to the specific line item.Duty or tariff applied specifically to a item (not the whole order).Specifies if the line item amount is Gross (before discounts) or Net (after discounts). Line item identifier. Specify when multiple items are present.Total amount for that line item. Product or service name.Quantity purchased.Shipping or freight cost allocated to that line item. SKU or product code.Line-level tax amount.Tax percentage applied to that specific line item. Unit price.Unit of measure. For example, EA, HRS, and KG.Maintains the integrity of lists of type LineItemInput by determining the equality of external objects in a list. This method is dynamic and based on the equals method in Java.Maintains the integrity of lists of type LineItemInput.Converts a date to a string.
• NotificationClient Class: Communicates with the payment platform regarding the gateway’s notification.Stores the results of a notification request.
• NotificationSaveResult Class: Contains the result of the payment platform’s attempt to record data from the gateway’s notification.Gets the error message, if any, from the payment platform regarding its attempt to save the notification sent from the payment gateway.Gets the status code from the payment platform’s attempt to save the notification sent from the payment gateway.Gets the status of whether the payment platform successfully saved the notification sent from the payment gateway.
• PaymentGatewayContext Class: Wraps the information related to a payment request.Constructor to enable instance creation. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Returns the payment request object.Returns the payment request type.
• PaymentGatewayNotificationContext Class: Wraps the information related to a gateway notification.Returns the payment gateway’s notification request.
• PaymentGatewayNotificationRequest Class: Contains the notification request data from the gateway.Body of the notification request sent by the payment gateway.Gets HTTP headers from the notification request sent by the payment gateway.Stores the notification request body information from the payment gateway’s notification request.
• PaymentMethodDetailsResponse Class: This class contains the details about the payment method.Sets the alternative payment method details.Sets the details about the card payment method.
• PaymentMethodTokenizationRequest Class: Stores data about a request to tokenize a card payment method. The tokenization process occurs in the payment gateway. This process replaces sensitive customer data, such as a card number or CVV, with unique identification symbols. The symbols are used while the data is handled by Salesforce, the payment gateway, and the customer bank, allowing Salesforce to store the token without storing sensitive customer data.Payment gateway ID constructor used with paymentMethodTokenizationRequest. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.The following are constructors for PaymentMethodTokenizationRequest.The card payment method address to be tokenized.The bank payment method containing data to be tokenized.The card payment method containing data to be tokenized.Indicates whether the payment method to be tokenized is saved by the marchant (true) or not (false).Maintains the integrity of lists of type PaymentMethodTokenizationRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals method in Java.Maintains the integrity of lists of type PaymentMethodTokenizationRequest by determining the uniquness of the external object records in a list.Converts a date to a string.
• PaymentMethodTokenizationResponse Class: Gateway response sent by payment gateway adapters for the payment method tokenization request. The response includes the payment method’s token ID value.Sets the amount for payment tokenization. Can be positive, negative, or zero.Indicates whether the gateway response is received asynchronously (true) or not (false). When set to true, the saved payment method remains in a pending state until the async notification is received.Sets the bank name for payment tokenization.Sets the unique hash of the payment method that the gateway returned.Sets the customer reference number that the gateway returned.Sets the AVS (address verification system) result code information that the gateway returned. Maximum length of 64 characters.Sets the date that the tokenization occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the tokenization request. Maximum length of 255 characters.Sets any additional reference details that the gateway returned.Sets the reference number that the gateway returned.Sets a gateway-specific result code. The code may be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets the gateway token value that the gateway returned.Sets any additional information that the gateway returned about the payment token.Sets the value of the gatewayTokenEncrypted field on a CardPaymentMethod or DigitalWallet object.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.
• PaymentsHttp Class: Makes an HTTP request to start the interaction with the payment gateway.Sends an HttpRequest and returns the response.Initiates an HTTP request and response.
• PostAuthApiPaymentMethodRequest Class: Sends information about a payment method to a gateway adapter during a postauthorization service call.
• PostAuthorizationRequest Class: Sends information about a postauthorization request to a gateway adapter during a service call.
• PostAuthorizationResponse Class: Response sent by the payment gateway adapter for a postauthorization service.
• ReferencedRefundNotification Class: When a payment gateway sends a notification for a refund transaction, the payment gateway adapter creates the ReferencedRefundNotification object to store information about notification.Sets the transaction amount. Can be positive, negative, or zero.Sets the AVS (address verification system) result code information that the gateway returned. Maximum length of 64 characters.Sets the date that communication for the refund notification occurred with the payment gateway.Sets information or messages that the gateway returned.Sets the payment gateway’s reference details.Sets the payment gateway’s reference number.Sets the payment gateway’s result code.Sets the payment gateway’s result code description.Sets the ID of a notification sent by the payment gateway.Sets Salesforce result code information.Sets the notification status value on the notification object.
• ReferencedRefundRequest: Access information about the referenced refund requests. Extends the RefundRequest class.This constructor is intended for test usage and throws an exception if used outside of the Apex test context.References a payment object.References an account.References an amount.
• ReferencedRefundResponse Class: The payment gateway adapter sends this response for the ReferencedRefund request type.Sets the transaction amount. The value must be a postive number.Sets whether the payment capture or authorization is asynchronous (True) or synchronous (False). If True, then the payment refund record created has a status of Pending.Sets the payment gateway’s address verification system (AVS) code.Sets the payment gateway’s date.Sets information or messages that the gateway returned.Sets the payment gateway’s reference details.Sets the payment gateway’s reference number.Sets the payment gateway’s result code.Sets the payment gateway’s result code description.Set the Salesforce result code info.
• RefundRequest Class: Sends data related to a refund to the payment gateway adapter.Maintains the integrity of lists of type RefundRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals method in Java.Maintains the integrity of lists of type RefundRequest by determining the uniqueness of the external object records in a list.
• SaleApiPaymentMethodRequest Class: Sends data related to a card payment method to a gateway adapter during a sale service call.Sends data related to a card payment method to a gateway adapter during a sale service call.Constructor for building a sale payment method request. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Contains details of the card used in a payment method.Contains details of the standard entry class code used in a payment method.Maintains the integrity of lists of type SaleApiPaymentMethodRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals method in Java.Maintains the integrity of lists of type SaleApiPaymentMethodRequest by determining the uniqueness of the external object records in a list.Converts a date to a string.
• SaleNotification Class: When a payment gateway sends a notification for a sale payment, the payment gateway adapter creates the SaleNotification object to store information about notification.Sets the amount for the sale payment.Sets the AVS (address verification system) result code information that the gateway returned. Maximum length of 64 characters.Sets the date that the sale occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the sale request. Maximum length of 255 characters.Sets additional data that you can use for the sale payment. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML.Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters.Sets a gateway-specific result code. The code may be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets the ID of a notification sent by the payment gateway.Sets the retry category returned by the payment gateway for the failed payment.Sets the retry decision.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.Sets the notification status value on the notification object.
• SaleRequest Class: Stores information about a sales request.Constructor for defining an amount for the sale request. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Customer account ID for the sale request.Amount of the sale request. Can be positive only.Additional information about the sale request.Currency code for the sale request.Represents enhanced payment data, including Level 2 and Level 3 fields.ID of the source that initiated the payment.Payment method used in the sale request.Payment method data used in the sale request.Indicates whether the sale request is submitted by the marchant (true) or not (false).Compares this object with the specified object and returns true if both objects are equal; otherwise, returns false.Maintains the integrity of lists of type SaleRequest by determining the uniqueness of the external object records in a list.Converts a date to a string.
• SaleResponse Class: Response sent by payment gateway adapters for a sales service.Sets the transaction amount. Must be a non-negative value.Indicates whether the gateway response is received asynchronously (true) or not (false). When set to true, the sale payment record remains in a pending state until the async notification is received.Sets the AVS (address verification system) result code information that the gateway returned. Maximum length of 64 characters.Sets the date that the sale occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the sale request. Maximum length of 255 characters.Sets additional data that you can use for subsequent sales. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML. Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters.Sets a gateway-specific result code. The code may be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets information from the gateway about the tokenized payment method.Sets the retry category returned by the payment gateway for the failed payment for a batch flow.Sets the retry decision.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.
• SalesforceResultCodeInfo: Stores Salesforce result code information from payment gateway adapters.Constructor for providing the customMetadataTypeInfo for the result of the transaction.Constructor that provides the salesforceResultCode for the transaction result.
• TokenizeNotification Class: When a payment gateway sends a notification for a payment method tokenization, the payment gateway adapter creates the TokenizeNotification object to store information about notification.Sets the amount.Sets the AVS (address verification system) result code information that the gateway returned. Maximum length of 64 characters.Sets the date that the sale occurred. Some gateways don’t send this value.Sets error messages that the gateway returned for the sale request. Maximum length of 255 characters.Sets additional data that you can use for payment tokenization. You can use any data that isn’t normalized in financial entities. This field has a maximum length of 1000 characters and can store data as JSON or XML.Sets the unique gateway reference number for the transaction that the gateway returned. Maximum length of 255 characters.Sets a gateway-specific result code. The code may be mapped to a Salesforce-specific result code. Maximum length of 64 characters.Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.Sets the gateway token that the gateway returned.Sets an unencrypted unique token ID generated by the payment gateway to represent the saved payment method. Set the value of the gatewayTokenEncrypted field on a SavedPaymentMethod object.Sets the ID of a notification sent by the payment gateway.Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.Sets the notification status value on the notification object.
• AbstractTransactionResponse Class: Abstract class that contains methods for setting tax fields based on the external tax provider's response. Response classes that extend AbstractTransactionResponse inherit these methods.Learn more about the methods for AbstractTransactionResponse class.Uses an instance of AddressesResponse to set the values of tax address fields.Uses an instance of AmountDetailsResponse to set tax amount fields such as exemption amount and tax amount.Sets the currencyIsoCode field.Uses an instance of CustomTaxAttributesResponse class to include additional attributes in the tax response at the header level.Sets the Description field.Sets the DocumentCode field. Document codes are often used to reference tax documents that the external tax engine uses in the tax calculation process. Document code acts as a unique link to chain-related transactions, such as amendment or refunds.Sets the EffectiveDate field. Effective Date fields are optional fields that store the date that a transaction takes effect. We provide these fields only for recordkeeping purposes – for example, if you must report an effective date to an external general ledger system. Salesforce doesn't use them to calculate any tax or payment values.Uses an instance of the LineItemResponse class to set a list of line items. Each line item represents an item sent to an external tax engine for tax calculation.Sets the ReferenceDocumentCode field. Use this field to store the code of an additional document used in the tax calculation process. For example, use this field in case of a refund for a previously taxed purchase.Sets the ID of a reference entity. In Commerce Tax, a reference entity represents a record related to the items sent to the external tax engine for tax calculation. For example, if you sent order items for tax calculation, you could define the parent order as the reference entity.Sets the TaxTransactionId field using the ID of a tax transaction record. In Commerce Tax, a tax transaction record stores information about a specific tax calculation process.Sets the TransactionDate field.
• AddressResponse Class: Contains a location code sent from the external tax engine.Learn more about the available methods with the AddressResponse class.Sets the value of a LocationCode field.
• AddressesResponse Class: Sets the tax address fields based on a response from the external tax engine. Contains setter methods for the Ship From, Ship To, and Sold To addresses.Learn more about the methods for AddressesResponse class.Sets the value of a ShipFrom address field.Sets the value of a ShipTo address field.Sets the value of a SoldTo address field.
• AmountDetailsResponse Class: Sets tax amount fields based on a response from the external tax engine.Learn more about the methods available from the AmountDetailsResponse class.Sets the value of the ExemptAmount field.Sets the value of the TaxAmount field.Sets the value of the TotalAmount field.Sets the value of the TotalAmountWithTax field.
• CalculateTaxRequest Class: Represents a request to an external tax engine to calculate tax. Extends the TaxTransactionRequest class and is the top-level request class.Learn more about the constructors that are available with the CalculateTaxRequest class. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.This constructor is intended for test usage only and throws an exception if used outside of the Apex test context.Learn more about the available properties with the CalculateTaxRequest class.Indicates whether the tax calculation has to be committed or reported to government authorities.Indicates whether header tax is enabled in the tax engine (true) or not (false).Indicates whether to void the tax transaction associated with a document that's mentioned in the referenceDocumentCode property value with taxType property value set to Actual and isCommit property value set to true.Shows whether the tax transaction is for a credit or debit transaction.Shows whether the tax calculation is for estimated or actual tax wherein only actual tax can be submitted.Learn more about the available methods with the CalculateTaxRequest class.Maintains the integrity of lists of type CalculateTaxRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals() method in Java.Maintains the integrity of lists of type CalculateTaxRequest by determining the uniqueness of the external object records in a list.Converts a value to a string.
• CalculateTaxResponse Class: Sets the values of the tax transaction following a response from the external tax engine. Extends the AbstractTransactionResponse class and is the top-level response class.Learn more about the available methods with the CalculateTaxResponse class.Sets the value of the Addresses field using the addresses contained in an instance of the AddressesResponse class.Sets the value of the AmountDetails field using an instance of AmountDetailsResponse.Sets the value of the CurrencyIsoCode field of the CalculateTaxResponse object.Sets the value of the Description field of the CalculateTaxResponse object.Sets the value of the DocumentCode field of the CalculateTaxResponse object.Sets the value of the EffectiveDate field of the CalculateTaxResponse object.Sets the value of the LineItems field of the CalculateTaxResponse object.Sets the value of the ReferenceDocumentCode field of the CalculateTaxResponse object.Sets the value of the ReferenceEntityId field of the CalculateTaxResponse object.Sets the value of the Status field of the CalculateTaxResponse object.Sets the value of the StatusDescription field of the CalculateTaxResponse object.Sets the value of the TaxTransactionId field of the CalculateTaxResponse object.Sets the value of the TaxTransactionType field of the CalculateTaxResponse object.Sets the value of the TaxType field of the CalculateTaxResponse object.Sets the value of the TransactionDate field of the CalculateTaxResponse object.
• CustomTaxAttributesResponse Class: Sets additional data or custom attributes in the tax response.Learn more about the available constructors with the CustomTaxAttributesResponse class.Constructor to set additional data or custom attributes in the tax response.Learn more about the available methods with the CustomTaxAttributesResponse class.Sets additional data or custom attributes in the tax response.
• ErrorResponse Class: Use to respond with an error after receiving errors from the PaymentGatewayAdapter methods of the CommercePayments namespace, such as request-forbidden responses, custom validation errors, or expired API tokens.Learn more about the available constructors with the ErrorResponse class.Constructor to initialize an ErrorResponse object from the result code, error code, and error message sent from the tax engine.
• HeaderTaxAddressesRequest Class: Captures the address values that are applicable for the quote or order transaction.Learn more about the constructors available with the HeaderTaxAddressesRequest class.Constructor for initializing the required addresses of the tax addresses request such as the ship from, ship to, sold to, and bill to addresses. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Learn more about the available properties with the HeaderTaxAddressesRequest class.Specifies the billTo address for a line item on which tax was calculated.Specifies the shipFrom address for a line item on which tax was calculated.Specifies the shipTo address for a line item on which tax was calculated.Specifies the soldTo address for a line item on which tax was calculated.Address used by the tax engine when calculating tax for a line item.Learn more about the available methods with the HeaderTaxAddressesRequest class.Maintains the integrity of lists of type HeaderTaxAddressesRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals() method in Java.Maintains the integrity of lists of type TaxAddressesRequest by determining the uniqueness of the external objects in a list.Converts a value to a string.
• ImpositionResponse Class: Stores details of tax impositions from the external tax engine.Learn more about the available methods with the ImpositionResponse class.Sets the ID field of the ImpositionResponse class.Sets the Name field of the ImpositionResponse class.Sets the SubType field of the ImpositionResponse class.Sets the Type field of the ImpositionResponse class.
• JurisdictionResponse Class: Stores details from the external tax engine about the tax jurisdiction used in the tax calculation process. A tax jurisdiction represents a government entity that collects tax.Learn more about the available methods with the JurisdictionResponse class.Sets the Country field of the JurisdictionResponse class.Sets the ID field of the JurisdictionResponse class.Sets the Level field of the JurisdictionResponse class.Sets the Name field of the JurisdictionResponse class.Sets the Region value of the JurisdictionResponse class.Sets the StateAssignedNumber field of the JurisdictionResponse class.
• LineItemResponse Class: Response class that stores details of a list of one or more line items on which the tax engine has calculated tax.Learn more about the available methods with the LineItemResponse class.Sets the Addresses field on the LineItemResponse using an instance of AddressesResponse class.Sets the Amount Details field on the LineItemResponse using an instance of AmountDetails.Uses an instance of CustomTaxAttributesResponse class to include additional attributes in the tax response at line item level.Sets the EffectiveDate field on the LineItemResponse class. Effective Date fields are optional fields that store the date that a transaction takes effect. We provide these fields only for recordkeeping purposes – for example, if you must report an effective date to an external general ledger system. Salesforce doesn't use them to calculate any tax or payment values.Sets the IsTaxable field on the LineItemResponse class.Sets the LineNumber field on the LineItemResponse class.Sets the ProductCode field on the LineItemResponse class.Sets the Quantity field on the LineItemResponse class.Sets the TaxCode field on the LineItemResponse.Sets the Taxes field on a LineItemResponse.
• LineTaxAddressesRequest Class: Stores details of the addresses applied per line item in a tax calculation request.Learn more about the constructors available with the LineTaxAddressesRequest class.Constructor for initializing the required addresses for a line item of the tax addresses request such as the ship to, ship from, and bill to addresses. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Learn more about the available properties with the LineTaxAddressesRequest class.The Bill To address for a line item.The Ship From address for a line item.The Ship To address for a line item.The Sold To address for a line item.Learn more about the available methods with the LineTaxAddressesRequest class.Maintains the integrity of lists of type LineTaxAddressesRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals() method in Java.Maintains the integrity of lists of type LineTaxAddressesRequest by determining the uniquness of the external object records in a list.Converts a value to a string.
• RuleDetailsResponse Class: Contains details about the tax rules used for tax calculation.Learn more about the available methods with the RuleDetailsResponse class.Contains information about the tax rules used when calculating tax for line items.Sets the NonTaxableRuleId field of the RuleDetailsResponse.Sets the NonTaxableType field of the RuleDetailsResponse.Sets the RateRuleId field of the RuleDetailsResponse.Sets the RateSourceId field on the RuleDetailsResponse.
• TaxAddressRequest Class: Contains address details used for tax calculation.Learn more about the available constructors with the TaxAddressRequest class.Initializes the TaxAddressRequest object using address details. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Learn more about the available properties with the TaxAddressRequest class.City used in an address, which is required for tax calculation.Country used in an address, which is required for tax calculation.Country code used in an address, which is required for tax calculation.Latitude used in an address, which is required for tax calculation.Location code used in an address, which is required for tax calculation.Longitude used in an address, which is required for tax calculation.Postal code used in an address, which is required for tax calculation.State used in an address, which is required for tax calculation.State code used in an address, which is required for tax calculation.Street used in an address, which is required for tax calculation.Learn more about the available methods with the TaxAddressRequest class.Maintains the integrity of lists of type TaxAddressRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals() method in Java.Maintains the integrity of lists of type TaxAddressRequest by determining the uniqueness of the external object in a list.Converts a date to a string.
• TaxAddressesRequest Class: Contains methods to get and set tax address values.Learn more about the available constructors with the TaxAddressesRequest class.Constructor for defining addresses for the tax addresses request. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Learn more about the available properties with the TaxAddressesRequest class.The Bill To address for a line item.The Ship From address for a line item.The Ship To address for a line item.The Sold To address for a line item.The Tax Engine Address for a line item.Learn more about the available methods with the TaxAddressesRequest class.Maintains the integrity of lists of type TaxAddressesRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals() method in Java.Maintains the integrity of lists of type TaxAddressesRequest by determining the uniqueness of the external object records in a list.Converts a value to a string.
• TaxApiException Class: Contains details about any exceptions during the tax calculation process. Extends the ApexBaseException class.Learn more about the available constructors with the TaxApiException class.Initializes the TaxApiException class using an Exception and a string to provide more details about the exception. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Initializes the TaxApiException class using an Exception. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Initializes the TaxApiException class without any initialized parameters. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.
• TaxCustomerDetailsRequest Class: Contains customer details used in tax calculation.Learn more about the available constructors with the TaxCustomerDetailsRequest class.Initializes the TaxCustomerDetailsRequest object. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Learn more about the available properties with the TaxCustomerDetailsRequest class.Customer account that contains the line items sent for tax calculation.Tax code used during tax calculation.Number used to qualify a line item for tax exemption.Reason why a line item qualifies for tax exemption. ID of a tax certificate used for tax calculation.Learn more about the available methods with the TaxCustomerDetailsRequest class.Maintains the integrity of lists of type TaxCustomerDetailsRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals() method in Java.Maintains the integrity of lists of type TaxCustomerDetailsRequest by determining the uniqueness of the external objects in a list.Converts a value to a string.
• TaxDetailsResponse Class: Stores details of the tax values that an external tax engine calculates in response to a tax calculation request.Learn more about the available methods with the TaxDetailsResponse class.Uses an instance of CustomTaxAttributesResponse class to include additional attributes in the tax response at the tax line item level.Sets the ExemptAmount field of the TaxDetailsResponse class.Sets the ExemptReason field of the TaxDetailsResponse class.Sets the Imposition field of the TaxDetailsResponse class using an instance of the ImpositionResponse class.Sets the Jurisdiction field of the TaxDetailsResponse using an instance of the JurisdictionResponse class.Sets the Rate field of the TaxDetailsResponse class.Sets the Service Code field of the TaxDetailsResponse class.Sets the Tax field of the TaxDetailsResponse class.Sets the TaxAuthorityTypeId field of the TaxDetailsResponse class.Sets the TaxId field of the TaxDetailsResponse class.Sets the TaxRegionId field on the TaxDetailsResponse class.Sets the TaxRuleDetails field of the TaxDetailsResponse class.Sets the TaxableAmount field of the TaxDetailsResponse class.
• TaxEngineContext Class: Wrapper class that stores details about the type of a tax calculation request.Learn more about the available constructors with the TaxEngineContext class.Initializes the TaxEngineContext object. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Learn more about the available methods with the TaxEngineContext class.Retrieves the value of the NamedUri field of the TaxEngineContext class.Gets the value of the TaxEngineContext's Request field.Gets the value of the RequestType field of the TaxEngineContext class.
• TaxLineItemRequest Class: Contains line item details of a tax request.Learn more about the constructors available with the TaxLineItemRequest class.Initializes the request for the tax line item. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Learn more about the available properties with the TaxLineItemRequest class.Contains the list of addresses of a line item.Total amount (in a given currency) represented by a line item sent for tax calculation.Customised tax contract to include additional attributes at the line item level.User-defined description for a tax line item.The date that a tax transaction takes effect on a line item. This is a user-defined date used for reporting only.Unique number used to identify a tax line item.Catalog code for the product represented by the tax line item.Unique identifier of a product that can be used to identify products that are exempted from tax.Number of units of a given product that the tax line item represents.Identifier that combines the original invoice ID, previous tax transaction type, and tax engine ID, used in tax calculations for negative invoice lines.Code used to identify how tax is calculated for a tax line item.Learn more about the available methods with the TaxLineItemRequest class.Maintains the integrity of lists of type TaxLineItemRequest by determining the equality of external objects in a list. This method is dynamic and is based on the equals() method in Java.Maintains the integrity of lists of type TaxLineItemRequest by determining the uniqueness of the external object records in a list.Converts a value to a string.
• TaxSellerDetailsRequest Class: Contains tax code details used in the tax calculation request.Learn more about the available constructors with the TaxSellerDetailsRequest class.Initializes the request for the tax seller details. This constructor is intended for test usage and throws an exception if used outside of the Apex test contextLearn more about the available properties with the TaxSellerDetailsRequest class.Tax code used for tax calculation.Learn more about the available methods with the TaxSellerDetailsRequest class.Maintains the integrity of lists of type TaxSellerDetailsRequest by determining the equality of the external objects in a list. This method is dynamic and based on the equals() method in Java.Maintains the integrity of lists of type TaxSellerDetailsRequest by determining the uniqueness of the external objects in a list.Converts a value to a string.
• TaxTransactionRequest Class: Abstract class for storing customer details used in tax calculation and estimation requests.Learn more about the available constructors with the TaxTransactionRequest class.Initializes the request for the tax transaction. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.Learn more about the available properties with the TaxTransactionRequest class.A list of addresses (such as Ship To and Sold To) used as part of the tax transaction.Three-letter ISO 4217 currency code associated with the TaxTransactionRequest.Customer information used in tax calculation.Customised tax contract to include additional attributes at the header level.Optional user-defined description for providing more information about the tax transaction request.Code for documents used to provide more information in the tax calculation process.The date that the tax transaction takes effect. User-defined and used only for reporting purposes.A list of line items on which tax will be calculated.Identifier that combines the original invoice ID, previous tax transaction type, and tax engine ID, used in tax calculations for negative invoice lines.ID of an object related to the line items sent for tax calculation.Contains tax code information used in a tax calculation request.The date that the tax transaction occurred.Maintains the integrity of lists of type TaxTransactionRequest by determining the equality of external objects in a list. This method is dynamic and based on the equals() method in Java.Maintains the integrity of lists of type TaxTransactionRequest by determining the uniqueness of the external object records in a list.Converts a value to a string.
• ZipEntry Class: Contains methods to get and set information about a zip file entry.Compares this object with the specified object and returns true if both objects are equal; otherwise, returns false.Returns the hash code value for the zip entry.Gets the comment string for the zip entry.Gets the size in bytes of the compressed zip entry.Gets the content of the zip entry. This method doesn’t work with the ZipReader class.Gets the cyclic redundancy check (CRC) value for the zip entry.Gets the last modification timestamp of the zip entry.Gets the compression method of the zip entry.Gets the name of the zip entry.Gets the uncompressed size in bytes of the zip entry content.Sets the comment string for the zip entry that’s written to the Zip archive. This method doesn’t work with the ZipReader class.Sets the content of the zip entry that’s written to the Zip archive. This method doesn’t work with the ZipReader class.Sets the last modification time of the zip entry that’s written to the Zip archive. This method doesn’t work with the ZipReader class.Sets the compression method for the zip entry that’s written to the zip archive. This method doesn’t work with the ZipReader class.Returns a string representation of the zip entry.
• ZipReader Class: Contains methods to get information about zip entries and to extract content for specified zip entries from the zip file.Creates a new instance of the ZipReader class using the specified blob data.Extracts the bytes for the specified zip entry name and decompresses the content.Extracts the bytes for the specified zip entry and decompresses the content.Gets a list of all the entries from the zip file.Gets a map of names and the corresponding zip entries from the zip file.Gets a zip entry for the specified name from the zip file.Gets a list of all the zip entry names from the zip file.
• ZipWriter Class: Contains methods to add zip entries, generate a zipped archive, and return the result as an Apex blob.Creates a new instance of the ZipWriter class.Adds an entry to the zip file with the specified name and content.Adds a copy of the specified prototype entry to the zip file and includes details such as the zip entry name, comment, last modification time, and content.Adds an entry to the zip file with the specified name, comment, last modification time, compression method, and content. Compresses the zip entries and generates a ZIP archive.Gets a list of all the entries in the zip file.Gets the entry with the specified name from the zip file.Gets a set of all the zip entry names in the zip file.Gets the compression level of the zip file.Gets the compression method of the zip file.Removes the entry with the specified name from the zip file.Sets the compression level of the zip file.Sets the compression method for the zip file.
• DeletedRecord Class: Contains information about a deleted record.Returns the deleted date of this record.Returns the ID of a record deleted within the time window specified in the Database.getDeleted method.
• GetDeletedResult Class: Contains the deleted records retrieved for a specific sObject type and time window.Returns a list of deleted records for the time window specified in the Database.getDeleted method call.Returns the date in Coordinated Universal Time (UTC) of the earliest physically deleted object for the sObject type specified in Database.getDeleted.Returns the date in Coordinated Universal Time (UTC) of the last date covered in the Database.getDeleted call.
• GetUpdatedResult Class: Contains the result for the Database.getUpdated method call.Returns the IDs of records updated within the time window specified in the Database.getUpdated method.Returns the date in Coordinated Universal Time (UTC) of the last date covered in the Database.getUpdated call.
• LeadConvertResult Class: The result of a lead conversion.The ID of the new account (if a new account was specified) or the ID of the account specified when convertLead was invoked.The ID of the new contact (if a new contact was specified) or the ID of the contact specified when convertLead was invoked.If an error occurred, an array of one or more database error objects providing the error code and description.The ID of the converted lead.The ID of the new opportunity, if one was created when convertLead was invoked.The ID of the new or existing person account specified when convertLead was invoked.A Boolean value that is set to true if the DML operation was successful for this object, false otherwise
• MergeResult Class: Contains the result of a merge Database method operation.Returns a list of Database.Error objects representing the errors encountered, if any, during a merge operation using the Database.merge method. If no error occurred, returns null.Returns the ID of the master record into which other records were merged.Returns the IDs of the records merged into the master record.Returns the IDs of all related records that were reparented as a result of the merge that are viewable by the user sending the merge call.Indicates whether the merge was successful (true) or not (false).
• QueryLocatorIterator Class: Represents an iterator over a query locator record set.Returns true if there are one or more records remaining in the collection; otherwise, returns false.Advances the iterator to the next sObject record and returns the sObject.
• Result Class: Contains methods to retrieve data that was transformed using Script class methods.Returns the result of a DataWeave script execution as an object.Returns the result of a DataWeave script execution as a string value.
• Script Class: Contains the createScript() method to load DataWeave scripts and the execute() method to obtain script output in a DataWeave.Result object. Loads a DataWeave 2.0 script from the .dwl metadata file that is deployed in an org. The script can then be run using the Script.execute method.Loads a DataWeave 2.0 script from a specified namespace. The script can then be run using the Script.execute method.Executes the DataWeave script that is loaded using the createScript() method and returns the script output. Returns the name of the script.
• ApexMap Class: Create, clone, and convert string based key-value pairs to a JSON string format.Learn more about the constructors available with the ApexMap class.Initializes a new instance of the ApexMap class by assigning the specified key and value. This constructor creates a single key–value entry that can be included in an embedded AI Apex map for passing contextual data to embedded AI logic.Initializes the ApexMap class.Represents key of the key-value pair. This property is used to store the unique ID or name of the data.Represents value of the key-value pair. This property is used to store the data associated with the key.Create a copy of the ApexMap object and convert key-value pairs to string format.Returns a string representation of the ApexMap object.
• RecordApexRepresentation Class: Contains properties and a method to create a serializable representation of a record and its associated data for AI service integration and data processing.Learn more about the constructors available with the RecordApexRepresentation class.Initializes a new instance of the RecordApexRepresentation class with the specified object type, primary record data, and related record data. This constructor represents a structured record and its relationships for consumption by embedded AI logic.Initializes the RecordApexRepresentation class.Stores the type of the object.Stores a list of objects, where each object holds a key-value pair.Stores a list that contains a child or related records associated with the record data.Create detailed, hierarchical record objects and convert them to a custom JSON string for structured AI input.Converts a JSON-formatted string into a RecordApexRepresentation instance. This method parses the provided JSON and constructs a structured record representation that can be used by embedded AI logic.Returns a structured JSON string representation of the RecordApexRepresentation object and its nested related records.
• ChangeEventHeader Class: Contains header fields of Change Data Capture events.A list of the fields that were changed in an update operation, including the LastModifiedDate system field. This field is empty for other operations, including record creation. This property is available in Apex saved using API version 47.0 or later.Only populated for changes done by API apps or from Lightning Experience; empty otherwise. The Salesforce API and the API client ID that initiated the change, if set by the client. Use this field to detect whether your app initiated the change to not process the change again and potentially avoid a deep cycle of changes.The operation that caused the change.The system change number (SCN) of a committed transaction, which increases sequentially. This field is provided for diagnostic purposes. The field value is not guaranteed to be unique in Salesforce—it is unique only in a single database instance. If your Salesforce org migrates to another database instance, the commit number might not be unique or sequential.The date and time when the change occurred, represented as the number of milliseconds since January 1, 1970 00:00:00 GMT.The ID of the user that ran the change operation.Contains the names of fields whose values are sent as a unified diff because they contain large text values.The API name of the standard or custom object that the change pertains to. For example, Account or MyObject__c.Contains the names of fields whose values were changed to null in an update operation. Use this field in Apex change event messages to determine if a field was changed to null in an update and isn’t an unchanged field.One or more record IDs for the changed records. Typically, this field contains one record ID. If in one transaction the same change occurred in multiple records of the same object type during one second, Salesforce merges the change notifications. In this case, Salesforce sends one change event for all affected records and the recordIds field contains the IDs for all records that have the same change.The sequence of the change within a transaction. The sequence number starts from 1.A string that uniquely identifies each Salesforce transaction. You can use this key to identify and group all changes that were made in the same transaction.
• TestBroker Class: Contains methods that simulate the successful delivery or failed publishing of platform event or change event messages in an Apex test.Delivers platform event messages to the test event bus. Use this method to deliver test event messages multiple times and verify that event subscribers have processed the test events each step of the way.Causes the publishing of platform event messages to fail in the test event bus. Use this method to test Apex publish callbacks.
• TriggerContext Class: Provides information about the platform event or change event trigger that’s currently executing, such as how many times the trigger was retried due to the EventBus.RetryableException. Also, provides a method to resume trigger executions.Read-only. The error message that the last thrown EventBus.RetryableException contains.Read-only. The number of times the trigger was retried due to throwing the EventBus.RetryableException.Returns an instance of the EventBus.TriggerContext class containing information about the currently executing trigger.Returns the replay ID that was set by setResumeCheckpoint(). The returned value is the replay ID of the event message after which trigger processing resumes in a new trigger invocation.Sets a checkpoint in the event stream where the platform event trigger resumes execution in a new invocation. Use this method to recover from limit and uncaught exceptions, or to control the number of events processed in one trigger execution. When calling this method, pass in the replay ID of the last successfully processed event message. When the trigger stops execution before all events in Trigger.New are processed, either because of an uncaught exception or intentionally, the trigger is invoked again. The new execution starts with the event message in the stream after the one with the checkpointed Replay ID.
• ComplexObjectFieldDetails Class: The methods and properties in this class are for internal use only.
• PropertyTypeDetails Class: The methods and properties in this class are for internal use only.
• ToastLink Class: The methods and properties in this class are reserved for future use.
• FormulaBuilder Class: Contains methods to build and validate user-defined formulas.Validates and returns the formula instance created using the FormulaBuilder methods.Optional. Indicates whether a formula expression created with the build() method is evaluated in template mode. In template mode, values are interpolated into a string by using merge field syntax rather than by concatenating strings with the & operator. Merge fields use the syntax {!Object_Name.Field_Name}, where names are preceded by an exclamation mark and enclosed in curly braces.Optional. Indicates whether a null for a numeric data type is treated as zero while evaluating the formula with the build() method.Required. Sets the formula expression that the build() method uses to create the formula instance.Optional. Sets the list of global variables that can be referenced in the formula expression created with the build() method.Required. Sets the formula output data type for the formula instance created with the build() method. Sets the Apex type that corresponds to the Apex class used with the build() method.Sets the Apex type that corresponds to the Apex class used with the build() method to SObject type.
• FormulaInstance Class: Contains a method to evaluate the formula instance.Calculates the formula expression and returns the formula output.Returns a set of strings that denote the field names referenced in a formula.
• Function Class: Use the Function class to access deployed Salesforce Functions, and invoke them synchronously or asynchronously. Returns the Function instance for the named Function and Project. The Function must be properly deployed and have appropriate permissions to work with the org running your Apex code. Returns the Function instance for the named Function, Project, and Namespace. The Function must be properly deployed and have appropriate permissions to work with the org running your Apex code.Invokes the Function asynchronously.Invokes the Function synchronously.
• MockFunctionInvocationFactory Class: Use the MockFunctionInvocationFactory methods to generate appropriate mock responses for testing Salesforce Functions.Generate a response for an error condition during mock testing of Salesforce Functions.Generate a response for a successful mock test of Salesforce Functions.
• NlpResponse Class: Stores the result for an NLP Operation. NLP operation can be SurveyLongSummarization and SurveyShortSummarization.
• DynamicMenuItem Class: Contains properties to define and hold the details for a single dynamic menu item Each item contains information related to an object, such as identifiers, labels, summaries, and sorting logic. It enables bots to present context-aware and user-relevant choices dynamically during conversations. .Learn more about the properties available with the DynamicMenuItem class.API name representing the ID field of the related Salesforce object.The ID value retrieved at run time for the associated object.API name or label of the object being referenced, for example Case, Contact, or a custom object such as Service__c.The name of the specific object instance.The label used to define how the item must be displayed in the bot menu.The value of the label displayed to the user for the menu item at run time.A formula or a string of text that defines the structure of the summary text displayed for the item. This formula is used to construct a dynamic summary for the user after they make a selection.The summary string based on the formula and object data.The API name of a date or date/time field on the object that's used to sort the dynamic menu items.The DateTime value used at run time to sort the menu items chronologically.
• GetAppointmentCandidatesInput Class: Contains information about the available service resources (appointment candidates) based on work type group and service territories.
• GetAppointmentCandidatesInputBuilder Class: Contains methods to build an instance of the lxscheduler.GetAppointmentCandidatesInput class.Returns an instance of the lxscheduler.GetAppointmentCandidatesInput object.Sets the ID of the associated account for which you want to create the appointments.Allows the scheduling of concurrent appointments.Sets the API version of the business logic for the getAppointmentCandidates method.Sets the correlation ID.Sets the scheduling end time.Sets an engagement channel type.Enables filtering resources using a comma-separated list of service resource IDs.Sets the number of service resources to show during appointment scheduling.Sets the ID of the AppointmentSchedulingPolicy object.Sets the scheduling start time to the specified time.Sets the service territory IDs.Sets the type of work to be performed.Sets the ID of the work type group.
• GetAppointmentSlotsInput Class: Contains information about the available appointment time slots for a resource based on given work type group and territories.
• GetAppointmentSlotsInputBuilder Class: Contains methods to build an instance of the lxscheduler.GetAppointmentSlotsInput class.Returns an instance of the lxscheduler.GetAppointmentSlotsInput object.Sets the ID of the associated account for which you want to create appointments.Allows the scheduling of concurrent appointments.Sets the API version of the business logic for the getAppointmentSlots method.Sets the correlation ID.Sets the scheduling end time.Sets an engagement channel type.Sets the ID of the primary resource.Sets the resource IDs.Sets the ID of the AppointmentSchedulingPolicy object.Sets the scheduling start time.Sets the IDs of service territories.Sets the type of work to be performed.Sets the ID of the work type group.
• SchedulerResources Class: Contains methods that holds the business logic to get resources availability.Returns a list of service resources based on work type group or work type and service territories.Returns a list of available appointment time slots for a resource based on given work type group or work type and service territories.Sets a mock object when running tests for the getAppointmentCandidates method.Sets a mock object when running tests for the getAppointmentSlots method.
• ServiceAppointmentRequestInfo Class: Represents the list of parameters that are passed to the ServiceResourceScheduleHandler interface. This class is implemented internally by Apex.Creates a new instance of the lxscheduler.ServiceAppointmentRequestInfo class using the specified start date, end date, service resources, scheduling policy, work type group, accound ID, primary resource, work type, and correlation.Returns the account ID of the customer if the API request contains one.Returns a unique identifier for a request.Returns the end date and time for which unavailable time slots are requested.Returns the ID of the primary service resource.Returns the ID of the scheduling policy that the API request contains.Returns the list of requested service resources for the unavailable time slots.Returns the start date and time for which unavailable time slots are requested.Returns the work type group ID if the API request contains one.Returns the work type ID if the API request contains one.
• ServiceResourceInfo Class: Contains information about a service resource.Creates a new instance of the lxscheduler.ServiceResourceInfo class using the specified service resource details.Returns the email ID of the service resource.Returns the type of the service resource such as Technician or Asset.Returns the ID of the service resource.Returns a list of requested service territories for the service resource.Returns the user ID of the service resource.Returns the user name of the service resource.
• ServiceResourceSchedule Class: Use this class to pass results from your implemented Apex class to the ServiceResourceScheduleHandler interface methods.Creates a new instance of lxscheduler.ServiceResourceSchedule class.Record ID of the service resource.An instance of lxscheduler.UnavailableTimeslot class.
• SkillRequirement Class: Contains information about the set of skills that are required to complete a particular task for a work type.
• SkillRequirementBuilder Class: Contains methods to build an instance of the lxscheduler.SkillRequirement class.Returns an instance of the lxscheduler.SkillRequirement object.Sets the skill that is required to complete a particular task for a work type. This is a required field.Sets the level of the skill that is required to complete a particular task for a work type
• UnavailableTimeslot Class: Use this class to pass the unavailable time slots to the lxscheduler.ServiceResourceSchedule class. Timezones that differ across operating hours are handled and results are always returned in UTC.Creates an instance of lxscheduler.UnavailableTimeslot class.End time of an unavailable time slot.Start time of an unavailable time slot.
• WorkType Class: Contains information about the type of work to be performed.
• WorkTypeBuilder Class: Contains methods to build an instance of the lxscheduler.WorkType class.Returns an instance of the lxscheduler.WorkType object.Sets the time period, in minutes.Sets the time period, in minutes.Sets the event length. Sets the ID of the work type to the specified ID. Sets the overlap of operating hours.Sets the skills that are required to complete a particular task for a work type. Sets the end of the timeframe.Sets the beginning of the timeframe.
• LoadFormData Class: Retrieve records related to the tokenized record id, and populate the values of a preference form.Creates an instance of the LoadFormData class for running tests on any custom Apex classes you create for Preference Manager.Add an option for a checkbox, picklist, or radio button field in a preference form using the label and value.Add a defined, selectable option for a checkbox, picklist, or radio button field in a preference form.Add a selected option for a checkbox field in a preference form. This requires the field on the form to have a defined option with a set value.Set the label of a button added to the preference form.Add a list of selectable options for a field on a preference form.For a picklist or radio button field on a preference form that has defined values, set the value entered in the optionValue field as the selected option.For an existing checkbox field on a preference form that has defined values, set the values entered in the options field as the selected options. This requires the field on the form to have defined options with a set value.Set the hint text inside a text input field. The hint text tells the user what type of information to enter, like an email address.Set the value of a text field in a preference form.
• LoadParameters Class: Contains methods to retrieve record Id information for parameters passed into the load-form handler.Returns the untokenized version of the record Id.
• SubmitFormData Class: Contains methods to retrieve information on buttons and options selected in a preference form.Returns the field ID of the button that was clicked in the preference form. For example, use this method to determine if the clicked button was Submit or Cancel.Returns the value that was set for the specified field when the preference form was previously edited by the user. This method is used for field types such as picklist or radio buttons.Returns a list of the string values that were set on a checkbox field when the preference form was previously edited by the user.Returns the string value that was set on a field when the preference form was loaded. This method is used for field types such as text, and throws a TypeException if used with a field that can return more than one value, like a checkbox field.Returns the string value that is currently selected for a picklist or radio button field in the preference form.Returns a list of string values that are currently selected on a checkbox field in the preference form.Returns the string value that was set on a field when the preference form was loaded. This method is used for field types such as text.
• SubmitParameters Class: Retrieve record ID information to use with your submit-form handler.Returns the untokenized version of the record ID.
• TokenUtility Class: Generate authentication tokens to access preference forms.Returns the authentication token for the specified token value using the given token type.Returns the authentication token for the specified token value using the default standard token type.Returns the authentication tokens in the form of a map, where the map key is the input value to be tokenized and the map value is the corresponding token. The given token type is used to generate the tokens.Returns the generated tokens in the form of a map. This method uses the default standard token type to generate the tokens.
• ValidationResult Class: This class is reserved for future use with Preference Manager.
• DescribeAvailableQuickActionResult Class: Contains describe metadata information for a quick action that is available for a specified parent.Returns the unique ID for the action. If the action doesn’t have an ID, its API name is used.The quick action label.The quick action name.The quick action type.
• DescribeLayoutComponent Class: Represents the smallest unit in a layout—a field or a separator.Returns the vertical lines displayed for a field. Applies to textarea and multi-select picklist fields.Returns the tab order for the item in the row.Returns the name of the QuickAction.DescribeLayoutComponent type for this component.Returns the name of the field if the type for QuickAction.DescribeLayoutComponent is textarea.
• DescribeLayoutItem Class: Represents an individual item in a QuickAction.DescribeLayoutRow.Returns the label text for this item.Returns a list of QuickAction.DescribeLayoutComponents for this item.Indicates whether this item can be edited for new (true) or not (false).Indicates whether this item can be edited for update(true) or not (false).Indicates whether this item is a placeholder (true) or not (false). If true, then this item is blank.Indicates whether this item is required (true) or not (false).
• DescribeLayoutRow Class: Represents a row in a QuickAction.DescribeLayoutSection.Returns either a specific field or an empty QuickAction.DescribeLayoutItem (one that contains no QuickAction.DescribeLayoutComponent objects).Returns the number of QuickAction.DescribeLayoutItem.
• DescribeLayoutSection Class: Represents a section of a layout and consists of one or more columns and one or more rows (an array of QuickAction.DescribeLayoutRow).The current view of the record details section: collapsed (true) or expanded (false).The unique ID of the record details section in the layout.Returns the number of columns in the QuickAction.DescribeLayoutSection.The heading text (label) for the QuickAction.DescribeLayoutSection.Returns an array of one or more QuickAction.DescribeLayoutRow objects.Returns the ID of the record details section in the layout.Returns the ID of the layout upon which this DescribeLayoutSection resides.Returns the number of rows in the QuickAction.DescribeLayoutSection.Indicates whether the record details section is collapsed (true) or expanded (false). If you build your own app, you can use this method to see whether the current user collapsed a section, and respect that preference in your own UI.Indicates whether the QuickAction.DescribeLayoutSection is a collapsible section (true) or not (false).Indicates whether to use the heading (true) or not (false).
• DescribeQuickActionDefaultValue Class: Returns a default value for a quick action.Returns the default value of the quick action.Returns the field name of the action.
• DescribeQuickActionResult Class: Contains describe metadata information for a quick action.The name of the Canvas application invoked by the custom action.Array of color information. Each color is associated with a theme.The object used for the action. Was getsourceSobjectType() in API version 29.0 and earlier.The action’s default values.If the custom action invokes a flow, the fully qualified name of the flow.If the custom action invokes a flow, the input variable that the custom action passes the record’s ID to. The height in pixels of the action pane.The name of the icon used for the action. If a custom icon is not used, this value isn’t set.Array of icons. Each icon is associated with a theme.The URL of the icon used for the action. This icon URL corresponds to the 32x32 icon used for the current Salesforce theme, introduced in Spring ’10, or the custom icon, if there is one.The section of the layout where the action resides.If the custom action invokes an Aura component, the ID of the Aura component bundle to which the component belongs.If the custom action invokes an Aura component, the name of the Aura component bundle to which the component belongs.The fully qualified name of the Aura component invoked by the custom action.If the custom action invokes a Lightning web component, the ID of the Lightning web component bundle to which the component belongs.If the custom action invokes a Lightning web component, the name of the Lightning web component bundle to which the component belongs.The fully qualified name of the Lightning web component invoked by the custom action.The icon’s URL. This icon URL corresponds to the 16x16 icon used for the current Salesforce theme, introduced in Spring ’10, or the custom icon, if there is one.Indicates whether the Lightning component quick action header and footer are shown. If false, then both the header containing the quick action title and the footer containing the Save and Cancel buttons aren’t displayed.Indicates whether the Visualforce quick action header and footer should be shown. If false, then both the header containing the quick action title and the footer containing the Save and Cancel buttons aren’t displayed.The parent object type of the action. Links the target object to the parent object. For example, the value is Account if the target object is Contact and the parent object is Account.The record type of the target record.The action’s target object type.The name of the Visualforce page associated with the custom action.The URL of the Visualforce page associated with the action.The width in pixels of the action pane, for custom actions that call Visualforce pages, Canvas apps, or Lightning components.Returns the unique ID for the action. If the action doesn’t have an ID, its API name is used.Returns the name of the Canvas application, if used.Returns an array of color information. Each color is associated with a theme.Returns the object used for the action. Replaces getsourceSobjectType() in API version 30.0 and later.Returns the default values for a action.If the custom action invokes a flow, returns the fully qualified name of the flow invoked by the custom action.If the custom action invokes a flow, returns the input variable that the custom action passes the record’s ID to. Returns the height in pixels of the action pane.Returns the actions’ icon name.Returns the URL of the 32x32 icon used for the action.Returns a list of Schema.DescribeIconResult objects that describe colors used in a tab.Returns the action label.Returns the layout sections that comprise an action.If the custom action invokes an Aura component, returns the ID of the Aura component bundle to which the component belongs.If the custom action invokes an Aura component, returns the name of the Aura component bundle to which the component belongs.If the custom action invokes an Aura component, returns the fully qualified name of the Aura component invoked by the custom action.If the custom action invokes a Lightning web component, returns the ID of the Lightning web component bundle to which the component belongs.If the custom action invokes a Lightning web component, returns the name of the Lightning web component bundle to which the component belongs.If the custom action invokes a Lightning web component, returns the fully qualified name of the Lightning web component invoked by the custom action.Returns the 16x16 icon URL.Returns the action name.Returns an indication of whether the Lightning component quick action header and footer are shown.Returns an indication of whether the Visualforce quick action header and footer should be shown.Returns the object type used for the action.Returns the parent object’s type for the action.Returns the record type of the targeted record.Returns the action’s target object type.Returns a create or custom Visualforce action.If Visualforce is used, returns the name of the associated page for the action.Returns the URL of the Visualforce page associated with the action.If a custom action is created, returns the width in pixels of the action pane.
• QuickActionRequest Class: Use the QuickAction.QuickActionRequest class for providing action information for quick actions to be performed by QuickAction class methods. Action information includes the action name, context record ID, and record.Creates a new instance of the QuickAction.QuickActionRequest class.Returns this QuickAction’s context record ID.Returns this QuickAction’s name.Returns the QuickAction’s associated record.Sets this QuickAction’s context ID. Returned by getContextId. Sets this QuickAction’s name. Returned by getQuickActionName.Sets a record for this QuickAction. Returned by getRecord.
• QuickActionResult Class: After you initiate a quick action with the QuickAction class, use the QuickActionResult class for processing action results.If an error occurs, an array of one or more database error objects, along with error codes and descriptions, is returned.The IDs of the QuickActions being processed.Returns the success message associated with the quick action.Returns true if the action is created; otherwise, false.Returns true if the action completes successfully; otherwise, false.
• BucketField Class: Contains methods and constructors to work with information about a bucket field, including bucket type, name, and bucketed values.Creates an instance of the Reports.BucketField class using the specified parameters.Creates an instance of the Reports.BucketField class. You can then set values by using the class’s set methods.Returns the bucket type.Returns the bucket’s API name.Returns the user-facing name of the bucket.Returns true if null values are converted to the number zero, otherwise returns false.Returns the name of fields grouped as Other in buckets of type PICKLIST.Returns the API name of the bucketed field.Returns the report values grouped by the bucket field.Sets the BucketType of the bucket.Sets the BucketType of the bucket.Sets the API name of the bucket.Sets the user-facing name of the bucket.Specifies whether null values in the bucket are converted to zero (true) or not (false).Sets the name of the fields grouped as Other (in buckets of BucketType PICKLIST).Specifies the name of the bucketed field.Specifies which type of values are included in the bucket.Returns a string.
• BucketFieldValue Class: Contains information about the report values included in a bucket field.Creates an instance of the Reports.BucketFieldValue class using the specified parameters.Creates an instance of the Reports.BucketFieldValue class. You can then set values by using the class’s set methods.Returns the user-facing name of the bucket category.Returns the greatest range limit under which values are included in this bucket category (in buckets of type NUMBER).Returns a list of the values from the source field included in this bucket category (in buckets of type PICKLIST and buckets of type TEXT).Set the user-facing name of the bucket category.Sets the greatest limit of a range under which values are included in this bucket category (in buckets of type NUMBER).Specifies the values from the source field included in this bucket category (in buckets of type PICKLIST and buckets of type TEXT).Returns a string.
• CrossFilter Class: Contains methods and constructors used to work with information about a cross filter.Creates an instance of the Reports.CrossFilter class using the specified parameters.Creates an instance of the Reports.CrossFilter class. You can then set values by using the class’s set methods.Returns information about how to filter the relatedEntity. Describes the subset of the relatedEntity which the primary entity is evaluated against.Returns true if primary object has a relationship with the relatedEntity, otherwise returns false.Returns the name of the object on which the cross filter is evaluated.Returns name of the object that the primaryEntityField is evaluated against—the right-hand side of the cross filter.Returns the name of the field used to join the primaryEntityField and relatedEntity.Specifis how to filter the relatedEntity. Relates the primary entity with a subset of the relatedEntity.Specifies whether objects returned have a relationship with the relatedEntity (true) or not (false).Specifies the name of the object on which the cross filter is evaluated.Specifies the name of the object that the primaryEntityField is evaluated against—the right-hand side of the cross filter.Specifies the name of the field used to join the primaryEntityField and relatedEntity.Returns a string.
• EvaluatedCondition Class: Contains the individual components of an evaluated condition for a report notification, such as the aggregate name and label, the operator, and the value that the aggregate is compared to.Creates a new instance of the Reports.EvaluatedConditions class using the specified parameters.Returns the localized display name of the aggregate.Returns the unique API name of the aggregate.Returns the value that the aggregate is compared to in the condition.Returns the value that the aggregate is compared to in the condition, formatted for display. For example, a display value for a currency is $20.00 or USD20.00 instead of 20.00.Returns the value of the aggregate when the report is run, formatted for display. For example, a display value for a currency is $20.00 or USD20.00 instead of 20.00.Returns the operator used in the condition.Returns the actual value of the aggregate when the report is run.
• NotificationActionContext Class: Contains information about the report instance and condition threshold for a report notification.Creates a new instance of the Reports.NotificationActionContext class using the specified parameters.Returns the report instance associated with the notification.Returns the threshold information associated with the notification.
• ReportCsf Class: Contains methods and constructors for working with information about a custom summary formula (CSF).Creates an instance of the Reports.ReportCsf class using the specified parameters.Creates an instance of the Reports.ReportCsf class. You can then set values by using the class’s set methods.Returns the name of a column grouping when the acrossGroupType is CUSTOM. Otherwise, returns null.Returns where to display the aggregate.Returns the number of decimal places that numbers in the custom summary formula have.Returns the user-facing description of a custom summary formula.Returns the name of a row grouping when the downGroupType is CUSTOM. Otherwise, returns null.Returns where to display the aggregate of the custom summary formula.Returns the operations performed on values in the custom summary formula.Returns the formula type.Returns the user-facing name of the custom summary formula.Specifies the column for the across grouping.Sets where to display the aggregate.Sets where to display the aggregate.Sets the number of decimal places in numbers.Sets the user-facing description of the custom summary formula.Sets the name of a row grouping when the downGroupType is CUSTOM.Sets where to display the aggregate.Sets where to display the aggregate.Sets the operations to perform on values in the custom summary formula.Sets the format of the numbers in the custom summary formula.Sets the format of numbers used in the custom summary formula.Sets the user-facing name of the custom summary formula.Returns a string.
• ReportDivisionInfo Class: Contains information about the divisions that can be used to filter a report.Returns the default division for the report.Returns a list of all possible divisions for the report.
• ReportScopeInfo Class: Contains information about possible scope values that you can choose. Scope values depend on the report type. For example, you can set the scope for opportunity reports to All opportunities, My team’s opportunities, or My opportunities.Returns the default scope of the data to display in the report.Returns a list of scope values specified for the report.
• ReportScopeValue Class: Contains information about a possible scope value. Scope values depend on the report type. For example, you can set the scope for opportunity reports to All opportunities, My team’s opportunities, or My opportunities.Returns a boolean value that indicates whether you can segment the report by this scope.Returns the display name of the scope of the report.Returns the scope value for the report.
• ReportTypeMetadata Class: Contains report type metadata, which gives you information about the fields that are available in each section of the report type, plus filter information for those fields.Returns all fields in the report type. The fields are organized by section.Returns the default division and a list of all possible divisions that can be applied to this type of report.Returns information about the scopes that can be applied to this type of report.Returns information about the standard date filter groupings that can be applied to this type of report. Standard date filter groupings include Calendar Year, Calendar Quarter, Calendar Month, Calendar Week, Fiscal Year, Fiscal Quarter, Day and a custom value based on a user-defined date range.Returns information about standard date filters that can be applied to this type of report.
• SortColumn Class: Contains information about the sort column used in the report.Returns the column used to sort the records in the report.Returns the the sort order— ascending or descending—for the sort column.Sets the column used to sort the records in the report.Sets the sort order— ascending or descending—for the sort column.
• StandardDateFilter Class: Contains information about standard date filter available in the report—for example, the API name, start date, and end date of the standard date filter duration as well as the API name of the date field on which the filter is placed.Returns the API name of the standard date filter column.Returns duration information about a standard date filter, such as start date, end date, and display name and API name of the date filter.Returns the end date of the standard date filter.Returns the start date for the standard date filter.Sets the API name of the standard date filter column.Sets the API name of the standard date filter.Sets the end date for the standard date filter.Sets the start date for the standard date filter.
• StandardDateFilterDuration Class: Contains information about each standard date filter—also referred to as a relative date filter. It contains the API name and display label of the standard date filter duration as well as the start and end dates.Returns the end date of the date filter.Returns the display name of the date filter. Possible values are relative date filters—like Current FY and Current FQ—and custom date filters.Returns the start date of the date filter.Returns the API name of the date filter. Possible values are relative date filters—like THIS_FISCAL_YEAR and NEXT_FISCAL_QUARTER—and custom date filters.
• StandardDateFilterDurationGroup Class: Contains information about the standard date filter groupings, such as the grouping display label and all standard date filters that fall under the grouping. Groupings include Calendar Year, Calendar Quarter, Calendar Month, Calendar Week, Fiscal Year, Fiscal Quarter, Day, and custom values based on user-defined date ranges.Returns the display label for the standard date filter grouping.Returns the standard date filter groupings.
• StandardFilter Class: Contains information about the standard filter defined in the report, such as the filter field API name and filter value.Return the API name of the standard filter.Returns the standard filter value.Sets the API name of the standard filter.Sets the standard filter value.
• StandardFilterInfo Class: Is an abstract base class for an object that provides standard filter information.Returns the display label of the standard filter.Returns the type of standard filter.
• StandardFilterInfoPicklist Class: Contains information about the standard filter picklist, such as the display name and type of the filter field, the default picklist value, and a list of all possible picklist values.Returns the default value for the standard filter picklist.Returns a list of standard filter picklist values.Returns the display name of the standard filter picklist.Returns the type of the standard filter picklist.
• ThresholdInformation Class: Contains a list of evaluated conditions for a report notification.Creates a new instance of the Reports.EvaluatedCondition class.Returns a list of evaluated conditions for a report notification.
• TopRows Class: Contains methods and constructors for working with information about a row limit filter.Creates an instance of the Reports.TopRows class using the specified parameters.Creates an instance of the Reports.TopRows class. You can then set values by using the class’s set methods.Returns the sort order of the report rows.Returns the maximum number of rows shown in the report.Sets the sort order of the report’s rows.Sets the sort order of the report’s rows.Sets the maximum number of rows included in the report.Returns a string.
• AggregateColumn Class: Contains methods for describing summary fields such as Record Count, Sum, Average, Max, Min, and custom summary formulas. Includes name, label, data type, and grouping context.Returns the unique API name of the summary field.Returns the localized display name for the summarized or custom summary formula field.Returns the data type of the summarized or custom summary formula field.Returns the column grouping in the report where the summary field is displayed.Returns the row grouping in the report where the summary field is displayed.
• DetailColumn Class: Contains methods for describing fields that contain detailed data. Detailed data fields are also listed in the report metadata.Returns the unique API name of the detail column field.Returns the localized display name of a standard field, the ID of a custom field, or the API name of a bucket field that has detailed data.Returns the data type of a detail column field.
• Dimension Class: Contains information for each row or column grouping.Returns information for each row or column grouping as a list.
• FilterOperator Class: Contains information about a filter operator, such as display name and API name.Returns the localized display name of the filter operator. Possible values for this name are restricted based on the data type of the column being filtered. Returns the unique API name of the filter operator. Possible values for this name are restricted based on the data type of the column being filtered. For example multipicklist fields can use the following filter operators: “equals,” “not equal to,” “includes,” and “excludes.” Bucket fields are considered to be of the String type.
• FilterValue Class: Contains information about a filter value, such as the display name and API name.Returns the localized display name of the filter value. Possible values for this name are restricted based on the data type of the column being filtered. Returns the unique API name of the filter value. Possible values for this name are restricted based on the data type of the column being filtered.
• GroupingColumn Class: Contains methods for describing fields that are used for column grouping.Returns the unique API name of the field or bucket field that is used for column grouping.Returns the localized display name of the field that is used for column grouping.Returns the data type of the field that is used for column grouping.Returns the level of grouping for the column.
• GroupingInfo Class: Contains methods for describing fields that are used for grouping.Returns the unique API name of the field or bucket field that is used for row or column grouping.Returns the order that is used to sort data in a row or column grouping (ASCENDING or DESCENDING).Returns the date interval that is used for row or column grouping.Returns the summary field that is used to sort data within a grouping in a summary report. The value is null when data within a grouping is not sorted by a summary field.
• GroupingValue Class: Contains grouping values for a row or column, including the key, label, and value.Returns a list of second- or third-level row or column groupings. If there are none, the value is an empty array.Returns the unique identifier for a row or column grouping. The identifier is used by the fact map to specify data values within each grouping.Returns the localized display name of a row or column grouping. For date and time fields, the label is the localized date or time.Returns the value of the field that is used as a row or column grouping.
• ReportCurrency Class: Contains information about a currency value, including the amount and currency code.Returns the amount of the currency value.Returns the report currency code, such as USD, EUR, or GBP, for an organization that has multicurrency enabled. The value is null if the organization does not have multicurrency enabled.
• ReportDataCell Class: Contains the data for a cell in the report, including the display label and value.Returns the localized display name of the value of a specified cell in the report.Returns the value of a specified cell of a detail row of a report.
• ReportDescribeResult Class: Contains report, report type, and extended metadata for a tabular, summary, or matrix report.Returns additional information about grouping and summaries.Returns unique identifiers for groupings and summaries.Returns the fields in each section of a report type, plus filtering information for those fields.
• ReportDetailRow Class: Contains data cells for a detail row of a report.Returns a list of data cells for a detail row.
• ReportExtendedMetadata Class: Contains report extended metadata for a tabular, summary, or matrix report.Returns all report summaries such as Record Count, Sum, Average, Max, Min, and custom summary formulas. Contains values for each summary that is listed in the report metadata.Returns a map of two properties for each field that has detailed data identified by its unique API name. The detailed data fields are also listed in the report metadata.Returns a map of each row or column grouping to its metadata. Contains values for each grouping that is identified in the groupingsDown and groupingsAcross lists.
• ReportFact Class: Contains the fact map for the report, which represents the report’s data values.Returns summary-level data for a report, including the record count.Returns the unique identifier for a row or column grouping. This identifier can be used to index specific data values within each grouping.
• ReportFactWithDetails Class: Contains the detailed fact map for the report, which represents the report’s data values.Returns summary-level data for a report, including the record count.Returns the unique identifier for a row or column grouping. This identifier can be used to index specific data values within each grouping.Returns a list of detailed report data in the order of the detail columns that are provided by the report metadata.
• ReportFactWithSummaries Class: Contains the fact map for the report, which represents the report’s data values, and includes summarized fields.Returns summary-level data for a report, including the record count.Returns the unique identifier for a row or column grouping. This identifier can be used to index specific data values within each grouping.Returns a string.
• ReportFilter Class: Contains information about a report filter, including column, operator, and value.Creates a new instance of the Reports.ReportFilter class. You can then set values by using the “set” methods.Creates a new instance of the Reports.ReportFilter class by using the specified parameters.Creates a new instance of the Reports.ReportFilter class by using the specified parameters.Creates a new instance of the Reports.ReportFilter class by using the specified parameters.Returns the unique API name for the field that’s being filtered.Returns the entity name used in the report filter. Use the entity name to handle ambiguous field names across entities, specifically when using cross filters.Returns the type of report filter.Returns the unique API name for the condition that is used to filter a field, such as “greater than” or “not equal to.” Filter conditions depend on the data type of the field.Returns the value that the field is being filtered by. For example, the field Age can be filtered by a numeric value. Sets the unique API name for the field that’s being filtered.Sets the entity name to use in the report filter. Use the entity name to handle ambiguous field names across entities, specifically when using cross filters.Sets the type of report filter.Sets the unique API name for the condition that is used to filter a field, such as “greater than” or “not equal to.” Filter conditions depend on the data type of the field.Sets the value by which a field can be filtered. For example, the field Age can be filtered by a numeric value.Returns a string representation of the filter.
• ReportInstance Class: Returns an instance of a report that was run asynchronously. Retrieves the results for that instance.Returns the date and time when the instance of the report finished running. The completion date is available only if the report instance ran successfully or couldn’t be run because of an error. Date and time information is in ISO-8601 format.Returns the unique ID for an instance of a report that was run asynchronously.Returns the ID of the user who created the report instance.Returns the unique ID of the report this instance is based on.Retrieves results for an instance of an asynchronous report. When you request your report, you can specify whether to summarize data or include details.Returns the date and time when an instance of the report was run. Date and time information is in ISO-8601 format.Returns the status of a report.
• ReportManager Class: Runs a report synchronously or asynchronously and with or without details.Retrieves report, report type, and extended metadata for a tabular, summary, or matrix report.Lists the field data types that you can use to filter the report.Retrieves results for an instance of a report that has been run asynchronously. The settings you use when you run your asynchronous report determine whether you can retrieve summary data or detailed data.Returns a list of instances for a report that was run asynchronously. Each item in the list represents a separate instance of the report, with metadata for the time at which the report was run.Runs a report asynchronously with the report ID. Includes details if includeDetails is set to true. Filters the report based on the report metadata in reportMetadata. Runs a report asynchronously with the report ID. Includes details if includeDetails is set to true.Runs a report asynchronously with the report ID. Filters the results based on the report metadata in reportMetadata.Runs a report asynchronously with the report ID.Runs a report immediately with the report ID. Includes details if includeDetails is set to true. Filters the results based on the report metadata in reportMetadata. Runs a report immediately with the report ID. Includes details if includeDetails is set to true.Runs a report immediately with the report ID. Filters the results based on the report metadata in rmData.Runs a report immediately with the report ID.
• ReportMetadata Class: Contains report metadata for a tabular, summary, or matrix report.Returns unique identifiers for summary or custom summary formula fields in the report.Returns a list of bucket fields in the report.Returns information about cross filters applied to a report.Returns report currency, such as USD, EUR, or GBP, for an organization that has multicurrency enabled. The value is null if the organization does not have multicurrency enabled.Returns information about custom summary formulas in a report.Returns the description of the report.Returns unique API names (column names) for the fields that contain detailed data. For example, the method might return the following values: “OPPORTUNITY_NAME, TYPE, LEAD_SOURCE, AMOUNT.”Returns the report API name. For example, the method might return the following value: “Closed_Sales_This_Quarter.”Returns the division specified in the report.Returns column groupings in a report.Returns row groupings for a report.Indicates whether the report has detail rows.Indicates whether the report shows the total number of records.Returns a list of historical snapshot dates.Returns the unique report ID.Returns the report name.Returns logic to parse custom field filters. The value is null when filter logic is not specified.Returns a list of each custom filter in the report along with the field name, filter operator, and filter value.Returns the format of the report.Returns the unique API name and display name for the report type.Returns the API name for the scope defined for the report. Scope values depend on the report type.Indicates whether the report shows the grand total.Indicates whether the report shows subtotals, such as column or row totals.Returns the list of columns on which the report is sorted. Currently, you can sort on only one column.Returns information about the standard date filter for the report, such as the start date, end date, date range, and date field API name.Returns a list of standard filters for the report.Returns information about a row limit filter, including the number of rows returned and the sort order.Sets unique identifiers for standard or custom summary formula fields in the report.Creates bucket fields in a report.Applies cross filters to a report.Sets the currency, such as USD, EUR, or GBP, for report summary fields in an organization that has multicurrency enabled.Adds a custom summary formula to a report.Sets the description of the report.Sets the unique API names for the fields that contain detailed data—for example, OPPORTUNITY_NAME, TYPE, LEAD_SOURCE, or AMOUNT.Sets the report API name—for example, Closed_Sales_This_Quarter.Sets the division of the report.Sets column groupings in a report.Sets row groupings for a report.Specifies whether the report has detail rows.Specifies whether the report is configured to show the total number of records.Sets a list of historical snapshot dates.Sets the unique report ID.Sets the report name.Sets logic to parse custom field filters.Sets a list of each custom filter in the report along with the field name, filter operator, and filter value.Sets the format of the report.Sets the unique API name and display name for the report type.Sets the API name for the scope defined for the report. Scope values depend on the report type.Specifies whether the report shows the grand total.Specifies whether the report shows subtotals, such as column or row totals.Sets the list of columns on which the report is sorted. Currently, you can only sort on one column.Sets the standard date filter—which includes the start date, end date, date range, and date field API name—for the report.Sets one or more standard filters on the report.Applies a row limit filter to a report.
• ReportResults Class: Contains the results of running a report.Returns all report data.Returns summary-level data or summary and detailed data for each row or column grouping. Detailed data is available if the includeDetails parameter is set to true when the report is run.Returns a collection of column groupings, keys, and values.Returns a collection of row groupings, keys, and values.Returns information about whether the fact map has detail rows.Returns additional, detailed metadata about the report, including data type and label information for groupings and summaries.Returns metadata about the report, including grouping and summary information.
• ReportType Class: Contains the unique API name and display name for the report type.Returns the localized display name of the report type.Returns the unique identifier of the report type.
• ReportTypeColumn Class: Contains detailed report type metadata about a field, including data type, display name, and filter values.Returns the data type of the field.If the field data type is picklist, multi-select picklist, boolean, or checkbox, returns all filter values for a field. For example, checkbox fields always have a value of true or false. For fields of other data types, the filter value is an empty array, because their values can’t be determined.If the field is of a type that can’t be filtered, returns False. For example, fields of the type Encrypted Text can’t be filtered.Returns the localized display name of the field.Returns the unique API name of the field.
• ReportTypeColumnCategory Class: Information about categories of fields in a report type.Returns information for all fields in the report type. The information is organized by each section’s unique API name.Returns the localized display name of a section in the report type under which fields are organized. For example, in an Accounts with Contacts custom report type, Account General is the display name of the section that contains fields on general account information.
• SummaryValue Class: Contains summary data for a cell of the report.Returns the formatted summary data for a specified cell.Returns the numeric value of the summary data for a specified cell.
• DescribeColorResult Class: Contains color metadata information for a tab.Returns the Web RGB color code, such as 00FF00.Returns the color context. The context determines whether the color is the main color for the tab or not.Returns the color theme.
• DescribeIconResult Class: Contains icon metadata information for a tab.Returns the tab icon’s content type, such as image/png.Returns the tab icon’s height in pixels.Returns the tab’s icon theme.Returns the tab’s icon fully qualified URL.Returns the tab’s icon width in pixels.
• DescribeTabResult Class: Contains tab metadata information for a tab in a standard or custom app available in the Salesforce user interface.Returns a list of color metadata information for all colors associated with this tab. Each color is associated with a theme and context. Returns the URL for the main 32 x 32-pixel icon for a tab. This icon corresponds to the current theme (theme3) and appears next to the heading at the top of most pages.Returns a list of icon metadata information for all icons associated with this tab. Each icon is associated with a theme and context.Returns the display label of this tab.Returns the URL for the 16 x 16-pixel icon that represents a tab. This icon corresponds to the current theme (theme3) and appears in related lists and other locations.Returns the name of the sObject that is primarily displayed on this tab (for tabs that display a particular SObject).Returns a fully qualified URL for viewing this tab.Returns true if this is a custom tab, or false if this is a standard tab.
• DescribeTabSetResult Class: Contains metadata information about a Salesforce Classic standard or custom app available in the Salesforce user interface.Returns the display description for the standard or custom app.Returns the display label for the standard or custom app.Returns a fully qualified URL to the logo image associated with the standard or custom app.Returns the developer namespace prefix of a Salesforce AppExchange managed package.Returns metadata information about the standard or custom app’s displayed tabs.Returns true if this standard or custom app is the user’s currently selected app in Salesforce Classic. Otherwise, returns false.
• FlowPerformanceSetupDetails Class: The methods and properties in this class are for internal use only.
• B2BCheckoutController Class: Communicate with simple checkout Apex methods to work with data related to B2B Commerce checkout. If you implement your own cart-to-order process without invoking the Cart to Order flow core action, you must invoke this method to correctly track your orders for GMV (Gross Merchandise Value) recognition.
• IntegrationInfo Class: Provides the values that B2B Commerce Checkout uses to map requests to responses, necessary metadata, and context.The unique ID of a B2B Commerce integration.The ID of the job, specific to the Salesforce Background Operation framework. Site language to be used by third party services.
• IntegrationStatus Class: Supports synchronous execution of Apex integrations for B2B Commerce. The implementation must return the status of the execution.Indicates the status of the integration process and whether or not it completed successfully.
• LearningEvaluation Class: Contains methods to retrieve and update details that are required to evaluate a learning item.Retrieves the details associated with the learning evaluation instance.Retrieves the record ID of the learning item that's associated with this learning evaluation instance.Sets or updates the details of the learning item record for this learning evaluation instance.Sets or updates the learning item record ID for this learning evaluation instance.
• LearningEvaluationResult Class: Represents a user’s progress and progress status of a custom exercise in an Enablement program.Returns the progress percentage of the learning item.Retrieves the progress status of the learning item.Sets the progress percentage of the learning item.Sets the progress status of the learning item.
• LearningItemEvaluationHandler Class: Contains methods to customize the evaluation process of a learning item.Contains the custom logic for evaluating a learning item.
• LearningItemSerializeDeserializer Class: Serializes and deserializes the content associated with a custom exercise when migrating an Enablement program from one org to another.Deserializes the provided custom content string and returns the record ID of the learning item.Serializes the custom content associated with the specified learning item. The serialized string represents the metadata of the custom content and is used to recreate the custom content in the target Salesforce org during deployment.
• ConsumptionAlert Class: Represents a Digital Wallet consumption alert that's triggered for a consumption card.Creates a new instance of the ConsumptionAlert class using the specified trigger and notification details.The unit or measurement type of the value that triggered the alert.The numeric threshold that was crossed to trigger the alert, based on the alertTriggerType.The date and time the alert was created.Indicates whether a notification has been sent for this alert (true) or not (false).
• ConsumptionCard Class: Represents a Digital Wallet consumption card, including its consumption, total entitlement, and related consumption alerts.Creates a new instance of the ConsumptionCard class using the specified card details and alerts.The environment type of the org containing the card’s entitlement.The developer name for the consumption card.The consumption alerts already triggered for the consumption card.The total entitlement available for the consumption card.The number of units consumed for the consumption card.The buying model of the consumption card.
• QueryHandle Class: Tracks the runtime execution state of a Data 360 SQL query as it progresses through submission, execution, and result retrieval. Use QueryHandle to resume a previously submitted query from a saved query ID in a new SqlRowIterator or a new SqlQueueable job.Creates a QueryHandle from a previously submitted query ID and data space name. Use this method to resume fetching results for a query that was submitted in an earlier transaction.Returns a string representation of this QueryHandle.Sets the row offset at which to begin fetching results and returns the same QueryHandle instance for method chaining. Use this when resuming a query to skip rows that were already processed.Sets the workload name to use when fetching results and returns the same QueryHandle instance for method chaining.
• Row Class: Wraps a single Data 360 SQL query result row and provides typed accessor methods for retrieving column values by name or by 0-based index. Row instances are produced by SqlRowIterator and SqlQueueable; you don't construct Row objects directly during normal usage.Creates a Row from a raw API row and column metadata. In normal usage you don't construct Row objects directly — they're produced by SqlRowIterator and SqlQueueable.Returns the value of the column at the specified 0-based index as a Boolean. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a Boolean. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the 0-based index of the specified column name in the result set. Use this to look up an index once and then access multiple rows efficiently using index-based getters. Throws IllegalArgumentException if the column names are repeated in the table.Returns the value of the column at the specified 0-based index as a Date. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a Date. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the value of the column at the specified 0-based index as a Datetime. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a Datetime. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the value of the column at the specified 0-based index as a Decimal. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a Decimal. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the value of the column at the specified 0-based index as a Double. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a Double. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the value of the column at the specified 0-based index as an Integer. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as an Integer. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the value of the column at the specified 0-based index as a List<Object>. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a List<Object>. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the value of the column at the specified 0-based index as a Long. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a Long. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the value of the column at the specified 0-based index as an Object. Use this when the column type is unknown or when you need the raw untyped value. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as an Object. Use this when the column type is unknown or when you need the raw untyped value. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the underlying ConnectApi.QuerySqlRow object. Use this for direct access to the raw API response when the typed accessor methods don't meet your needs.Returns the value of the column at the specified 0-based index as a String. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a String. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns the value of the column at the specified 0-based index as a Time. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.Returns the value of the specified column as a Time. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.Returns a string representation of this Row.
• SqlQueueable Class: Abstract base class for executing long-running Data 360 SQL queries asynchronously in chained Queueable jobs. Implements Queueable and Database.AllowsCallouts. Create a concrete subclass that implements processDataChunk() to process each page of results and chainNextJob() to enqueue the next job when more data remains.Creates a SqlQueueable subclass instance that resumes an in-progress query from a saved QueryHandle. Use this constructor in chainNextJob() to continue processing the next page.Creates a SqlQueueable subclass instance from a SqlStatement to start a new query. Pass the constructed job to System.enqueueJob() to begin execution.Cancels the current query. When called inside processDataChunk(), the framework automatically skips chainNextJob(), stopping further job chaining.Abstract method called by the framework when more pages remain. Override this in your concrete subclass to enqueue the next job, passing the provided QueryHandle to the next job's constructor.Returns the ordered list of column names from the current data chunk. Call this inside processDataChunk().Returns the column metadata for the current data chunk, including column names and data types. Call this inside processDataChunk().Returns the raw ConnectApi.QuerySqlPageOutput for the current page. Use this inside processDataChunk() when you need direct access to the underlying API response instead of Row objects.Returns the server-assigned ID for this query. Save this value to resume the query in a later job using QueryHandle.create().Returns the rows in the current data chunk as an iterable of Row objects. Call this inside processDataChunk() to iterate over the page with typed accessor methods.Abstract method called by the framework with each page of query results. Override this in your concrete subclass to process the data chunk. Use getRows() or getPageOutput() to access the current page's data.Returns a string representation of this SqlQueueable.
• SqlRowIterator Class: Synchronous iterator for executing Data 360 SQL queries and retrieving results row-by-row within the current transaction. Implements Iterator<Row> and Iterable<Row> for use in both for-each and while loops. The iterator is single-use; once all rows are consumed, iterating again does not restart from the beginning.Creates a SqlRowIterator that resumes fetching results for a previously submitted query.Creates a SqlRowIterator from a SqlStatement. Equivalent to calling execute() on the statement.Cancels the query and releases server-side resources. Any subsequent call to hasNext() returns false.Returns the ordered list of column names from the query result set. Available after the first page of results is fetched.Returns the column metadata for the query result set, including column names and their data types. Available after the first page of results is fetched.Returns the server-assigned ID for this query. Triggers query submission if the query hasn't started yet. Save this value to resume the query in a later transaction using QueryHandle.create().Returns true if more rows remain to be fetched, or false if all rows have been consumed or the query was canceled.Returns this SqlRowIterator as an Iterator, enabling use in for-each loops.Returns the next Row in the result set. Throws NoSuchElementException if hasNext() is false.Returns a string representation of this SqlRowIterator.
• SqlStatement Class: Encapsulates the inputs required to execute a Data 360 SQL query against a data space. Build a statement from a raw SQL string or a pre-built ConnectApi.QuerySqlInput object, and then execute synchronously with SqlRowIterator or pass it to a SqlQueueable subclass for asynchronous processing.Creates a SqlStatement from a pre-built ConnectApi.QuerySqlInput object. Use this method when you need to configure query properties beyond a SQL string, such as parameterized queries, a server-side row limit, or custom query settings.Creates a SqlStatement from a raw SQL string and a data space name.Returns a synchronous SqlRowIterator built from this statement. Equivalent to new sfsqlquery.SqlRowIterator(statement). The query isn't submitted until iteration begins.Returns a string representation of this SqlStatement.Sets the workload name to send with the query and returns the same SqlStatement instance for method chaining. If not set, the framework uses dcsql_row_iterator_workload for iterators or dcsql_queueable_workload for queueables.
• SqlTester Class: Test utility for mocking Data 360 SQL query API responses in Apex tests. The framework automatically detects the test context via Test.isRunningTest() and returns mocked responses when configured. Call clearMocks() before each test to ensure a clean state.Resets all mock state, including metadata, rows, and page queues. Call this at the start of each test method to ensure a clean state.Adds a page of mock rows to the result queue. Call this multiple times to simulate multi-page results. Each call adds one page; pages are returned in the order they were enqueued.Returns true if the framework is currently executing within a test context. The framework calls this internally to decide whether to return mocked responses.Sets the mock column metadata that the framework returns for all queries in the current test. Call this before executing any query.Sets a single page of mock rows to return for the query. Use enqueueMockRows() instead when simulating multi-page results.
• Address Class: Contains methods for accessing the component fields of address compound fields.Returns the city field of this address.Returns the text-only country/territory name component of this address.Returns the country/territory code of this address if state and country/territory picklists are enabled in your organization. Otherwise, returns null.Returns the distance from this location to the specified location using the specified unit.When using geolocation data for a given address, this method gives you relative location information based on latitude and longitude values. For example, you can find out if the latitude and longitude values point to the middle of the street, instead of the exact address.Returns the latitude field of this address.Returns the longitude field of this address.Returns the postal code of this address.Returns the text-only state name component of this address.Returns the state code of this address if state and country/territory picklists are enabled in your organization. Otherwise, returns null.Returns the street field of this address.
• Location Class: Contains methods for accessing the component fields of geolocation compound fields.Calculates the distance between this location and the specified location, using an approximation of the haversine formula and the specified unit.Calculates the distance between the two specified locations, using an approximation of the haversine formula and the specified unit.Returns the latitude field of this location.Returns the longitude field of this location.Creates an instance of the Location class, with the specified latitude and longitude.
• Packaging Class: Contains a method for obtaining information about managed and unlocked packages.Returns the context packageID in managed and unlocked packages.
• Cases Class: Use the Cases class to interact with case records.
• EmailMessages Class: Use the methods in the EmailMessages class to interact with emails and email threading.
• QuickAction Class: Use Apex to request and process actions on objects that allow custom fields, on objects that appear in a Chatter feed, or on objects that are available globally.Returns metadata information for the available quick actions of the provided parent object.Returns the metadata information for the provided quick actions.Performs the quick action specified in the quick action request and returns the action result.Performs the quick action specified in the quick action request with the option for partial success, and returns the result.Performs the quick actions specified in the quick action request list and returns action results.Performs the quick actions specified in the quick action request list with the option for partial success, and returns action results.
• RemoteObjectController: Use RemoteObjectController to access the standard Visualforce Remote Objects operations in your Remote Objects override methods.Create a record in the database.Delete records from the database.Retrieve records from the database.Update records in the database.
• UserProvisioningLog Class: Provides methods for writing messages to monitor outbound user provisioning requests.Writes a specific message, such as an error message, to monitor the progress of a user provisioning request.Writes a specific status and message, such a status and detailed error message, to monitor the progress of a user provisioning request.Writes a specific message, such as an error message, to monitor the progress of a user provisioning request associated with a specific user.
• ProjectionNode Class: Add aggregate functions to the query, or define an alias.Returns the sum of a numeric field.Returns the average value of a numeric field.Returns the minimum value of a field.Returns the maximum value of a field.Returns the number of rows that match the query criteria.Returns the count of unique values.Define output column names.
• QueryBuilder Class: The QueryBuilder class provides methods for constructing well-formed SAQL queries to pass to CRM Analytics.Load a stream from a dataset.Calculate the number of rows that match the query criteria. Query by selecting specific attributes. Combine multiple result sets into one result set.Cogrouping means that two input streams are grouped independently and arranged side by side. Only data that exists in both groups appears in the results.
• QueryNode Class: Define each node of the query - such as projection, groups, order, filters. Execute the query.Build the query string represented by this QueryNode and assign it to a stream name.Applies a set of expressions to every row in a dataset. This action is often referred to as projection.Groups matched records (group by specific dataset attributes).Groups matched records (group by all).Sorts in ascending or descending order on one or more fields.Limits the number of results that are returned.Selects rows from a dataset based on a filter condition (a predicate).Selects rows from a dataset based on multiple filter conditions (predicates).Execute the query and return rows as JSON.
• Answers Class: Represents zone answers.Returns a list of similar questions based on the title of the specified question.Sets the specified reply for the specified question as the best reply. Because a question can have multiple replies, setting the best reply helps users quickly identify the reply that contains the most helpful information.
• BusinessHours Class: Use the BusinessHours methods to set the business hours at which your customer support team operates.Adds an interval of time from a start Datetime traversing business hours only. Returns the result Datetime in the local time zone.Adds an interval of milliseconds from a start Datetime traversing business hours only. Returns the result Datetime in GMT.Returns the difference in milliseconds between a start and end Datetime based on a specific set of business hours.Returns true if the specified target date occurs within business hours. Holidays are included in the calculation.Starting from the specified target date, returns the next date when business hours are open. If the specified target date falls within business hours, this target date is returned.
• ConnectApi Namespace: The ConnectApi namespace (also called Connect in Apex) provides classes for accessing the same data available in Connect REST API. Use Connect in Apex to create custom experiences in Salesforce.
• InboundEmail.BinaryAttachment Class: An InboundEmail object stores binary attachments in an InboundEmail.BinaryAttachment object.Creates a new instance of the Messaging.InboundEmail.BinaryAttachment class.The body of the attachment.The name of the attached file.Any header values associated with the attachment. Examples of header names include Content-Type, Content-Transfer-Encoding, and Content-ID.The primary and sub MIME-type.
• InboundEnvelope Class: The InboundEnvelope object stores the envelope information associated with the inbound email, and has the following fields.The name that appears in the From field of the envelope, if any.The name that appears in the To field of the envelope, if any.
• InboundEmail.Header Class: An InboundEmail object stores RFC 2822 email header information in an InboundEmail.Header object with the following properties.The name of the header parameter, such as Date or Message-ID.The value of the header.
• InboundEmail Class: Represents an inbound email object.Creates a new instance of the Messaging.InboundEmail class.A list of authentication results received with the email, if any.A list of binary attachments received with the email, if any. A list of carbon copy (CC) addresses, if any.The email address that appears in the From field.The name that appears in the From field, if any.A list of the RFC 2822 headers in the email.The HTML version of the email, if specified by the sender.Indicates whether the HTML body text is truncated (true) or not (false.)The In-Reply-To field of the incoming email. Identifies the email or emails to which this one is a reply (parent emails). Contains the parent email or emails' message-IDs.The Message-ID—the incoming email's unique identifier.The plain text version of the email, if specified by the sender.Indicates whether the plain body text is truncated (true) or not (false.)The References field of the incoming email. Identifies an email thread. Contains a list of the parent emails' References and message IDs, and possibly the In-Reply-To fields. The email address that appears in the reply-to header.The subject line of the email, if any.A list of text attachments received with the email, if any.The email address that appears in the To field.
• InboundEmailResult Class: The InboundEmailResult object is used to return the result of the email service. If this object is null, the result is assumed to be successful.A message that Salesforce returns in the body of a reply email. This field can be populated with text irrespective of the value returned by the Success field.A value that indicates whether the email was successfully processed.
• InboundEmail.TextAttachment Class: An InboundEmail object stores text attachments in an InboundEmail.TextAttachment object.Creates a new instance of the Messaging.InboundEmail.TextAttachment class.The body of the attachment.Indicates whether the attachment body text is truncated (true) or not (false.)The original character set of the body field. The body is re-encoded as UTF-8 as input to the Apex method.The name of the attached file.Any header values associated with the attachment. Examples of header names include Content-Type, Content-Transfer-Encoding, and Content-ID. The primary and sub MIME-type.
• EmailFileAttachment Class: EmailFileAttachment is used in SingleEmailMessage to specify attachments passed in as part of the request, as opposed to existing documents in Salesforce.Creates a new instance of the Messaging.EmailFileAttachment class.Gets or sets the attachment itself.Gets or sets the attachment's Content-Type.Gets or sets the name of the file to attach.Read-Only. Gets the attachment ID.Specifies a Content-Disposition of inline (true) or attachment (false).
• Email Class (Base Email Methods): Contains base email methods common to both single and mass email.Indicates whether the email sender receives a copy of the email that is sent. For a mass mail, the sender is only copied on the first email sent.Optional. The email address that receives the message when a recipient replies.The ID of the template to be merged to create this email. Specify a value for setTemplateId, setHtmlBody, or setPlainTextBody. Or, you can define both setHtmlBody and setPlainTextBody. Optional. The default value is true, meaning the email is saved as an activity. This argument only applies if the recipient list is based on targetObjectId or targetObjectIds. If HTML email tracking is enabled for the organization, you will be able to track open rates.Optional. The name that appears on the From line of the email. This cannot be set if the object associated with a setOrgWideEmailAddressId for a SingleEmailMessage has defined its DisplayName field.Indicates whether the email includes an email signature if the user has one configured. The default is true, meaning if the user has a signature it is included in the email unless you specify false.
• MassEmailMessage Class: Contains methods for sending mass email.Creates a new instance of the Messaging.MassEmailMessage class.The description of the email. A list of IDs of the contacts, leads, or users to which the email will be sent. The IDs you specify set the context and ensure that merge fields in the template contain the correct data. The objects must be of the same type (all contacts, all leads, or all users).Optional. If you specify a list of contacts for the targetObjectIds field, you can specify a list of whatIds as well. This helps to further ensure that merge fields in the template contain the correct data.
• Messaging Class: Contains messaging methods used when sending a single or mass email.Use this method in your email service code to control how to parse and process forwarded or attached emails. Returns an instance of Messaging.InboundEmail from a stream of data that is in RFC822 format. The data stream can be a forwarded email in an attachment to an existing InboundEmail, or a stream from another source.Reserves email capacity to send mass email to the specified number of email addresses, after the current transaction commits.Reserves email capacity to send single email to the specified number of email addresses, after the current transaction commits.Sends the list of emails instantiated with either SingleEmailMessage or MassEmailMessage and returns a list of SendEmailResult objects. When org preferences are set to save EmailMessage objects and a trigger is defined for EmailMessage objects, the trigger is fired for each SingleEmailMessage individually. The sendEmail method can be called 10 times per Apex transaction and each method invocation can include up to 100 "To", 25 "Cc", and 25 "Bcc" recipients. Sends draft email messages as defined by the specified email message IDs and returns a list of SendEmailResult objects.Replaces merge fields in text bodies of email templates with values from Salesforce records. Returns an array of RenderEmailTemplateBodyResult objects, each of which corresponds to an element in the supplied array of text bodies. Each RenderEmailTemplateBodyResult provides a success or failure indication, along with either an error code or the rendered text.Renders a text, custom, HTML, or Visualforce email template that exists in the database into an instance of Messaging.SingleEmailMessage. Includes all attachment content in the returned email message.Renders a text, custom, HTML, or Visualforce email template that exists in the database into an instance of Messaging.SingleEmailMessage. Provides options for including attachment metadata only, attachment metadata and content, or excluding attachments.Renders a text, custom, HTML, or Visualforce email template that exists in the database into an instance of Messaging.SingleEmailMessage. Provides options for including attachment metadata only, attachment metadata and content, or excluding attachments.
• SendEmailError Class: Represents an error that the SendEmailResult object may contain.A list of one or more field names. Identifies which fields in the object, if any, affected the error condition.The text of the error message. Returns a code that characterizes the error.The ID of the target record for which the error occurred.
• SendEmailResult Class: Contains the result of sending an email message.If an error occurred during the sendEmail method, a SendEmailError object is returned.Indicates whether the email was successfully submitted for delivery (true) or not (false). Even if isSuccess is true, it does not mean the intended recipients received the email, as there could have been a problem with the email address or it could have bounced or been blocked by a spam blocker.
• SingleEmailMessage Class: Contains methods for sending single email messages.Creates a new instance of the Messaging.SingleEmailMessage class.Returns the map of custom headers previously set for the email. Returns null if no custom headers were set.Optional. Returns a boolean value based on the value set by the setOneClickPost method. Default is false.The name of the template used to create the email.Optional. A list of blind carbon copy (BCC) addresses or object IDs of the contacts, leads, and users you’re sending the email to. The maximum size for this field is 4,000 bytes. The maximum total of toAddresses, ccAddresses, and bccAddresses per email is 150. All recipients in these three fields count against the limit for email sent using Apex or the API. Optional. A list of carbon copy (CC) addresses or object IDs of the contacts, leads, and users you’re sending the email to. The maximum size for this field is 4,000 bytes. The maximum total of toAddresses, ccAddresses, and bccAddresses per email is 150. All recipients in these three fields count against the limit for email sent using Apex or the API. Optional. The character set for the email. If this value is null, the user's default value is used.Optional. Sets custom headers to include in the outgoing email. Each header name must be prefixed with X-SFDC-X-. If a header name doesn’t have this prefix, Salesforce automatically adds it. Salesforce enforces this prefix to ensure security and compliance with internal protocols. All header names and values must comply with RFC 822 and RFC 5322 specifications. Avoid duplicate headers. (Deprecated. Use setEntityAttachments() instead.) Optional. A list containing the ID of each document object you want to attach to the email. Optional. Array of IDs of Document, ContentVersion, or Attachment items to attach to the email.Optional. A list containing the file names of the binary and text files you want to attach to the email.Optional. The HTML version of the email, specified by the sender. The value is encoded according to the specification associated with the organization. Specify a value for setTemplateId, setHtmlBody, or setPlainTextBody. Or, you can define both setHtmlBody and setPlainTextBody. Sets the optional In-Reply-To field of the outgoing email. This field identifies the email or emails to which this email is a reply (parent emails).Optional. If set to true, a List-Unsubscribe-Post header is added to an email with List-Unsubscribe=One-Click. Use this method to support unsubscribe functionality in email sent via Salesforce. You can provide additional instructions on how to send unsubscribe requests by using the header. This includes specifying the HTTP method and content type to use and provides a secure way to add more info to unsubscribe requests. Default is false.Optional. If you added recipients by ID instead of email address and the Email Opt Out option is set, this method determines the behavior of the sendEmail() call. If you add recipients by their email addresses, the opt-out settings for those recipients aren’t checked and those recipients always receive the email.Optional. The text version of the email, specified by the sender. Specify a value for setTemplateId, setHtmlBody, or setPlainTextBody. Or, you can define both setHtmlBody and setPlainTextBody. Optional. The ID of the organization-wide email address associated with the outgoing email. If you’re using Apex to send emails from the guest user, set the sender to the verified org-wide email address or the emails are blocked. The object's DisplayName field cannot be set if the setSenderDisplayName field is already set.Optional. The References field of the outgoing email. Identifies an email thread. Contains the parent emails' References and message IDs, and possibly the In-Reply-To fields.Optional. The email subject line. If you are using an email template, the subject line of the template overrides this value.Required if using a template, optional otherwise. The ID of the contact, lead, or user to which the email will be sent. The ID you specify sets the context and ensures that merge fields in the template contain the correct data.Required if using a template, optional otherwise. The ID of the template used to create the email.Optional. A list of email addresses or object IDs of the contacts, leads, and users you’re sending the email to. The maximum size for this field is 4,000 bytes. The maximum total of toAddresses, ccAddresses, and bccAddresses per email is 150. All recipients in these three fields count against the limit for email sent using Apex or the API. Optional. If set to true, the subject, plain text, and HTML text bodies of the email are treated as template data. The merge fields are resolved using the renderEmailTemplate method. Default is false.Optional. If set to true, the targetObjectId (a contact, lead, or user) is the recipient of the email. If set to false, the targetObjectId is supplied as the WhoId field for template rendering but isn’t a recipient of the email. The default is true.Optional. Sets a comment in the List-Unsubscribe email header. This comment is ignored by email clients and systems that parse the header. The comments contain human-readable notes or context for developers, administrators, or other stakeholders managing the email system.Optional. Sets a mailto URI and HTTP URL of a mechanism for unsubscribing a recipient from an email list. A list of all unsubscribe URLs passed through setUnsubscribeUrls is added to the List-Unsubscribe header. A minimum of one URL is required to use this method.If you specify a contact for the targetObjectId field, you can specify an optional whatId as well. This helps to further ensure that merge fields in the template contain the correct data.
• Exception Class and Built-In Exceptions: An exception denotes an error that disrupts the normal flow of code execution. You can use Apex built-in exceptions or create custom exceptions. All exceptions have common methods.
• Ideas Class: Represents zone ideas.Returns a list of similar ideas based on the title of the specified idea.Returns ideas that have recent replies for the specified user or zone. This includes all read and unread replies.Returns ideas that have recent replies marked as read.Returns ideas that have recent replies marked as unread.Marks all comments as read for the user that is currently logged in.
• PublishingService Class: Use the methods in the KbManagement.PublishingService class to manage the lifecycle of an article and its translations.Archives an online version of an article. If the specified scheduledDate is null, the article is archived immediately. Otherwise, it archives the article on the scheduled date. Assigns a review task related to a draft article. Assigns a review task related to a draft translation. Cancels the scheduled archiving of an online article. Cancels the scheduled publication of a draft article. Puts a translation in a completed state that is ready to publish. Deletes an archived article.Deletes a specific archived version of a published article.Deletes a draft article. Deletes a draft translation. Creates a draft article from the archived primary version and returns the new draft primary version ID of the article. Creates a draft article from the online version and returns the new draft primary version ID of the article. Also, unpublishes the online article, if unpublish is set to true. Creates a draft version of the online translation for a specific language and returns the new draft primary version ID of the article. Also, unpublishes the article, if set to true. Publishes an article. If flagAsNew is set to true, the article is published as a major version. Creates a draft article from an existing online article based on the specified archived version of the article and returns the article version ID.Schedules the article for publication as a major version. If the specified date is null, the article is published immediately. Sets a draft translation that is ready for publication back to “in progress” status.Submits an article for translation to the specified language. Also assigns the specified user and due date to the submittal and returns new ID of the draft translation.
• Network Class: Manage Experience Cloud sites.Create an instance of the System.Network class.Creates a new instance of the System.Network class.Get the default landing page, login page, and self-registration page of a site. Asynchronously create site users and records. Get the login and logout URLs for a site. Get a user’s current site. Map dashboards and Insights reports.Returns a Page Reference to the default landing page for the Experience Cloud site. This is the first tab of the site.Asynchronously creates an Experience Cloud site user for the given account or contact and associates it with the site. This method processes requests in batches and then sends an email with login information to the user.Asynchronously creates case, lead, and custom object records. This method collects record creation requests and processes them in batches.Returns a Page Reference to the default login page. StartURL is included as a query paremeter for where to redirect after a successful login.Returns the absolute URL of the login page used by the Experience Cloud site.Returns the absolute URL of the logout page used by the Experience Cloud site.Returns the user’s current Experience Cloud site.Returns the absolute URL of the self-registration page used by the Experience Cloud site. Maps the dashboards from the Salesforce Communities Management package onto each Experience Cloud site’s unconfigured dashboard settings. Returns the number of settings it configures. Maps the Insights reports from the Salesforce Communities Management package onto each Experience Cloud site’s unconfigured Insights settings. Returns the number of settings it configures.
• Matcher Class: Matchers use Patterns to perform match operations on a character string.Returns the position after the last matched character.Returns the position after the last character of the subsequence captured by the group index during the previous match operation. If the match was successful but the group itself did not match anything, this method returns -1. Attempts to find the next subsequence of the input sequence that matches the pattern. This method returns true if a subsequence of the input sequence matches this Matcher object's pattern. Resets the Matcher object and then tries to find the next subsequence of the input sequence that matches the pattern. This method returns true if a subsequence of the input sequence matches this Matcher object's pattern.Returns the input subsequence returned by the previous match.Returns the input subsequence captured by the specified group index during the previous match operation. If the match was successful but the specified group failed to match any part of the input sequence, null is returned.Returns the number of capturing groups in this Matching object's pattern. Group zero denotes the entire pattern and is not included in this count. Returns true if the Matcher object has anchoring bounds, false otherwise. By default, a Matcher object uses anchoring bounds regions. Returns true if the Matcher object has transparent bounds, false if it uses opaque bounds. By default, a Matcher object uses opaque region boundaries. Returns true if the end of input was found by the search engine in the last match operation performed by this Matcher object. When this method returns true, it is possible that more input would have changed the result of the last search. Attempts to match the input sequence, starting at the beginning of the region, against the pattern. Attempts to match the entire region against the pattern. Returns the Pattern object from which this Matcher object was created. Returns a literal replacement string for the specified string inputString. The characters in the returned string match the sequence of characters in inputString. Sets the limits of this Matcher object's region. The region is the part of the input sequence that is searched to find a match.Returns the end index (exclusive) of this Matcher object's region.Returns the start index (inclusive) of this Matcher object's region.Replaces every subsequence of the input sequence that matches the pattern with the replacement string.Replaces the first subsequence of the input sequence that matches the pattern with the replacement string.Returns true if more input could change a positive match into a negative one. Resets this Matcher object. Resetting a Matcher object discards all of its explicit state information. Resets this Matcher object with the new input sequence. Resetting a Matcher object discards all of its explicit state information.Returns the start index of the first character of the previous match. Returns the start index of the subsequence captured by the group specified by the group index during the previous match operation. Captured groups are indexed from left to right, starting at one. Group zero denotes the entire pattern, so the expression m.start(0) is equivalent to m.start().Sets the anchoring bounds of the region for the Matcher object. By default, a Matcher object uses anchoring bounds regions.Changes the Pattern object that the Matcher object uses to find matches. This method causes the Matcher object to lose information about the groups of the last match that occurred. The Matcher object's position in the input is maintained.Sets the transparency bounds for this Matcher object. By default, a Matcher object uses anchoring bounds regions.
• Pattern Class: Represents a compiled representation of a regular expression.Compiles the regular expression into a Pattern object. Creates a Matcher object that matches the input string stringtoMatch against this Pattern object. Compiles the regular expression regExp and tries to match it against the specified string. This method returns true if the specified string matches the regular expression, false otherwise. Returns the regular expression from which this Pattern object was compiled. Returns a string that can be used to create a pattern that matches the string yourString as if it were a literal pattern. Returns a list that contains each substring of the String that matches this pattern. Returns a list that contains each substring of the String that is terminated either by the regular expression regExp that matches this pattern, or by the end of the String.
• PushNotification Class: PushNotification is used to configure push notifications and send them from an Apex trigger.
• PushNotificationPayload Class: Contains methods to create the notification message payload for an Apple device.
• Crypto Class: Provides methods for creating digests, message authentication codes, and signatures, as well as encrypting and decrypting information.Decrypts a JWE (JSON Web Encryption) token using ECDH-ES key agreement with AES Key Wrap algorithms. Use this method to decrypt ID tokens from identity providers (e.g., Singpass, Corppass) that use JWE for additional security.Decrypts the encryptedData blob by using the specified algorithm, private key, and initialization vector. Use this method to decrypt blobs encrypted by using a third-party application or the encrypt method.Decrypts the IVAndCipherText blob by using the specified algorithm and private key. Use this method to decrypt blobs encrypted by using a third-party application or the encryptWithManagedIV method. This version of decryptWithManagedIV doesn’t use additional authentication data. Decrypts the IVAndCipherText blob by using the specified algorithm and private key. Use this method to decrypt blobs encrypted by using a third-party application or the encryptWithManagedIV method. This version of decryptWithManagedIV uses additional authentication data. CBC isn’t supported for this method. Encrypts plaintext using ECDH-ES key agreement with AES Key Wrap algorithms, producing a JWE token. Use this method for encrypting sensitive data that only the recipient can decrypt.Encrypts the clearData blob by using the specified algorithm, private key, and initialization vector. Use this method when you want to specify your own initialization vector.Encrypts the clearText blob by using the specified algorithm and private key. Use this method when you want Salesforce to generate the initialization vector. This version of encryptWithManagedIV doesn’t use additional authentication data.Encrypts the clearText blob by using the specified algorithm and private key. Use this method when you want Salesforce to generate the initialization vector. This version of encryptWithManagedIV uses additional authentication data. CBC isn’t supported for this method.Generates an Advanced Encryption Standard (AES) key.Computes a secure, one-way hash digest using the specified algorithm on the supplied input blob. Generates an asymmetric cryptographic key pair for digital signatures, key agreement protocols (ECDH), or DPoP token generation. The returned blob contains both keys; extract them using getPrivateKey() and getPublicKey() methods.Computes a message authentication code (MAC) for the input blob value using the private key and the specified algorithm.Extracts the private key from a combined key pair blob returned by generateKeyPair(). Extracts the public key from a combined key pair blob returned by generateKeyPair(). Returns a random integer value.Returns a random long value.Parses a JWE (JSON Web Encryption) compact serialization token and returns a structured JweToken object containing all components needed for decryption. Use this method as an alternative to manually parsing the JWE compact serialization string.Computes a unique digital signature for the input blob value, using the specified algorithm and the supplied private key.Computes a unique digital signature for the input blob value, using the specified algorithm and the supplied certificate and key pair.Envelops the signature into an XML document.Inserts the signature envelope before the specified child node.Verifies the digital signature for the data blob using the specified algorithm and the supplied public key. Use this method to verify a blob signed by a digital signature created using a third-party application or the sign method.Verifies the digital signature for the data blob using the specified algorithm and the public key associated with certDevName. Use this method to verify a blob signed by a digital signature created using a third-party application or the signWithCertificate method. Verifies the HMAC signature for the data blob using the specified algorithm, input data, private key, and the mac. Use this method to verify a blob signed by a digital signature created using a third-party application or the sign method.
• EncodingUtil Class: Use the methods in the EncodingUtil class to encode and decode URL strings, and convert strings to hexadecimal format. Converts a Base64-encoded String to a Blob representing its normal form.Converts a Blob to an unencoded String representing its normal form.Converts the specified hexadecimal (base 16) string to a Blob value and returns this Blob value.Returns a hexadecimal (base 16) representation of the inputBlob. This method can be used to compute the client response (for example, HA1 or HA2) for HTTP Digest Authentication (RFC2617). Decodes a string in application/x-www-form-urlencoded format using a specific encoding scheme, for example “UTF-8.”Encodes a string into the application/x-www-form-urlencoded format using a specific encoding scheme, for example “UTF-8.”
• Http Class: Use the Http class to initiate an HTTP request and response.Sends an HttpRequest and returns the response.Returns a string that displays and identifies the object's properties.
• HttpRequest Class: Use the HttpRequest class to programmatically create HTTP requests like GET, POST, PATCH, PUT, and DELETE.Creates a new instance of the HttpRequest class.Retrieves the body of this request.Retrieves the body of this request as a Blob.Retrieves the body of this request as a DOM document.If true, the request body is compressed, false otherwise. Retrieves the URL for the endpoint of the external server for this request.Retrieves the contents of the request header.Returns the type of method used by HttpRequest.Sets the contents of the body for this request.Sets the contents of the body for this request using a Blob.Sets the contents of the body for this request. The contents represent a DOM document.This method is deprecated. Use setClientCertificateName instead.If the external service requires a client certificate for authentication, set the certificate name.If true, the data in the body is delivered to the endpoint in the gzip compressed format. If false, no compression format is used.Specifies the endpoint for this request.Sets the contents of the request header.Sets the type of method to be used for the HTTP request.Sets a timeout for the request between 1 and 120,000 milliseconds. The timeout is the maximum time to wait for establishing the HTTP connection. The same timeout is used for waiting for the request to start. When the request is executing, such as retrieving or posting data, the connection is kept alive until the request finishes.Returns a string containing the URL for the endpoint of the external server for this request and the method used, for example, Endpoint=http://YourServer, Method=POST
• HttpResponse Class: Use the HttpResponse class to handle the HTTP response returned by the Http class.Retrieves the body returned in the response.Retrieves the body returned in the response as a Blob.Retrieves the body returned in the response as a DOM document.Retrieves the contents of the response header.Retrieves an array of header keys returned in the response.Retrieves the status message returned for the response.Retrieves the value of the status code returned in the response.Returns an XmlStreamReader that parses the body of the callout response.Specifies the body returned in the response.Specifies the body returned in the response using a Blob.Specifies the contents of the response header.Specifies the status message returned in the response.Specifies the value of the status code returned in the response.Returns the status message and status code returned in the response, for example:
• Site Class: Use the Site Class to manage your sites. Change, reset, validate, and check the expiration of passwords. Create site users, person accounts, and portal users. Get the admin email and ID. Get various URLs, the path prefix, the ID, the template, and the type of the site. Log in to the site.Changes the password of the current user.Creates a Salesforce Site or Experience Cloud site user for the given account and associates it with the site.Creates a Salesforce Site or Experience Cloud site user for the given account and associates it with the site. This method sends an email with the specified password to the user.Creates a Salesforce Site or Experience Cloud site user and associates it with the given account. This method sends the user an email with the specified password and a new user confirmation email.Creates a person account using the default record type defined on the guest user's profile, then enables it for the site's portal.Creates a person account using the specified recordTypeID, then enables it for the site's portal.Creates a portal user for the given account and associates it with the site's portal. Resets the user's password and sends an email to the user with the user’s new password. You can specify a custom email template or use the default email template. Returns a value indicating whether the password reset was successful.Resets the user's password and sends an email to the user with the user’s new password. Returns a value indicating whether the password reset was successful.Returns the email address of the site administrator.Returns the user ID of the site administrator.The tracking code associated with your site. Services such as Google Analytics can use this code to track page request data for your site.Deprecated. This method was replaced by getBaseUrl() in API version 30.0. Returns the base URL of the current site that references and links should use.Returns a base URL for the current site that doesn’t use a force.com subdomain. The returned URL uses the same protocol (HTTP or HTTPS) as the current request if at least one non-Force.com custom URL that supports HTTPS exists on the site. The returned value never ends with a / character. If all the custom URLs in this site end in Force.com or this site has no custom URLs, then this returns an empty string. If the current request is not a site request, then this method returns an empty string. This method replaced getCustomWebAddress and includes the custom URL's path prefix..Deprecated. Returns a base URL for the current site that uses HTTP instead of HTTPS. The current request's domain is used. The returned value includes the path prefix and never ends with a / character. If the current request is not a site request, then this method returns an empty string.Returns the base URL of the current site for the requested URL. This isn't influenced by the referring page's URL. The returned URL uses the same protocol (HTTP or HTTPS) as the current request. The returned value includes the path prefix and never ends with a / character. If the current request is not a site request, then this method returns an empty string.Returns a base URL for the current site that uses HTTPS instead of HTTP. The current request's domain is preferred if it supports HTTPS. Domains that are not Force.com subdomains are preferred over Force.com subdomains. A Force.com subdomain, if associated with the site, is used if no other HTTPS domains exist in the current site. If no HTTPS custom URLs exist in the site, then this method returns an empty string. The returned value includes the path prefix and never ends with a / character. If the current request is not a site request, then this method returns an empty string.Returns the base URL of the current site that references and links should use. Note that this field may return the referring page's URL instead of the current request's URL. The returned value includes the path prefix and never ends with a / character. If the current request is not a site request, then this field returns an empty string. This field replaces getCurrentSiteUrl.Deprecated. This method was replaced by getBaseCustomUrl() in API version 30.0.Returns your Salesforce Sites based URL.Returns the error description for the current page if it’s a designated error page for the site and an error exists; otherwise, returns an empty string.Returns an error message for the current page if it’s a designated error page for the site and an error exists; otherwise, returns an empty string.Returns the value of the experience ID (expid). This expid value comes from a cookie in the user’s web browser.Returns the value of the Master Label field for the current site. If the current request is not a site request, then this field returns null.Returns the API name of the current site.Returns the original URL for this page if it’s a designated error page for the site; otherwise, returns null.Returns the password requirements for a Salesforce Site or Experience Cloud site created with the Customer Service template.Returns the URL path prefix of the current site or an empty string if none. For example, if the requested site URL is https://myco.my.salesforce-sites.com/partners, then /partners is the path prefix. If the current request is not a site request, then this method returns an empty string. This method replaced getPrefix in API version 30.0.Deprecated. This method was replaced by getPathPrefix() in API version 30.0.Returns the ID of the current site. If the current request is not a site request, then this field returns null.Returns the template name associated with the current site; returns the default template if no template has been designated.Returns the API value of the site type field for the current site. This can be Visualforce for a Salesforce site, Siteforce for a Site.com site, ChatterNetwork for an Experience Cloud site, or ChatterNetworkPicasso for an Experience Cloud site. If the current request is not a site request, then this method returns null.Returns the value of the Site Type field's label for the current site. If the current request is not a site request, then this method returns null.Returns true if the current site is associated with an active login-enabled portal; otherwise returns false.For authenticated users, returns true if the currently logged-in user's password is expired. For non-authenticated users, returns false.Returns true if the current site is associated with an active self-registration-enabled Customer Portal; otherwise returns false.Returns true if the given username is valid; otherwise, returns false.Allows users to log in to the current site with the given username and password, then takes them to the startUrl. If startUrl is not a relative path, it defaults to the site's designated index page.Logs in a user to a Salesforce Site or Experience Cloud site using an identity verification method, such as email or text, instead of a password. Passwordless login is a convenient, mobile-centric way to welcome users into your site. Let your users log in with something other than their password, like their email address or phone number.Sets the experience ID for the current user. Use this method to populate the value of the experience ID (expid) cookie in the user’s web browser.Sets the specified user information within the site’s portal via an authentication provider.Indicates whether a given password meets the requirements specified by org-wide or profile-based password policies in the current user’s org.
• Cookie Class: The Cookie class lets you access cookies for your Salesforce site using Apex.Creates a new instance of the Cookie class using the specified name, value, path, age, and the secure setting.Creates a new instance of the Cookie class using the specified name, value, path, and age, and settings for security and cross-domain behavior.Creates a new instance of the Cookie class using the specified name, value, path, age, and settings for security, cross-domain behavior, and JavaScript access.Returns the name of the server making the request.Returns a number representing how long the cookie is valid for, in seconds. If set to < 0, a session cookie is issued. If set to 0, the cookie is deleted.Returns the name of the cookie. Can't be null.Returns the path from which you can retrieve the cookie. If null or blank, the location is set to root, or “/”.Returns the value for the SameSite attribute of the cookie.Returns the data captured in the cookie, such as Session ID.Returns true if the cookie can only be accessed through HTTPS, otherwise returns false.Returns true if client-side JavaScript is forbidden from accessing the cookie; otherwise returns false.
• XmlStreamReader Class: The XmlStreamReader class provides methods for forward, read-only access to XML data. You can pull data from XML or skip unwanted events. You can parse nested XML content that’s up to 50 nodes deep.Creates a new instance of the XmlStreamReader class for the specified XML input.Returns the number of attributes on the start element, excluding namespace definitions. Returns the local name of the attribute at the specified index. Returns the namespace URI of the attribute at the specified index. Returns the prefix of this attribute at the specified index. Returns the XML type of the attribute at the specified index. Returns the value of the attribute in the specified localName at the specified URI. Returns the value of the attribute at the specified index. Returns the type of XML event the cursor is pointing to.Returns the local name of the current event. Return the current location of the cursor. If the current event is a start element or end element, this method returns the URI of the prefix or the default namespace. Returns the number of namespaces declared on a start element or end element. Returns the prefix for the namespace declared at the index. Return the URI for the given prefix. Returns the URI for the namespace declared at the index. Returns the data section of a processing instruction.Returns the target section of a processing instruction.Returns the prefix of the current XML event or null if the event does not have a prefix.Returns the current value of the XML event as a string. Returns the XML version specified on the XML declaration. Returns null if none was declared.Returns true if the current XML event has a name. Returns false otherwise. Returns true if there are more XML events and false if there are no more XML events. Returns true if the current event has text, false otherwise.Returns true if the cursor points to a character data XML event. Otherwise, returns false.Returns true if the cursor points to an end tag. Otherwise, it returns false.Returns true if the cursor points to a start tag. Otherwise, it returns false.Returns true if the cursor points to a character data XML event that consists of all white space. Otherwise it returns false.Reads the next XML event. A processor may return all contiguous character data in a single chunk, or it may split it into several chunks. Returns an integer which indicates the type of event. Skips any white space (the isWhiteSpace method returns true), comment, or processing instruction XML events, until a start element or end element is reached. Returns the index for that XML event. If you specify true for returnAsSingleBlock, text is returned in a single block, from a start element to the first end element or the next start element, whichever comes first. If you specify it as false, the parser may return text in multiple blocks.If you specify true for isNamespaceAware, the parser recognizes namespace. If you specify it as false, the parser does not. The default value is true.Returns a string containing the length of the input XML given to XmlStreamReader and the first 50 characters of the input XML.
• XmlStreamWriter Class: The XmlStreamWriter class provides methods for writing XML data.Creates a new instance of the XmlStreamWriter class.Closes this instance of an XmlStreamWriter and free any resources associated with it.Returns the XML written by the XmlStreamWriter instance.Binds the specified URI to the default namespace. This URI is bound in the scope of the current START_ELEMENT – END_ELEMENT pair.Writes an attribute to the output stream.Writes the specified CData to the output stream.Writes the specified text to the output stream.Writes the specified comment to the output stream.Writes the specified namespace to the output stream.Writes an empty element tag to the output stream.Closes any start tags and writes corresponding end tags to the output stream.Writes an end tag to the output stream, relying on the internal state of the writer to determine the prefix and local name.Writes the specified namespace to the output stream.Writes the specified processing instruction.Writes the XML Declaration using the specified XML encoding and version.Writes the start tag specified by localName to the output stream.
• Document Class: Use the Document class to process XML content. You can parse nested XML content that’s up to 50 nodes deep.Creates a new instance of the Dom.Document class.Creates the top-level root element for a document.Returns the top-level root element node in the document. If this method returns null, the root element has not been created yet.Parse the XML representation of the document specified in the xml argument and load it into a document.Returns the XML representation of the document as a String.
• XmlNode Class: Use the XmlNode class to work with a node in an XML document.Creates a child element node for this node.Creates a child comment node for this node. Creates a child text node for this node. Returns namespacePrefix:attributeValue for the given key and key namespace.Returns the number of attributes for this node.Returns the attribute key for the given index. Index values start at 0.Returns the attribute key namespace for the given index.Returns the attribute value for the given key and key namespace.Returns the attribute value namespace for the given key and key namespace.Returns the child element node for the node with the given name and namespace.Returns the child element nodes for this node. This doesn't include child text or comment nodes. Returns the child nodes for this node. This includes all node types. Returns the element name.Returns the namespace of the element. Returns the namespace of the element for the given prefix. Returns the node type.Returns the parent of this element.Returns the prefix of the given namespace.Returns the text for this node.Inserts a new child node before the specified node. Removes the attribute with the given key and key namespace. Returns true if successful, false otherwise. Removes the given child node.Sets the key attribute value.Sets the key attribute value. Sets the namespace for the given prefix.
• alternativePaymentMethod: The alternative payment method object used in a postauthorizaiton payment method request.
• setAuthorizationExpirationDate(authExpDate): Sets the expiration date of the authorization request.
• setGatewayResultCodeDescription(gatewayResultCodeDescription): Sets a description of the gateway-specific result code that a payment gateway returned. Maximum length of 1000 characters.
• cardPaymentMethod: The card payment method object used in a postauthorizaiton payment method request.
• PostAuthApiPaymentMethodRequest Constructors: Lists the constructors for the PostAuthApiPaymentMethodRequest.
• PostAuthApiPaymentMethodRequest(cardPaymentMethodRequest): Constructs a sample cardPaymentMethodRequest. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.
• PostAuthApiPaymentMethodRequest(): Constructor for PostAuthApiPaymentMethodRequest.
• PostAuthApiPaymentMethodRequest(AlternativePaymentMethodRequest): Constructs a sample alternativePaymentMethodRequest. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.
• PostAuthApiPaymentMethodRequest Properties: Lists the properties for PostAuthApiPaymentMethodRequest.
• accountId: The customer account that is settled when the postauthorization is performed.
• amount: The total amount of the postauthorization request.
• comments: Comments about the postauthorization. Users can enter comments to provide additional information.
• PostAuthorizationRequest Constructors: Lists the constructors for postauthorization requests.
• PostAuthorizationRequest(amount): Constructor for building the amount in a postauthorization request. This constructor is intended for test usage and throws an exception if used outside of the Apex test context.
• currencyIsoCode: The ISO currency code for the postauthorization request.
• paymentMethod: The payment method used to process the postauthorization request.
• PostAuthorizationRequest Properties: Lists properties for a postauthorizaiton request.
• PostAuthorizationResponse Methods: Lists the methods for the PostAuthorizationResponse.
• setAlternativePaymentMethodResponse(AlternativePaymentMethodResponsealternativePaymentMethod): Sets details from the gateway about the authorized alternative payment method.
• setAmount(amount): Sets the amount for payment authorization. Can be positive, negative, or zero.
• setAsync(async): Sets whether the payment capture or authorization is asynchronous (True) or synchronous (False). If True, then the payment or payment authorization record created has a status of Pending.
• setGatewayAuthCode(gatewayAuthCode): Sets the authorization code that the gateway returned. Maximum length of 64 characters.
• setGatewayAvsCode(gatewayAvsCode): Sets the AVS (address verification system) result code information that the gateway returned. Maximum length of 64 characters.
• setGatewayDate(gatewayDate): Sets the date that the authorization occurred. Some gateways don’t send this value.
• setGatewayMessage(gatewayMessage): Sets error messages that the gateway returned for the tokenization request. Maximum length of 255 characters.
• setGatewayReferenceDetails(gatewayReferenceDetails): Sets any additional reference details that the gateway returned.
• setGatewayReferenceNumber(gatewayReferenceNumber): Sets the reference number that the gateway returned.
• setGatewayResultCode(gatewayResultCode): Sets a gateway-specific result code. The code may be mapped to a Salesforce-specific result code. Maximum length of 64 characters.
• setPaymentMethodDetails(paymentMethodDetails): Sets details about the payment method.
• setPaymentMethodTokenizationResponse(paymentMethodTokenizationResponse): Sets information from the gateway about the tokenized payment method.
• setSalesforceResultCodeInfo(salesforceResultCodeInfo): Sets the Salesforce-specific result code information. Payment gateways have many response codes for payment calls. Salesforce uses the result code information to map payment gateway codes to a predefined set of standard Salesforce result codes.
• Comparable Interface: Adds sorting support for Lists that contain non-primitive types, that is, Lists of user-defined types. Your implementation must explicitly handle null inputs in the compareTo() method to avoid a null pointer exception.Returns an Integer value that is the result of the comparison.
• ConnectApi Input Classes: Some ConnectApi methods take arguments that are instances of ConnectApi input classes.
• ConnectApi.FeedItemAttachmentInput: Used to attach a file to a feed item.
• ConnectApi.NewFileAttachmentInput: Attach a new file to a feed item.
• ConnectApi.PhotoInput: Specify how to crop a photo that has already been uploaded.
• ConnectApi.PollAttachmentInput: Attach a poll to a feed item.
• ConnectApi.TopicInput: Update a topic’s name or description or merge topics.
• ConnectApi.TextSegmentInput: Include a text segment in a feed item or comment.
• ConnectApi.AbstractBaseSequenceInputRepresentation: The sequence for refunds and payment credits.
• ConnectApi.AbstractCheckoutAddressInput: A checkout address.
• ConnectApi.AbstractList: Primitive list input.
• ConnectApi.ActionInfoInputRepresentation: Recommended action information.
• ConnectApi.ActionLinkDefinitionInput: The definition of an action link. An action link is a button on a feed element. Clicking an action link can take a user to a Web page, initiate a file download, or invoke an API call to Salesforce or to an external server. An action link includes a URL and an HTTP method, and can include a request body and header information, such as an OAuth token for authentication. Use action links to integrate Salesforce and third-party services into the feed so that users can drive productivity and accelerate innovation.
• ConnectApi.ActionLinkGroupDefinitionInput: The definition of an action link group. All action links must belong to a group. Action links in a group are mutually exclusive and share some properties. Define standalone actions in their own action group.
• ConnectApi.ActionLinkTemplateBindingInput: A key-value pair to fill in a binding variable value from an action link template.
• ConnectApi.ActivationAdditionalAttributesConfigInput: Represents the additional attributes configuration for the market segment activation input.
• ConnectApi.ActivationContactPointInput: Represents the activation contact point input.
• ConnectApi.ActivationDefinitionInput: Represents the activation definition input.
• ConnectApi.ActivationTargetInput: Input details for the activation target.
• ConnectApi.ActivationTargetSubjectConfigInput: Represents the activation target subject configuration input.
• ConnectApi.ActivitySharingInput: Defines who a captured email or event is shared with.
• ConnectApi.AddressRequest: Address input representation for a payment method or card payment method.
• ConnectApi.TaxAddressesRequest: Addresses, including the Bill To address, Ship From address, Ship to address, and Sold To address.
• ConnectApi.AdjustItemInputRepresentation: A price adjustment to an OrderItemSummary. It only supports discounts, not increases.
• ConnectApi.AdjustOrderItemSummaryInputRepresentation: Price adjustments to order item summaries that together make up a price adjustment to an order, with options for adjusting items in the process of being fulfilled.
• ConnectApi.AlternativeInput: Alternative representation for an extension on a feed element.
• ConnectApi.AlternativePaymentMethod: A payment method that doesn't have a defined Salesforce entity such as CardPaymentMethod or DigitalWallet. Common examples of alternative payment methods include CashOnDeliver, Klarna, and Direct Debit. AlternativePaymentMethod functions the same as any other type of payment method for processing transactions in the payment gateway.
• ConnectApi.AnnouncementInput: An announcement.
• ConnectApi.ArticleTopicAssignmentJobInput: An article and topic assignment job.
• ConnectApi.AssignedResourcesInput: Contains information about assigned resources for a service appointment.
• ConnectApi.AssociatedActionsCapabilityInput: A list of action link groups to associate with a feed element. To associate an action link group with a feed element, the call must be made from the Apex namespace that created the action link definition. In addition, the user making the call must have created the definition or have View All Data permission.
• ConnectApi.AttributeFilterInput: Represents the attribute filter input.
• ConnectApi.AttributeLimitingExpressionInput: Represents the limiting expression input for an activation.
• ConnectApi.AudienceInput: A personalization audience.
• ConnectApi.AudienceCriteriaInput: Custom recommendation audience criteria type.
• ConnectApi.AudienceCriterionInput: Personalization audience criterion.
• ConnectApi.AudienceCriterionValueInput: Audience criterion value.
• ConnectApi.AuditParamsRequest: Audit Parameters input.
• ConnectApi.AuthApiPaymentMethodRequest: Payment method input representation for payment authorizations.
• ConnectApi.AuthorizationReversalRequest: Authorization reversal input consumed by authorization reversal service.
• ConnectApi.AuthorizationRequest: Payment Authorization input consumed by the Payment Authorization service.
• ConnectApi.BankPaymentMethodRequest: Bank payment method input representation.
• ConnectApi.BannerPhotoInput: A banner photo.
• ConnectApi.BaseApiPaymentMethodRequest: Payment method API input representation.
• ConnectApi.BaseComparisonInput: Represents the base comparison input.
• ConnectApi.BasePaymentMethodRequest: Base payment method input representation.
• ConnectApi.BatchInput: Construct a set of inputs to be passed into a method at the same time.
• ConnectApi.BinaryInput: Create a ConnectApi.BinaryInput object to attach files to feed items and comments, to add repository files, to create managed content, and to replace managed content variants.
• ConnectApi.BookmarksCapabilityInput: Create or update a bookmark on a feed element.
• ConnectApi.BooleanList: List of Boolean values.
• ConnectApi.BotVersionActivationInput: Activation status of the bot version.
• ConnectApi.BusObjInputRepresentation: A business objective, or goal.
• ConnectApi.BusObjAssociationsInputRepresentation: Business objective association.
• ConnectApi.BusObjInsightsInputRepresentation: Insights associated with a business objective, or goal.
• ConnectApi.BusObjRecommendationInputRepresentation: Recommended action for a business objective, or goal.
• ConnectApi.BusinessObjectivesInputRepresentation: A business objective, or goal, and insights associated with it.
• ConnectApi.CalculateTaxRequest: Request to sent through the tax adapter to the external tax engine. Inputs with a TaxTransactionType of Debit represent a tax calculation request. Inputs with a TaxTransactionType of Credit represent a tax cancellation request.
• ConnectApi.CancelAllOrderItemsInputRepresentation: Cancellation of all items in an order.
• ConnectApi.CanvasAttachmentInput: Used to attach a canvas app to a feed item.
• ConnectApi.CanvasCapabilityInput: Create or update a canvas app associated with a feed element.
• ConnectApi.CapacityRequestInputRepresentation: Request related to a location’s fulfillment order capacity.
• ConnectApi.CaptureRequest: Payment capture input consumed by the payment capture service.
• ConnectApi.CardPaymentMethodRequest: Card payment method input representation.
• ConnectApi.CartInput: A cart.
• ConnectApi.PromotionCartAdjustmentGroupInput: Cart adjustment group for a promotion.
• ConnectApi.CalculateCartInput: Custom fields for a cart calculation.
• ConnectApi.cartCouponInput: Cart coupon input.
• ConnectApi.PromotionCartDeliveryGroupInput: Cart delivery group input.
• ConnectApi.CartEvaluateShippingInput: Shipping address and custom fields used to calculate shipping costs for a cart.
• ConnectApi.CartEvaluateTaxInput: Shipping address and custom fields used to calculate taxes for a cart.
• ConnectApi.CartFromQuoteInput: Input representation for creating a cart from a quote.
• ConnectApi.CartInventoryReservationInputRepresentation (Pilot): Input representation to create or update a reservation.
• ConnectApi.CartItemInput: An item in a cart.
• ConnectApi.CartItemPromotionInputRepresentation: ID of a cart item associated with a promotion.
• ConnectApi.CartItemPromotionCollectionInputRepresentation: Promotions for a cart item.
• ConnectApi.CartMessagesVisibilityInput: Set the visibility for cart messages.
• ConnectApi.CartShippingAddressInput: A cart shipping address.
• ConnectApi.CartToWishlistInput: Copy products from a cart to a wishlist.
• ConnectApi.CdpAssetReferenceInput: Refernce to the model asset to use for the prediction request.
• ConnectApi.CdpCalculatedInsightInput: Input representation for a calculated insight.
• ConnectApi.CdpIdentityResolutionConfigInput: Input representation for creating an identity resolution ruleset.
• ConnectApi.CdpIdentityResolutionConfigPatchInput: Input representation for updating an identity resolution ruleset.
• ConnectApi.CdpIdentityResolutionMatchCriterion: Input representation for an identity resolution ruleset's match rule criterion.
• ConnectApi.CdpIdentityResolutionMatchCriterionPartyIdentificationInfo: Input representation for information when party identification is used in an identity resolution ruleset's match rule criterion.
• ConnectApi.CdpIdentityResolutionMatchRule: Input representation for an identity resolution ruleset’s match rule.
• ConnectApi.CdpIdentityResolutionReconciliationFieldRule: Input representation for an identity resolution ruleset's reconciliation rule for a field.
• ConnectApi.CdpIdentityResolutionReconciliationRule: Input representation for an identity resolution ruleset's default reconciliation rule for an object.
• ConnectApi.CdpIdentityResolutionReconciliationSource: Input representation for an identity resolution default reconciliation rule or field-specific rule using the SourceSequence match method.
• ConnectApi.CdpIdentityResolutionRunNowInput: Input representation for running an identity resolution ruleset job on demand.
• ConnectApi.CdpMlBasePredictInput: Base input representation for a prediction request.
• ConnectApi.CdpMlPredictSettingsInput: Input representation for the model settings used to generate a prediction.
• ConnectApi.CdpQueryInput: Data query input.
• ConnectApi.CdpSegmentInput: Segment input.
• ConnectApi.CdpSegmentDbtInput: Segment dbt input.
• ConnectApi.CdpSegmentDbtModelInput: Segment dbt model input.
• ConnectApi.ChangeInputRepresentation: A list of changes to OrderItemSummaries that make up an order change, such as a cancel or return.
• ConnectApi.ChangeItemInputRepresentation: Change to an order item summary, such as a return or cancel. You specify whether to prorate the associated shipping charge based on the price change. The order item summary can’t be a shipping charge.
• ConnectApi.ChangeItemFee​InputRepresentation: Input representation for Change Item Fee Input
• ConnectApi.ChangeItemFeeTaxInputRepresentation: Input representation of taxes associated with a change item fee.
• ConnectApi.ChangeItemFeeWithTaxInputRepresentation: Input representation of a change item fee with taxes.
• ConnectApi.ChangeOrderAdjustmentGroupSummaryInputRepresentation: A change to an order adjustment group summary.
• ConnectApi.ChangeOrderDeliveryGroupSummaryInputRepresentation: A change to an order delivery group summary.
• ConnectApi.ChangeOrderItemAdjustmentLineSummaryInputRepresentation: A change to an order item adjustment line summary.
• ConnectApi.ChangeOrderItemSummaryInputRepresentation: A change to an order item summary.
• ConnectApi.ChangeOrderItemTaxLineItemSummaryInputRepresentation: A change to an order item tax line item summary.
• ConnectApi.ChangeOrderSummaryInputRepresentation: A change to an order summary. There are several general validations for this input. The maximum number of changes allowed per request is 100. You must include at least one change for an entity, and each change that's associated with an entity counts as one change. You can modify only order item summaries in Ordered status.
• ConnectApi.ChatterGroupInput: Chatter group input.
• ConnectApi.CommentInput: Comment input used to add rich comments, for example, comments that include mentions or file attachments.
• ConnectApi.CommentCapabilitiesInput: A container for all capabilities that can be included with a comment.
• ConnectApi.CommerceAddressInput: Commerce address input.
• ConnectApi.CommerceAddressFieldInput: Commerce address field input. This is used to reference custom fields for the address.
• ConnectApi.CommerceNoteInput: Input representation for a note associated with a quote.
• ConnectApi.CompositeCommerceProductInputRepresentation: Composite product input.
• ConnectApi.CompositeCommerceVariationInputRepresentation: Composite product variations input.
• ConnectApi.ConfirmHeldFOCapacityInputRepresentation: Request to confirm held fulfillment order capacity at one or more locations. Can correspond to one action call.
• ConnectApi.ConfirmHeldFOCapacityRequestInputRepresentation: Request to confirm held fulfillment order capacity at one or more locations.
• ConnectApi.ConnectionDbSchemaCollectionInput: Represents the input for a database schema collection.
• ConnectApi.ContactPointAttributeInput: Represents the attribute of an activation contact point.
• ConnectApi.ContactPointSourceInput: Represents the configuration input for contact point sources.
• ConnectApi.ContentAttachmentInput: Used to attach existing content to a comment or feed item.
• ConnectApi.ContentCapabilityInput: Attach or update a file on a comment. Use this class to attach a new file or update a file that has already been uploaded to Salesforce.
• ConnectApi.ContentHubFieldValueInput: Fields of the item type.
• ConnectApi.ContentHubItemInput: Item type ID and fields of the item type.
• ConnectApi.ContractInputRepresentation: Input to create and update contract.
• ConnectApi.CouponCodeRedemptionInput: Input representation for coupon code redemption.
• ConnectApi.CreateCreditMemoInputRepresentation: A list of change orders used to create a credit memo.
• ConnectApi.CreateInvoiceFromChangeOrdersInputRepresentation: OrderSummary and associated change orders to create Invoices for.
• ConnectApi.CreateMultipleInvoicesFromChangeOrdersInputRepresentation: Data about the change orders to create Invoices for.
• ConnectApi.CreateOrderPaymentSummaryInputRepresentation: An OrderSummary for which to create an OrderPaymentSummary, with the payment authorization or payments to include in it.
• ConnectApi.CreateQuoteFromCartInput: Input representation for creating a quote from a cart.
• ConnectApi.CreateQuoteFromProductInput: Input representation for creating a quote from a product.
• ConnectApi.CreateServiceAppointmentInput: Contains information to create a service appointment.
• ConnectApi.CredentialInput: Credential input.
• ConnectApi.CredentialCustomHeaderInput: Credential custom header input.
• ConnectApi.CredentialValueInput: Credential value input.
• ConnectApi.CreditMemoInputRepresentation: The credit memo that’s being issued as credit. The specified amount from the credit memo balance is issued as payment credit.
• ConnectApi.CuratedEntityInput: Represents the input details for a curated entity.
• ConnectApi.CustomListAudienceCriteriaInput: Criteria for the custom list type of custom recommendation audience.
• ConnectApi.TaxCustomerDetailsRequest: Customer details for the tax calculation.
• ConnectApi.DMOFilterInput: Represents the DMO filter input.
• ConnectApi.SearchDataCategory: Data category input for object search.
• ConnectApi.DataConnectorInput: Input details for the data connector.
• ConnectApi.DataSourceNameConfigInput: Represents the data source name configuration input.
• ConnectApi.DatacloudOrderInput: Input representation for a Datacloud order to purchase contacts or companies and retrieve purchase information.
• ConnectApi.DeliveryAddressInputRepresentation: Delivery address.
• ConnectApi.DeliveryEstimationProductInputRepresentation: Delivery estimation product information.
• ConnectApi.DeliveryRoutingEngineInputRepresentation: Input for the Delivery Routing Engine, which retrieves routing rules to determine which fulfillment locations should fulfill products for a given delivery address.
• ConnectApi.DirectMessageCapabilityInput: Create or update the members of a direct message.
• ConnectApi.DistinctValueRefinementInput: Attribute-based refinement with distinct values for product search.
• ConnectApi.DistributePickedQuantitiesInputRepresentation: Input representation to Distribute Picked Quantities
• ConnectApi.DistributeToOrdersInputRepresentation: Input representation of a single element within the Distribute To Orders list.
• ConnectApi.DmoFilterLimitInput: Represents the DMO filter limit input.
• ConnectApi.DoubleList: List of double values.
• ConnectApi.EgressPropertiesInput: Represents the input details for egress properties of the activation target.
• ConnectApi.​EinsteinLlm​Additional​ConfigInput: Additional configuration information for the LLM provider.
• ConnectApi.​EinsteinPrompt​Template​GenerationsInput: Prompt template input parameters to use for generation.
• ConnectApi.EnsureFundsAsyncInputRepresentation: ID of an Invoice to ensure funds for and apply them to.
• ConnectApi.EnsurePaymentCreditInputRepresentation: The credit memo information and, optionally, the payment sequence details for issuing credits. The credit memo amount is distributed to the payment methods specified in the payment sequence until the amount is fully applied. If you don’t specify a payment sequence, the default payment sequence for Ensure Payment is used.
• ConnectApi.EnsureRefundsAsyncInputRepresentation: ID of a credit memo to ensure refunds for, an amount of excess funds to refund, or both. At least one is required. Also includes any invoices for fees that reduce the refund amount, such as return fees. If multiple payment methods are available, you can specify how to distribute the refund.
• ConnectApi.EntityLinkSegmentInput: An entity link segment.
• ConnectApi.EstimateDeliveryDateInputRepresentation: Delivery date estimation information.
• ConnectApi.ExtendedFieldInput: Contains information about the extended field.
• ConnectApi.ExtensionInput: An extension.
• ConnectApi.ExtensionsCapabilityInput: Create or update extensions associated with a feed element.
• ConnectApi.ExternalAuthIdentityProviderInput: External auth identity provider input.
• ConnectApi.ExternalAuthIdentityProviderCredentialInput: External auth identity provider credential input.
• ConnectApi.ExternalAuthIdentityProviderCredentialsInput: External auth identity provider credentials input.
• ConnectApi.ExternalAuthIdentityProviderParameterInput: External auth identity provider parameter input.
• ConnectApi.ExternalCredentialInput: Input used to create or update an external credential.
• ConnectApi.ExternalCredentialParameterInput: External credential parameter input.
• ConnectApi.ExternalCredentialPrincipalInput: External credential principal input.
• ConnectApi.FeedItemInput: Used to create rich feed items, for example, feed items that include @mentions or files.
• ConnectApi.FeedElementInput: Feed elements are the top-level items that a feed contains. Feeds are feed element containers.
• ConnectApi.FeedElementCapabilitiesInput: A container for all capabilities that can be included when creating a feed element.
• ConnectApi.FeedElementCapabilityInput: A feed element capability.
• ConnectApi.FeedEntityShareCapabilityInput: Share a feed entity with a feed post or comment.
• ConnectApi.ChatterStreamInput: A Chatter feed stream.
• ConnectApi.fetchFilesInput: Input representation for a fetch optimization files operation.
• ConnectApi.FileIdInput: Attach a file that has already been uploaded or remove a file from a feed element.
• ConnectApi.SearchFilter: Filter input for object search.
• ConnectApi.FindRoutesWithFewestSplitsInputRepresentation: Data used to calculate order fulfillment routes involving the fewest number of shipment splits.
• ConnectApi.FindRoutesWithFewestSplitsGroupUsingOCIInputRepresentation: Data used to calculate inventory availability and fulfillment routes for one order involving the fewest number of shipment splits.
• ConnectApi.FindRoutesWithFewestSplitsUsingOCIInputRepresentation: Data used to calculate order fulfillment routes involving the fewest number of shipment splits, taking into account inventory availability.
• ConnectApi.FindRoutesWithFewestSplitsUsingOCIItemInputRepresentation: A quantity of a product and a location group or location assigned to fulfill it.
• ConnectApi.FormInput: Marketing integration form.
• ConnectApi.FormFieldInput: Marketing integration form field.
• ConnectApi.FormSubmissionInput: Marketing integration form submission.
• ConnectApi.FormSubmissionFieldInput: Marketing integration form field submission.
• ConnectApi.FulfillmentGroupInputRepresentation: A list of OrderItemSummaries to be fulfilled together, and the fulfillment location to handle them. The fulfillment type is one of the values defined for the Type field on the FulfillmentOrder object, such as “Warehouse” or “Retail Store.” The specified type is assigned to the FulfillmentOrder for this fulfillment group.
• ConnectApi.FulfillmentOrderInputRepresentation: An OrderDeliveryGroupSummary that defines a delivery method and recipient, and a list of fulfillment groups to assign to FulfillmentOrders. Each fulfillment group is a set of OrderItemSummaries that match the OrderDeliveryGroupSummary and share the same fulfillment location. The method creates a FulfillmentOrder for each fulfillment group and a FulfillmentOrderLineItem for each OrderItemSummary.
• ConnectApi.FulfillmentOrderInvoiceInputRepresentation: Instantiate and include this object with no properties when creating an invoice.
• ConnectApi.FulfillmentOrderLineItemInputRepresentation: A FulfillmentOrderLineItem and quantity to cancel. You can cancel less than the full quantity, in which case you reallocate the canceled quantity to a different FulfillmentOrder.
• ConnectApi.FulfillmentOrderLineItemsToCancelInputRepresentation: A list of FulfillmentOrderLineItems and quantities to cancel.
• ConnectApi.BaseRequest: Base parameters for making a request to the payment gateway.
• ConnectApi.GetFOCapacityValuesRequestInputRepresentation: Locations to get fulfillment order capacity information for.
• ConnectApi.GroupInformationInput: Chatter group information input.
• ConnectApi.HashtagSegmentInput: Include a hashtag in a feed item or comment.
• ConnectApi.HoldFOCapacityInputRepresentation: Request to hold fulfillment order capacity at one or more locations. Can correspond to one action call.
• ConnectApi.HoldFOCapacityRequestInputRepresentation: Request to hold fulfillment order capacity at one or more locations.
• ConnectApi.InlineImageSegmentInput: An inline image segment.
• ConnectApi.InnerEnsureFundsAsyncInputRepresentation: ID of an Invoice and ID of the associated OrderSummary.
• ConnectApi.InviteInput: An invitation.
• ConnectApi.InvoiceToPayInputRepresentation: Invoice for a fee.
• ConnectApi.ItemQuantityInputRepresentation: Representation for Item Quantity Input
• ConnectApi.LeadInput: Contains information about a lead or guest user.
• ConnectApi.TaxLineItemRequest: A list of line items passed to the tax engine for tax calculation.
• ConnectApi.LinkAttachmentInput: Add links to a feed item.
• ConnectApi.LinkSegmentInput: Include a link segment in a feed item or comment.
• ConnectApi.LinkCapabilityInput: Create or update a link on a feed element.
• ConnectApi.LocationInputRepresentation: Inventory location data used to calculate shipping distance.
• ConnectApi.LocationAvailabilityInputRepresentation: The available quantity of a product at an inventory location.
• ConnectApi.LocationListInputRepresentation: A list of location identifiers used to specify locations excluded from routing consideration.
• ConnectApi.LongList: List of long values.
• ConnectApi.MCSFolderShareInput: Target to share a managed content space folder with.
• ConnectApi.MCSFolderShareCollectionUpdateInput: Update the targets that a managed content space folder is shared with.
• ConnectApi.ManagedContentDocumentInput: Input representation for a piece of managed content.
• ConnectApi.ManagedContentBodyInput: Input representation for the body of a piece of managed content.
• ConnectApi.ManagedContentChannelCreateRepresentation: Input class to create a managed content channel.
• ConnectApi.ManagedContentChannelUpdateRepresentation: Input class to update a managed content channel.
• ConnectApi.ManagedContentDocumentCloneInput: Managed content clone input.
• ConnectApi.ManagedContentItemsDeleteInput: Input representation for asynchronously deleting managed content items.
• ConnectApi.ManagedContentMetadataCollectionInput: Input for exposing managed content as metadata.
• ConnectApi.ManagedContentProviderInstanceInput: Create or update a managed content provider instance.
• ConnectApi.ManagedContentPublishInput: Input for publishing content.
• ConnectApi.ManagedContentSpaceInput: Create a managed content space.
• ConnectApi.ManagedContentSpaceChannelInputRepresentation: Channel to add or remove from a managed content space.
• ConnectApi.ManagedContentSpaceChannelsInputRepresentation: Channels to add or remove from the managed content space.
• ConnectApi.ManagedContentSpaceUpdateInput: Update the name or description of a managed content space.
• ConnectApi.ManagedContentUnpublishInput: Input for unpublishing content.
• ConnectApi.ManagedContentVariantUpdateInput: Input representation for replacing a managed content variant.
• ConnectApi.ManagedTopicPositionInput: Relative position of a managed topic.
• ConnectApi.ManagedTopicPositionCollectionInput: A collection of relative positions of managed topics.
• ConnectApi.MarkupBeginSegmentInput: The beginning tag for rich text markup.
• ConnectApi.MarkupEndSegmentInput: The end tag for rich text markup.
• ConnectApi.MentionSegmentInput: Include an @mention of a user or group in a feed post or comment. When creating a feed post or comment, you can include up to 25 mentions.
• ConnectApi.MessageSegmentInput: Used to add rich message segments to feed items and comments.
• ConnectApi.MessageBodyInput: Add rich messages to feed items and comments.
• ConnectApi.FilesCapabilityInput: Attach up to 10 files that have already been uploaded or remove one or more files from a feed element.
• ConnectApi.MultipleEnsureFundsAsyncInputRepresentation: List of Invoices and the associated OrderSummaries.
• ConnectApi.MultipleFulfillmentOrderInputRepresentation: List of inputs for creating fulfillment orders.
• ConnectApi.MultipleFulfillmentOrderInvoicesInputRepresentation: The FulfillmentOrders to create Invoices for.
• ConnectApi.MuteCapabilityInput: Mute or unmute a feed element.
• ConnectApi.RecommendationReactionInput: A reaction to a recommendation produced by a recommendation strategy.
• ConnectApi.NBAStrategyInput: A recommendation strategy.
• ConnectApi.NamedCredentialInput: Input used to create or update a named credential.
• ConnectApi.NamedCredentialCalloutOptionsInput: Named credential callout options input.
• ConnectApi.NamedCredentialParameterInput: Named credential parameter input.
• ConnectApi.NetworkConnectionInput: Network connection input.
• ConnectApi.ShiftsFromPatternInput: Shifts from a pattern.
• ConnectApi.NewUserAudienceCriteriaInput: Criteria for the new members type of custom recommendation audience.
• ConnectApi.OAuthCredentialAuthUrlInput: OAuth authentication flow.
• ConnectApi.OCICreateReservationInputRepresentation: Data to reserve inventory at one or more Omnichannel Inventory locations or location groups.
• ConnectApi.OCICreateReservationSingleInputRepresentation: A quantity of a product and an Omnichannel Inventory location or location group at which to reserve it.
• ConnectApi.OCIFulfillReservationInputRepresentation: A list of inventory reservations to fulfill.
• ConnectApi.OCIFulfillReservationSingleInputRepresentation: An inventory reservation to fulfill.
• ConnectApi.OCIGetInventoryAvailabilityInputRepresentation: Details of a request to retrieve inventory availability.
• ConnectApi.OCIReleaseReservationInputRepresentation: Details of one or more inventory reservations to release.
• ConnectApi.OCIReleaseReservationSingleInputRepresentation: A single inventory reservation to release.
• ConnectApi.OCITransferReservationInputRepresentation: A list of inventory reservation transfers and specifies whether a single failure cancels the entire list.
• ConnectApi.OCITransferReservationSingleInputRepresentation: An inventory reservation transfer.
• ConnectApi.OCIUpdateReservationInputRepresentation: Data to update one or more Omnichannel Inventory item reservations.
• ConnectApi.OCIUpdateReservationSingleInputRepresentation: Data to update one Omnichannel Inventory reservation item.
• ConnectApi.SearchOrderBy: Order by parameter for object search.
• ConnectApi.OrderItemSummaryInputRepresentation: An OrderItemSummary and quantity.
• ConnectApi.OrderItemSummaryAdjustmentInput: Order item summary.
• ConnectApi.OrderItemSummaryAdjustmentCollectionInput: Collection of order item summaries.
• ConnectApi.OrderSummaryInputRepresentation: An order from which to create an OrderSummary. Optionally, you can specify OrderSummary-specific information such as its Status and whether it is managed in Salesforce Order Management.
• ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput: Order summary IDs for calculating adjustment aggregates.
• ConnectApi.OrderSummaryLookupInput: Order summary lookup input.
• ConnectApi.OrderSummaryVerificationInput: Order summary verification input.
• ConnectApi.OrderToCartInput: Input for action adding an order to a cart.
• ConnectApi.PaymentCreditSequenceInputRepresentation: The order in which the credit amount is applied to specified payment methods. The sequence determines the order that the credit is applied to each payment during processing. The amount credited to each payment method is determined in each order payment summary.
• ConnectApi.PaymentCreditSequenceItemInputRepresentation: Order Payment Summary ID, credit amount, and credit type for individual payment credit items. Each item represents a specific payment method and the amount of credit to be applied to it with the type of credit transaction.
• ConnectApi.PaymentGroupRequest: Payment group input consumed by a payment group service.
• ConnectApi.PaymentInfoInputRepresentation: Payment information about additional funds required for an order.
• ConnectApi.PaymentInitiationSourceInputRepresentation: Payment initiation source input representation.
• ConnectApi.PaymentMethodTokenizationRequest: Payment method tokenization input consumed by the payment tokenization service.
• ConnectApi.PinCapabilityInput: Pin or unpin a feed element to a feed.
• ConnectApi.PollCapabilityInput: Create, update, or vote on a poll on a feed element.
• ConnectApi.PostAuthRequest: Payment post authorization input consumed by the payment post authorization service.
• ConnectApi.PostAuthApiPaymentMethodRequest: Payment method input for post authorization.
• ConnectApi.PreviewCartToExchangeOrderInputRepresentation: Information required to preview a cart to exchange order.
• ConnectApi.PricingInput: Pricing for multiple products.
• ConnectApi.PricingLineItemInput: Pricing line item.
• ConnectApi.AttributeSetInputRepresentation: Attribute set information input.
• ConnectApi.ProductSearchInput: Product search.
• ConnectApi.ProductSearchGroupingInput: Grouping information for product search results.
• ConnectApi.ProductVariationInputRepresentation: Variation product input.
• ConnectApi.PromotionCartInput: Cart during promotion evaluation.
• ConnectApi.PromotionCartDeliveryGroupInput: IDs of the cart delivery group and its delivery method.
• ConnectApi.PromotionCartItemInput: Item in a cart during promotion evaluation.
• ConnectApi.PromotionEvaluateInput: Find promotions that the customer is eligible for and compute their discounts.
• ConnectApi.PromotionParentProductsInput: IDs of a parent product and variation product.
• ConnectApi.PromotionProductCategoriesInput: IDs of a product and associated category.
• ConnectApi.QuantityWithSkuInputRepresentation: A quantity of a product.
• ConnectApi.QueryPathInput: Represents the query path input.
• ConnectApi.QueryPathInputConfig: Represents the query path configuration input.
• ConnectApi.QuerySqlInput: Represents the input to create an SQL query.
• ConnectApi.QuerySqlParameterItem: Represents the parameter fields for an SQL query input.
• ConnectApi.QuestionAndAnswersCapabilityInput: Create or edit a question feed element or set the best answer of the existing question feed element.
• ConnectApi.RangeRefinementInput: Attribute-based refinement with minimum or maximum numeric values for product search.
• ConnectApi.RankAverageDistanceInputRepresentation: An order recipient’s geographic location and information about sets of inventory locations that can fulfill the order.
• ConnectApi.ReadByCapabilityInput: Mark feed elements as read by the context user.
• ConnectApi.RecommendationAudienceInput: A custom recommendation audience.
• ConnectApi.RecommendationDefinitionInput: A custom recommendation definition.
• ConnectApi.RecordCapabilityInput: Attach an existing knowledge article to a comment.
• ConnectApi.RecordsetFilterCriteriaInput: A set of recordset filter criteria applied to records, such as service appointment records.
• ConnectApi.ReferencedRefundRequest: Referenced refund input.
• ConnectApi.RefinementInput: Attribute-based refinement input for product search.
• ConnectApi.RefundRequest: Refund input.
• ConnectApi.RefundInstructionsHintInputRepresentation: The payment credit sequence, credit types, and refund sequence that provide information for optimal refund processing.
• ConnectApi.RefundSequenceItemInputRepresentation: The Order Payment Summary ID and amount for the individual refund items in a sequence. Each item has a payment method and refund amount to be processed for that method.
• ConnectApi.ReleaseHeldFOCapacityInputRepresentation: Request to release held fulfillment order capacity at one or more locations. Can correspond to one action call.
• ConnectApi.ReleaseHeldFOCapacityRequestInputRepresentation: Request to release held fulfillment order capacity at one or more locations.
• ConnectApi.RequestHeaderInput: An HTTP request header name and value pair.
• Retired ConnectApi Input Classes: These ConnectApi input classes are retired.
• ConnectApi.ReturnItemsInputRepresentation: Data about products and delivery charges to return, as well as associated return fees.
• ConnectApi.ReturnOrderInputRepresentation: Data for creating a ReturnOrder and ReturnOrderLineItems.
• ConnectApi.ReturnOrderItemInputRepresentation: ID of a ReturnOrderLineItem and instructions for updating it. After the update, the ReturnOrderLineItem is read-only. Any remaining quantity to be returned is added to a new ReturnOrderLineItem.
• ConnectApi.ReturnOrderItemDeliveryChargeInputRepresentation: ID of a ReturnOrderLineItem representing a delivery charge.
• ConnectApi.ReturnOrderItemFeeInputRepresentation: ID of a ReturnOrderLineItem representing a return fee, and instructions for updating it. After the update, the ReturnOrderLineItem is read-only. Any remaining quantity of the fee to be processed is added to a new ReturnOrderLineItem.
• ConnectApi.ReturnOrderLineItemInputRepresentation: Data for creating a ReturnOrderLineItem for an order item being returned, including data to create ReturnOrderLineItems representing any return fees associated with it.
• ConnectApi.ReturnOrderLineItemFeeInputRepresentation: Data for creating a ReturnOrderLineItem that represents a return fee.
• ConnectApi.RoutingProductInputRepresentation: A product to route, including its SKU and requested quantity.
• ConnectApi.SaleRequest: Payment sale input consumed by the payment sale service.
• ConnectApi.SaleApiPaymentMethodRequest: Payment method request for sale.
• ConnectApi.ScheduledRecommendationInput: A scheduled custom recommendation.
• ConnectApi.SearchRequest: Search request input for searching an object.
• ConnectApi.SellerDetailsRequest: Seller details for the tax calculation
• ConnectApi.SequenceOrderPaymentSummaryInputRepresentation: Amount to apply to specified OrderPaymentSummary as part of a payment or refund.
• ConnectApi.ServiceAppointmentInput: Contains information about the service appointment.
• ConnectApi.sharedOrderPaymentSummarySequenceInputRepresentation: Shared order payment summary sequence.
• ConnectApi.ShippingCarrierInputRepresentation: Shipping carrier.
• ConnectApi.ShippingCarrierMethodInputRepresentation: Shipping carrier method external references.
• ConnectApi.SocialPostMassApprovalInput: List of social post ids and the action to approve or reject publishing them.
• ConnectApi.StaticDataInput: Represents the static data input.
• ConnectApi.StatusCapabilityInput: Change the status of a feed post or comment.
• ConnectApi.StreamSubscriptionInput: An entity to subscribe to for a Chatter feed stream.
• ConnectApi.StringList: List of string values.
• ConnectApi.SubmitCartToExchangeOrderInputRepresentation: Information required for a submit cart to exchange order action.
• ConnectApi.SurveyInvitationEmailInput: Survey invitation email.
• ConnectApi.RecipientEngagementContextInput: Context based on which the survey invitation is sent to a participant.
• ConnectApi.AssociateRecordsWithRecipientInput: Records associated with the survey invitation.
• ConnectApi.TargetInput: Target to create.
• ConnectApi.TargetCollectionInput: Collection of targets to create.
• ConnectApi.TargetCollectionUpdateInput: Collection of targets to update.
• ConnectApi.TargetLocationInputRepresentation: A set of inventory locations that together can fulfill an order.
• ConnectApi.TargetUpdateInput: Target to update.
• ConnectApi.TaxAddressRequest: Address input representation for tax calculation.
• ConnectApi.TaxTransactionRequest: Information about the tax transaction sent to the tax adapter as part of a tax calculation request.
• ConnectApi.TextClassificationsInputRepresentation: Text classification information associating classifiers and text to be classified.
• ConnectApi.TopicNamesInput: A list of topic names to replace currently assigned topics. Also a list of suggested topics to assign.
• ConnectApi.TopicsCapabilityInput: Assign topics to a feed element.
• ConnectApi.TypeAndFilterInput: Represents the wrapper for logical comparison filters.
• ConnectApi.UpDownVoteCapabilityInput: Upvote or downvote a feed element or a comment.
• ConnectApi.updateQuoteInput: Input representation for updating the quote status and optionally creating an associated note.
• ConnectApi.UpdateServiceAppointmentInput: Contains information to update a service appointment.
• ConnectApi.UserInput: Update a user’s About Me information.
• ConnectApi.WishlistInput: Create a wishlist.
• ConnectApi.WishlistItemInput: Item to update or add to a wishlist.
• ConnectApi.WishlistUpdateInput: Update a wishlist name.
• ConnectApi.WrappedValue: Value wrapped for use as an object.
• ConnectApi Output Classes: Most ConnectApi methods return instances of ConnectApi output classes.
• ConnectApi.ChatterConversation: Chatter conversation.
• ConnectApi.ChatterConversationPage: Chatter conversation page.
• ConnectApi.ChatterConversationSummary: Chatter conversation summary.
• ConnectApi.ChatterMessage: Chatter message.
• ConnectApi.ChatterMessagePage: Chatter message page.
• ConnectApi.GlobalInfluence: Chatter influence.
• ConnectApi.Feed: Chatter feed.
• ConnectApi.FeedPoll: Attachment of ConnectApi.FeedItem objects where the type property is PollPost.
• ConnectApi.FeedPollChoice: Feed poll choice.
• ConnectApi.FeedFavorite: Feed favorite.
• ConnectApi.FeedFavorites: Feed favorites.
• ConnectApi.FeedItem: Feed item.
• ConnectApi.FeedItemPage: A paged collection of ConnectApi.FeedItem objects.
• ConnectApi.FeedDirectory: Directory of feeds and favorites.
• ConnectApi.FeedDirectoryItem: Definition of a feed.
• ConnectApi.FeedItemTopicPage: Feed item topic page.
• ConnectApi.FieldChangeSegment: Field change segment.
• ConnectApi.FieldChangeNameSegment: Field change name segment.
• ConnectApi.FieldChangeValueSegment: Field change value segment.
• ConnectApi.FollowerPage: Page of followers.
• ConnectApi.ChatterGroupDetail: Chatter group details.
• ConnectApi.ChatterGroupPage: Page of groups.
• ConnectApi.GroupRecord: A record associated with a group.
• ConnectApi.GroupRecordPage: A paginated list of ConnectApi.GroupRecord objects.
• ConnectApi.ChatterGroupSummary: Chatter group summary.
• ConnectApi.ChatterGroupSummaryPage: Page of group summaries.
• ConnectApi.GroupChatterSettings: A user’s Chatter settings for a specific group.
• ConnectApi.GroupMember: Member of a group.
• ConnectApi.TrackedChangeAttachment: Tracked change attachment to a feed item.
• ConnectApi.​TrackedChangeItem: Tracked change item.
• ConnectApi.UnreadConversationCount: Unread count for a conversation.
• ConnectApi.User: User.
• ConnectApi.AbstractMessageBody: Abstract message body.
• ConnectApi.AbstractRecordField: A field on a record.
• ConnectApi.AbstractRecordView: A view of any record in the org, including a custom object record. This object is used if a specialized object, such as User or ChatterGroup, isn’t available for the record type.
• ConnectApi.BundleCapability: If a feed element has this capability, it has a container of feed elements called a bundle.
• ConnectApi.AbstractCartItem: A cart item.
• ConnectApi.AbstractContentHubItemType: An item type associated with a repository folder.
• ConnectApi.AbstractDirectoryEntrySummary: A directory entry with summary information.
• ConnectApi.AbstractExtensionInformation: Extension information.
• ConnectApi.UserFeedEntityActivitySummary: User feed entity activity summary.
• ConnectApi.AbstractGatewayCommonResponse: Payment gateway response fields commonly used in payment services.
• ConnectApi.AbstractGatewayResponse: Payment gateway response fields used in sale, authorization, and capture services.
• ConnectApi.AbstractManagedContentChannelRepresentation: Managed content channel.
• ConnectApi.AbstractManagedContentDeliveryDocument: Managed content delivery document.
• ConnectApi.AbstractManagedContentReference: Managed content reference.
• ConnectApi.AbstractNBAAction: A recommended action of recommendation strategy.
• ConnectApi.AbstractNBATarget: A recommendation target of a recommendation strategy.
• ConnectApi.AbstractPicklistValueAttributes: Picklist value attributes.
• ConnectApi.AbstractRecommendationExplanation: Explanation for a Chatter recommendation.
• ConnectApi.AbstractRecommendation: A Chatter, custom, or static recommendation.
• ConnectApi.RelatedFeedPost: This class is abstract.
• ConnectApi.RelatedFeedPosts: A collection of related feed posts.
• ConnectApi.AbstractRepositoryFile: A repository file.
• ConnectApi.AbstractRepositoryFolder: A repository folder.
• ConnectApi.AbstractRepositoryItem: A repository item.
• ConnectApi.UserActivitySummary: User activity summary.
• ConnectApi.AbstractUserMissionActivity: User activity associated with missions.
• ConnectApi.ActionInfoOutputRepresentation: Recommended action information.
• ConnectApi.ActionLinkDefinition: The definition of an action link. Action link definition can be sensitive to a third party (for example, OAuth bearer token headers). For this reason, only calls made from the Apex namespace that created the action link definition can read, modify, or delete the definition. In addition, the user making the call must have created the definition or have View All Data permission.
• ConnectApi.ActionLinkDiagnosticInfo: Any diagnostic information that may exist for an executed action link. Diagnostic info is provided only for users who can access the action link.
• ConnectApi.ActionLinkGroupDefinition: The definition of an action link group. Information in the action link group definition can be sensitive to a third party (for example, OAuth bearer token headers). For this reason, only calls made from the Apex namespace that created the action link group definition can read, modify, or delete the definition. In addition, the user making the call must have created the definition or have View All Data permission.
• ConnectApi.Activation: Represents an activation output.
• ConnectApi.ActivationAttribute: Represents the activation attribute output.
• ConnectApi.ActivationAttributeConfig: Represents the configuration for activation attributes.
• ConnectApi.ActivationCollection: Represents a collection of activations.
• ConnectApi.ActivationContactPointFieldConfig: Represents an activation contact point field configuration output.
• ConnectApi.ActivationContactPointSourceConfig: Represents an activation contact point source configuration output.
• ConnectApi.ActivationContactPointsFieldConfig: Represents the activation contact points field configuration output.
• ConnectApi.ActivationContactPointsSourceConfig: Represents the activation contact points source configuration output.
• ConnectApi.ActivationData: Represents the activation data for an Audience Data Model Object (DMO).
• ConnectApi.ActivationDataSourceConfig: Represents an activation data source configuration output.
• ConnectApi.ActivationDataSources: Represents the activation data sources configuration output.
• ConnectApi.ActivationExternalPlatform: Represents information about an activation external platform.
• ConnectApi.ActivationExternalPlatformAttribute: Represents an attribute for an activation external platform.
• ConnectApi.ActivationExternalPlatformAttributeConfig: Represents the attribute configuration for an activation external platform.
• ConnectApi.ActivationExternalPlatformCollection: Represents a collection of activation external platforms.
• ConnectApi.ActivationTarget: Represents an activation target.
• ConnectApi.ActivationTargetCollection: Represents a collection of activation targets.
• ConnectApi.ActivationTargetSubject: Represents an activation target subject output.
• ConnectApi.ActivitySharingResult: The results of sharing a captured email or event.
• ConnectApi.Actor: Actor.
• ConnectApi.ActorWithId: Actor with ID.
• ConnectApi.Address: Address.
• ConnectApi.TaxAddressResponse: Location code of an address.
• ConnectApi.TaxAddressesResponse: The Ship From, Ship To, and Sold To addresses used during tax calculation.
• ConnectApi.AdjustOrderSummaryOutputRepresentation: Output representation of the financial changes for an adjust items action. For a preview action, these values are the expected output. For a submit action, these values are the actual output.
• ConnectApi.Alternative: Alternative representation for an extension on a feed element.
• ConnectApi.AlternativePaymentMethodOutput: Alternative payment method details output.
• ConnectApi.Announcement: An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.
• ConnectApi.AnnouncementPage: A collection of announcements.
• ConnectApi.SearchAppliedOrderBy: The applied order for object search.
• ConnectApi.ApprovalAttachment: Attach an approval to a feed item.
• ConnectApi.ApprovalCapability: If a feed element has this capability, it includes information about an approval.
• ConnectApi.ApprovalPostTemplateField: Approval post template field.
• ConnectApi.ApprovalIntent: Approval intent for a social post.
• ConnectApi.ArticleItem: Article item in question and answers suggestions.
• ConnectApi.ArticleSummary: A knowledge article summary.
• ConnectApi.AssociatedActionsCapability: If a feed element has this capability, it has platform actions associated with it.
• ConnectApi.AsyncOutputRepresentation: Output representation of the async operation.
• ConnectApi.AttributeFilter: Represents the attribute filter output.
• ConnectApi.AttributeFilterExpression: Represents the activation attribute filter expression.
• ConnectApi.Audience: A personalization audience.
• ConnectApi.AudienceCollection: Collection of personalization audiences.
• ConnectApi.AudienceCriteria: Custom recommendation audience criteria.
• ConnectApi.AudienceCriteriaDetail: Personalization audience criteria.
• ConnectApi.AudienceCriterionDetail: Audience criterion information.
• ConnectApi.AudienceDMOCollection: Represents a collection of Audience Data Model Object (DMO) records.
• ConnectApi.AudienceTarget: Personalization audience assigned to a target.
• ConnectApi.AudienceTargetAssignment: Target assignments for a personalization audience.
• ConnectApi.PaymentAuthAdjustmentResponse: Authorization Adjustment output representation.
• ConnectApi.AuthReversalGatewayResponse: Authorization Reversal Gateway Response Representation.
• ConnectApi.AuthorizationReversalResponse: Authorization Reversal output representation.
• ConnectApi.AuthorizationGatewayResponse: Payment gateway authorization response representation.
• ConnectApi.AuthorizationResponse: Payment Authorization output representation.
• ConnectApi.AvailableLocationOutputRepresentation: A set of inventory locations that can combine to fulfill an order.
• ConnectApi.AverageDistanceResultOutputRepresentation: Wraps inventory location shipping distance calculation results.
• ConnectApi.BalanceStatePreviewOutputRepresentation: The generated preview of all balances for an order or a cart, including totals, adjustments, and taxes.
• ConnectApi.BannerCapability: If a feed element has this capability, it has a banner motif and style.
• ConnectApi.BannerPhoto: A banner photo.
• ConnectApi.BaseAsyncOutputRepresentation: Base Order Management async output class.
• ConnectApi.BaseComparison: Represents the abstract class for a base comparison output.
• ConnectApi.BaseInvoiceOutputRepresentation: Base Order Management Invoice output class.
• ConnectApi.BaseOutputRepresentation: Base Order Management output class.
• ConnectApi.BasicTemplateAttachment: Attachments in feed items with type BasicTemplate.
• ConnectApi.BatchResult: The result of an operation returned by a batch method.
• getError(): If an error occurred, returns a ConnectApi.ConnectApiException object providing the error code and description.
• getErrorMessage(): Returns a String that contains an error message.
• getErrorTypeName(): Returns a String that contains the name of the error type.
• getResult(): Returns an object that contains the results of the batch operation. The object is typed according to the batch method. For example, if you call getMembershipBatch(), a successful call to BatchResult getResult() returns a ConnectApi.GroupMembership object.
• isSuccess(): Returns a Boolean that is set to true if the batch operation was successful for this object, false otherwise.
• BatchResult Methods: These are instance methods for BatchResult.
• ConnectApi.BestLocationPerSKUOutputRepresentation: A recommended fulfillment location for a specific SKU, including available quantity and score.
• ConnectApi.BlankRecordField: Record field displayed as a place holder in a grid of fields.
• ConnectApi.PromotionBonusProduct: Bonus product for a promotion.
• ConnectApi.BookmarkSummary: Summary of a bookmark.
• ConnectApi.BookmarksCapability: If a feed element has this capability, the context user can bookmark it.
• ConnectApi.BotInfoRepresentation: Information about the bot associated with the conversation application.
• ConnectApi.BotVersionActivationInfo: Success or failure information of the bot version activation.
• ConnectApi.BusObjAssociationsOutputRepresentation: Association details of a business objective
• ConnectApi.BusObjInsightsOutputRepresentation: Insights related to a business objective, or goal.
• ConnectApi.BusObjOutputRepresentation: Business objective, or goal.
• ConnectApi.BusObjRecommendationsOutputRepresentation: Details of the recommended actions for a business objective, or goal.
• ConnectApi.BusObjSummaryOutputRepresentation: Summary of a business objective, or goal.
• ConnectApi.BusinessObjectivesOutputRepresentation: List of business objectives, or goals.
• ConnectApi.BusinessObjectivesSummaryOutputRepresentation: List of summaries for business objectives, or goals.
• ConnectApi.BuyerProductSummaryRepresentation: Representation of the buyer's product summary.
• ConnectApi.CalculateTaxResponse: Shows the results of a tax calculation request.
• ConnectApi.CallCollaborationCapability: If a feed element has this capability, it has a recording comment.
• ConnectApi.CancelAllOrderItemsAsyncOutputRepresentation: ID of the asynchronous background operation.
• ConnectApi.CandidateAnswersStatus: The status of candidate answers on a feed element.
• ConnectApi.CanvasCapability: If a feed element has this capability, it renders a canvas app.
• ConnectApi.CanvasTemplateAttachment: Attachments in feed items with type CanvasPost.
• ConnectApi.CapacityResponseOutputRepresentation: Response to a request related to a location’s fulfillment capacity.
• ConnectApi.CaptureGatewayResponse: Gateway capture response.
• ConnectApi.CaptureResponse: Capture output.
• ConnectApi.CardPaymentMethodOutput: Card payment method details output.
• ConnectApi.CartCoupon: Cart Coupon representation.
• ConnectApi.CartCouponCollection: Collection of coupons related to a cart.
• ConnectApi.CartCouponList: List of coupons for a cart.
• ConnectApi.PromotionCartDeliveryGroupMethod: Cart delivery group method for a promotion.
• ConnectApi.PromotionCartDeliveryGroup: Cart delivery group for a promotion.
• ConnectApi.PromotionCartDeliveryMethodAdjustment: Adjustment for a cart delivery method in a promotion.
• ConnectApi.CartFromQuoteOutput: Representation of the response for creating a cart from a quote.
• ConnectApi.CartInventoryItemReservationOutputRepresentation (Pilot): Inventory item reservation.
• ConnectApi.CartInventoryReservationOutputRepresentation (Pilot): Inventory Reservation
• ConnectApi.CartItem: An item in a cart.
• ConnectApi.CartItemBasic: Represents limited details about a cart item.
• ConnectApi.CartItemBasicResult: Represents the result of a cart request.
• ConnectApi.CartItemCollection: A collection of items in a cart.
• ConnectApi.PromotionCartItemKey: Cart item key for a bonus product in a promotion.
• ConnectApi.CartItemWithoutPrice: An item without price information in a cart.
• ConnectApi.CartItemPromotionCollectionOutputRepresentation: Promotions for the items in a cart.
• ConnectApi.CartItemResult: Result after requesting a cart item.
• ConnectApi.CartMessage: Cart message.
• ConnectApi.CartMessagesSummary: Cart messages summary.
• ConnectApi.CartMessagesVisibilityResult: Result of setting the visibility for cart messages.
• ConnectApi.CartProductAttribute: Product attribute for a cart item.
• ConnectApi.CartItemProduct: Product summary for a cart item.
• ConnectApi.CartPromotionCollection: All the promotions associated with the cart.
• ConnectApi.CartPromotionList: A list of promotions for a cart.
• ConnectApi.CartPromotionOutputRepresentation: A promotion associated with a cart.
• ConnectApi.CartSummary: A cart summary.
• ConnectApi.CalculateCartResult: Result of a cart calculate request. Includes a cart summary with calculated cart values.
• ConnectApi.CartToWishlistResult: Result of copying products from a cart to a wishlist.
• ConnectApi.CaseComment: Attachments in feed items with type CaseCommentPost.
• ConnectApi.CaseCommentCapability: If a feed element has this capability, it has a case comment on the case feed.
• ConnectApi.CaseStatusPicklistValueAttributes: Case status picklist value attributes.
• ConnectApi.CdpActionResponse: Customer Data Platform action response.
• ConnectApi.CdpAssetReference: Model asset reference used as part of the prediction request.
• ConnectApi.CdpCalculatedInsightOutput: Calculated insight.
• ConnectApi.CdpCalculatedInsightStandardActionResponseRepresentation: Response of the calculated insight run action.
• ConnectApi.CdpCalculatedInsightPage: Collection of calculated insights.
• ConnectApi.CdpCalculatedInsightPageData: Calculated insight collection data.
• ConnectApi.CdpCalculatedInsightDataSource: Calculated insight data source.
• ConnectApi.CdpCalculatedInsightDimension: Calculated insight dimension.
• ConnectApi.CdpCalculatedInsightMeasure: Calculated insight measure.
• ConnectApi.CdpDgMetadata: Represents metadata from one or more data graphs.
• ConnectApi.CdpErrorResponse: Error response.
• ConnectApi.CdpIdentityResolutionMatchCriterionOutput: Identity resolution ruleset's match rule criterion.
• ConnectApi.CdpIdentityResolutionMatchCriterionPartyIdentificationInfoOutput: Information when party identification is used in an identity resolution ruleset's match rule criterion.
• ConnectApi.CdpIdentityResolutionMatchRuleOutput: Identity resolution ruleset’s match rule.
• ConnectApi.CdpIdentityResolutionOutput: Identity resolution ruleset.
• ConnectApi.CdpIdentityResolutionReconciliationFieldRuleOutput: Identity resolution ruleset's reconciliation rule for a field.
• ConnectApi.CdpIdentityResolutionReconciliationRuleOutput: Identity resolution ruleset’s reconciliation rule for an object.
• ConnectApi.CdpIdentityResolutionReconciliationSourceOutput: Source for an identity resolution default reconciliation rule or field-specific rule using the SourceSequence match method.
• ConnectApi.CdpIdentityResolutionRunNowOutput: Identity resolution ruleset run now output.
• ConnectApi.CdpIdentityResolutionsOutput: Identity resolution rulesets.
• ConnectApi.CdpMlAggregatePredictCondition: CDP machine-learning aggregate prediction contribution.
• ConnectApi.CdpMlAggregatePrediction: Represents a CDP machine-learning aggregate prediction.
• ConnectApi.CdpMlPredictResult: Represents a CDP machine-learning prediction result.
• ConnectApi.CdpMlPredictSettings: Prediction settings.
• ConnectApi.CdpMlPredictionBase: Prediction result.
• ConnectApi.CdpMlPredictionContributionBase: Base representation for a Prediction Contribution
• ConnectApi.CdpQueryDataGraphMetadata: Represents metadata for a data graph.
• ConnectApi.CdpQueryDataOutput: Query data output.
• ConnectApi.CdpQueryMetadataEntitiesOutput: Represents a list of metadata entities.
• ConnectApi.CdpQueryMetadataEntityOutput: Represents a metadata entity.
• ConnectApi.CdpQueryMetadataItem: Metadata item.
• ConnectApi.CdpQueryMetadataOutput: Query metadata result.
• ConnectApi.CdpQueryOutput: Query result.
• ConnectApi.CdpQueryOutputV2: Query output for the V2 API.
• ConnectApi.CdpQueryV2Row: Row in the query output for the V2 API.
• ConnectApi.CdpSegmentActionOutput: Segment action.
• ConnectApi.CdpSegmentContainerOutput: Segment container.
• ConnectApi.CdpSegmentDbtModel: Segment dbt model.
• ConnectApi.CdpSegmentDbtPipeline: Segment dbt pipeline.
• ConnectApi.CdpSegmentMemberOutput: Data 360 segment member output.
• ConnectApi.CdpSegmentMemberRowOutput: Data 360 segment member row output.
• ConnectApi.CdpSegmentMembershipTableOutput: Data 360 segment membership table.
• ConnectApi.CdpSegmentOutput: Segment.
• ConnectApi.CdpUser: Represents information about a user.
• ConnectApi.ChangeItemOutputRepresentation: The financial changes resulting from a change to one or more OrderItemSummaries. Most of the values represent the deltas of the values on the associated OrderSummary. The sign of each value is the opposite of the corresponding value on a change order record. For example, a discount is a positive value here and a negative value on a change order record.
• ConnectApi.ChangeOrdersInvoiceOutputRepresentation: List of IDs of invoices created for change orders.
• ConnectApi.ChatterActivity: Chatter activity.
• ConnectApi.ChatterActivitySummary: Summary of Chatter activity.
• ConnectApi.ChatterGroup: Chatter group.
• ConnectApi.ChatterLike: Chatter like information.
• ConnectApi.ChatterLikesCapability: If a feed element has this capability, the context user can like it. Exposes information about existing likes.
• ConnectApi.Chunk: Content chunk for the search result.
• ConnectApi.ClientInfo: Client information.
• ConnectApi.CloseCapability: If a feed element has this capability, users with permission can close it.
• ConnectApi.Comment: A comment.
• ConnectApi.CommentCapabilities: A set of capabilities on a comment.
• ConnectApi.CommentPage: A page of comments.
• ConnectApi.CommentSummary: Summary of the comment.
• ConnectApi.CommentsCapability: If a feed element or comment has this capability, the context user can add a comment to it.
• ConnectApi.CommerceActionResult: Result of executing a commerce action.
• ConnectApi.CommerceAddressCollection: A collection of Commerce addresses.
• ConnectApi.CommerceAddressOutput: Address for a Commerce account.
• ConnectApi.CommerceNote: Representation for Note
• ConnectApi.CommerceProductSearchResults: Product search results information.
• ConnectApi.CommerceProductSellingModel: Product selling model information.
• ConnectApi.CommerceProductSummary: Summary of a product in product search results.
• ConnectApi.CommerceProductSummaryPage: Collection of product summary representations in product search results.
• ConnectApi.CommerceQuoteCollection: Representation of quotes associated to an account.
• ConnectApi.CommerceQuoteDetail: Representation of quote details response.
• ConnectApi.CommerceQuoteLineItem: Representation of the quote line item summary lookup.
• ConnectApi.CommerceQuoteWithProductDetail: Representation for Quote basic details
• ConnectApi.CommerceResultRepresentationBase: Base cart calculate output class.
• ConnectApi.CommerceSearchIndexCollection: Collection of indexes.
• ConnectApi.CommerceSearchIndexLog: Search index log information.
• ConnectApi.CommerceSearchIndexLogCollection: Collection of search index logs for a webstore.
• ConnectApi.CommerceSearchIndex: Index information.
• ConnectApi.Community: Experience Cloud site.
• ConnectApi.CommunityPage: Page of Experience Cloud sites.
• ConnectApi.CommunitySummary: Summary of an Experience Cloud site.
• ConnectApi.CompanyVerifySummary: Company verify summary.
• ConnectApi.ComplexSegment: Complex segments of field changes.
• ConnectApi.CompositeCommerceProductOutputRepresentation: Details of a composite product.
• ConnectApi.CompositeCommerceVariationOutputRepresentation: Details of composite product variations.
• ConnectApi.CompoundRecordField: Record field that is a composite of subfields.
• ConnectApi.ConfirmHeldFOCapacityOutputRepresentation: Response to a request to confirm held fulfillment order capacity at one or more locations. Can correspond to one action call.
• ConnectApi.ConfirmHeldFOCapacityResponseOutputRepresentation: Response to a request to confirm held fulfillment order capacity at one or more locations.
• ConnectApi.ConnectionDbSchemaCollection: Represents a collection of database schemas.
• ConnectApi.ContactPointConfig: Represents an activation contact point configuration output.
• ConnectApi.ContactPointFilterExpression: Represents an activation contact point filter expression output.
• ConnectApi.ContactPointsConfig: Represents the activation contact points configuration output.
• ConnectApi.Content: A file attached to a feed item.
• ConnectApi.ContentAttachment: Attachments in feed items with the type ContentPost.
• ConnectApi.ContentCapability: If a comment has this capability, it has a file attachment.
• ConnectApi.ContentHubAllowedItemTypeCollection: The item types that the context user is allowed to create in a repository folder.
• ConnectApi.ContentHubFieldDefinition: A field definition.
• ConnectApi.ContentHubItemTypeDetail: The details of an item type associated with a repository folder.
• ConnectApi.ContentHubItemTypeSummary: The summary of an item type associated with a repository folder.
• ConnectApi.ContentHubPermissionType: A permission type.
• ConnectApi.ContentHubProviderType: The type of repository.
• ConnectApi.ContentHubRepository: A repository.
• ConnectApi.ContentHubRepositoryAuthentication: Authentication information for a repository.
• ConnectApi.ContentHubRepositoryCollection: A collection of repositories.
• ConnectApi.ContentHubRepositoryFeatures: The features of a repository.
• ConnectApi.ContractOutputRepresentation: Contract list.
• ConnectApi.ConversationApplicationDefinitionDetailRespresentation: Information about the conversation application definition.
• ConnectApi.CouponCodeRedemptionCollection: Collection of coupon code redemption results.
• ConnectApi.CouponCodeRedemptionResult: Coupon code redemption result.
• ConnectApi.CreateCreditMemoOutputRepresentation: ID of a created Credit Memo.
• ConnectApi.CreateMultipleInvoicesFromChangeOrdersOutputRepresentation: List of lists of invoices created from change orders for fees.
• ConnectApi.CreateOrderPaymentSummaryOutputRepresentation: ID of the created Order Payment Summary.
• ConnectApi.CreateQuoteFromCartOutput: Representation of the response for creating a quote from a cart.
• ConnectApi.CreateQuoteFromProductOutput: Representation of the response for creating a quote from a product.
• ConnectApi.CreateSocialNamedCredential: Result of a creating a named credential for a social external channel.
• ConnectApi.CreateWebStoreMetaConfiguration: Response for a Webstore Meta Config creation request.
• ConnectApi.Credential: Credential.
• ConnectApi.CredentialCustomHeader: Credential custom header.
• ConnectApi.CredentialValue: Credential value.
• ConnectApi.CurrencyRecordField: Record field containing a currency value.
• ConnectApi.CustomListAudienceCriteria: Criteria for the custom list type of custom recommendation audience.
• ConnectApi.DashboardComponentAttachment: Attachments in feed items with type DashboardSnapshot.
• ConnectApi.DashboardComponentSnapshotCapability: If a feed element has this capability, it has a dashboard component snapshot. A snapshot is a static image of a dashboard component at a specific point in time.
• ConnectApi.DashboardComponentSnapshot: Represents both dashboard component snapshots and alerts you receive when a dashboard component value crosses a threshold.
• ConnectApi.DataCategoryMetadata: Data category metadata for the object.
• ConnectApi.DataCategoryValueMetadata: Data category values for the object's data category.
• ConnectApi.DataConnector: Details about the data connector for an activation target.
• ConnectApi.DataGraphField: Represents a field of a data graph.
• ConnectApi.DataGraphIdsDmo: Represents data about the Data Model Object (DMO) that contains the ID table for the data graph.
• ConnectApi.DataGraphIdsDmoField: Represents the fields of the Data Model Object (DMO) that contains the ID table for the data graph.
• ConnectApi.DataGraphObjectData: Represents object metadata for a data graph.
• ConnectApi.DataGraphRelationship: Represents the relationship of a field of the object data for the data graph.
• ConnectApi.DataGraphValuesDmo: Represents data about the Data Model Object (DMO) that contains the JSON records for the data graph.
• ConnectApi.DataGraphValuesDmoField: Represents the fields of the Data Model Object (DMO) that contains the JSON records for the data graph.
• ConnectApi.DataSpaceCollectionRepresentation: Represents a collection of all data spaces that a user is assigned to.
• ConnectApi.DataSpaceInfoRepresentation: Represents a data space.
• ConnectApi.DataStreamActionResponseOutput: Represents an action on a data stream.
• ConnectApi.DatacloudCompany: Information about a Data.com company.
• ConnectApi.DatacloudCompanies: Lists all companies that were purchased in a specific order, page URLs, and the number of companies in the order.
• ConnectApi.DatacloudContact: Information about a Data.com contact.
• ConnectApi.DatacloudContacts: Lists all contacts that were purchased in the specific order, page URLs, and the number of contacts in the order.
• ConnectApi.DatacloudOrder: Represents a Datacloud order.
• ConnectApi.DatacloudPurchaseUsage: Information about Data.com point usage for monthly and list pool users.
• ConnectApi.DateRecordField: Record field containing a date.
• ConnectApi.DateEstimationOutputRepresentation: Date estimation for product delivery.
• ConnectApi.DeleteIntent: Delete intent for a social post.
• ConnectApi.DeleteSocialPostIntent: Delete intent for the social post.
• ConnectApi.DeleteIntents: List of delete intents for a social post.
• ConnectApi.DeliveryEstimateOutputRepresentation: Delivery estimation information for products.
• ConnectApi.DeliveryEstimationErrorOutputRepresentation: Delivery estimation error.
• ConnectApi.DeliveryRoutingEngineOutputRepresentation: Delivery routing engine output, including ranked routes and the best fulfillment locations for each SKU.
• ConnectApi.DigestJob: Represents a successfully enqueued API digest job request.
• ConnectApi.DirectMessageCapability: If a feed element has this capability, it’s a direct message.
• ConnectApi.DirectMessageMemberPage: A collection of direct message members.
• ConnectApi.DirectMessageMemberActivity: Direct message member activity.
• ConnectApi.DirectMessageMemberActivityPage: A page of direct message member activities.
• ConnectApi.DistanceCalculationOutputRepresentation: Shipping distance data for a set of inventory locations.
• ConnectApi.DistinctFacetValue: Distinct facet value.
• ConnectApi.DistinctFacetValueDisplayMetadataRepresentation: Display metadata representation for a distinct facet value.
• ConnectApi.DistinctValueSearchFacet: Facet with distinct values in product search results.
• ConnectApi.DistributePickedQuantitiesOutputRepresentation: Output representation of where the quantities were distributed in orders and any remaining quantity
• ConnectApi.DmoFilter: Represents a DMO filter output.
• ConnectApi.DmoFilterLimit: Represents a DMO filter limit output.
• ConnectApi.DmoFilterConfig: Represents a DMO filter configuration output.
• ConnectApi.DownVoteSummary: Summary of a downvote.
• ConnectApi.EditCapability: If a feed element or comment has this capability, users who have permission can edit it.
• ConnectApi.EgressPropertiesRepresentation: Represents the details for egress properties of the activation target.
• ConnectApi.EinsteinLlmGenAiSourceReference: Source from a data provider.
• ConnectApi.EinsteinLlmGenerationCitationOutput: Source information associated with a generated response.
• ConnectApi.EinsteinLlmGenerationGenAiCitedReference: Metadata from an input source that is cited in a generated response.
• ConnectApi.EinsteinLlmGenerationGenAiSourceContentInfo: Values from a source that is cited in a generated response.
• ConnectApi.EinsteinLlmGenerationGenAiSourceReferenceInfo: Metadata from a source from a data provider.
• ConnectApi.​EinsteinLLM​GenerationItem​Output: Generated response from the LLM provider.
• ConnectApi.​EinsteinLlm​Generation​ContentQuality​Output: Quality information about the generated response.
• ConnectApi.​EinsteinLlm​Generation​SafetyScore​Output: Safety score information related to the LLM response.
• ConnectApi.EinsteinPromptRecordRepresentation: Prompt template record.
• ConnectApi.EinsteinPromptRecordCollectionOutputRepresentation: List of prompt template records.
• ConnectApi.EinsteinPromptRecordFieldRepresentation: Field values for a prompt template record field.
• ConnectApi.EinsteinPromptTemplateAttachment: Data for file attachments to prompts.
• ConnectApi.EinsteinPromptTemplateAttachmentExclusionInfo: Representation for info of file exclusion from LLM requests
• ConnectApi.​EinsteinPrompt​Template​Generations​Representation: Generated response from the LLM provider and resolved prompt template text.
• ConnectApi.​EinsteinPrompt​Template​GenerationsError: Error response to a prompt template generation request.
• ConnectApi.​EinsteinPrompt​TemplateMask​Content​Representation: Generated response with masked data and masking information for a prompt template.
• ConnectApi.​EinsteinPrompt​TemplateMaskData​Representation: Information about masked data for a prompt template.
• ConnectApi.​EinsteinPrompt​TemplateMaskSettings​Representation: Data masking settings for a prompt template.
• ConnectApi.EinsteinPromptTemplateMergeFieldInformationContext: Representation for merge field information context
• ConnectApi.EmailAddress: Email address.
• ConnectApi.EmailMessage: Email message from a case.
• ConnectApi.EmailAttachment: An email attachment in an email message.
• ConnectApi.EmailMergeFieldInfo: The map for objects and their merge fields.
• ConnectApi.EmailMergeFieldCollectionInfo: The merge fields for an object.
• ConnectApi.EmailMessageCapability: If a feed element has this capability, it has an email message from a case.
• ConnectApi.Emoji: An emoji.
• ConnectApi.EmojiCollection: A collection of emoji.
• ConnectApi.EnhancedLinkCapability: If a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description.
• ConnectApi.EnsureFundsAsyncOutputRepresentation: ID of the asynchronous background operation. This output only includes the operation ID, regardless of whether a call is made to an external payment gateway. It doesn’t include any errors from the operation.
• ConnectApi.EnsurePaymentCreditOutputRepresentation: A list of payment credits created from the credit memo with success status and error information. Shows all payment credits successfully issued to the customer's payment methods and any errors encountered during processing.
• ConnectApi.EnsureRefundsAsyncOutputRepresentation: ID of the asynchronous background operation. This output only includes the operation ID, regardless of whether a call is made to an external payment gateway. It doesn’t include any errors from the operation.
• ConnectApi.EntityLinkSegment: Entity link segment.
• ConnectApi.EntityLabel: An entity's label.
• ConnectApi.EntityRecommendation: A Chatter, custom, or static recommendation.
• ConnectApi.ErrorResponse: Base error response.
• ConnectApi.EstimateDeliveryDateOutputRepresentation: Estimated delivery dates.
• ConnectApi.Extension: An extension.
• ConnectApi.ExtensionDefinition: An extension's definition.
• ConnectApi.ExtensionDefinitions: A collection of extension definitions.
• ConnectApi.ExtensionsCapability: If a feed element has this capability, it has one or more extension attachments.
• ConnectApi.ExternalAuthIdentityProvider: External auth identity provider.
• ConnectApi.ExternalAuthIdentityProviderCredential: External auth identity provider credential.
• ConnectApi.ExternalAuthIdentityProviderCredentials: List of an external auth identity provider's credentials.
• ConnectApi.ExternalAuthIdentityProviderList: List of external auth identity providers in the org.
• ConnectApi.ExternalAuthIdentityProviderParameter: External auth identity provider parameter.
• ConnectApi.ExternalCredential: External credential, including the named credentials and principals associated with it and the type and status of each principal.
• ConnectApi.ExternalCredentialList: List of external credentials.
• ConnectApi.ExternalCredentialParameter: External credential parameter.
• ConnectApi.ExternalCredentialPrincipal: External credential principal.
• ConnectApi.ExternalCredentialPrincipalAccess: External credential principal access.
• ConnectApi.ExternalFilePermissionInformation: External file permission information.
• ConnectApi.ExternalManagedAccountAddressOutput: Default shipping address for an externally managed account.
• ConnectApi.ExternalManagedAccountCollectionOutput: Collection of externally managed accounts.
• ConnectApi.ExternalManagedAccountOutput: Externally managed account.
• ConnectApi.FacetValue: Facet value.
• ConnectApi.Features: Features available to the context user in the org.
• ConnectApi.FeedBody: Feed body.
• ConnectApi.FeedElement: Feed elements are the top-level items that a feed contains. Feeds are feed element containers.
• ConnectApi.FeedElementCapabilities: A container for all capabilities that can be included with a feed element.
• ConnectApi.FeedElementCapability: A feed element capability, which defines the characteristics of a feed element.
• ConnectApi.FeedElementPage: A paged collection of ConnectApi.FeedElement objects.
• ConnectApi.FeedEnabledEntity: An entity that can have feeds associated with it.
• ConnectApi.FeedEntityIsEditable: Indicates if the context user can edit a feed element or comment.
• ConnectApi.FeedEntityNotAvailableSummary: A summary when the feed entity isn’t available.
• ConnectApi.FeedEntityReadSummary: Summary of the feed post or comment that was read.
• ConnectApi.FeedEntityShareCapability: If a feed element or comment has this capability, a feed entity is shared with it.
• ConnectApi.FeedEntitySummary: The summary of a feed entity that is shared with a feed element.
• ConnectApi.FeedItemAttachment: Feed item attachment.
• ConnectApi.FeedItemSummary: A feed item summary.
• ConnectApi.FeedModifiedInfo: Feed modified information.
• ConnectApi.FeedPostSummary: Summary of the post.
• ConnectApi.FeedReadSummary: Summary of the feed that was read.
• ConnectApi.ChatterStream: A Chatter feed stream.
• ConnectApi.ChatterStreamPage: A collection of Chatter feed streams.
• ConnectApi.FetchFilesOutputRepresentation: Output representation returned by ConnectApi.OptimizationFiles.FetchOptimizationFiles(). Contains a map of the Content Version files created in the org for the optimization request.
• ConnectApi.FieldMetadata: Search metadata for the field of an object.
• ConnectApi.RecordFieldValue: Field value.
• ConnectApi.FieldValue: Field's value in product search results.
• ConnectApi.File: File.
• ConnectApi.FileAsset: An asset file.
• ConnectApi.FilePreview: A file preview.
• ConnectApi.FilePreviewCollection: A collection of file previews.
• ConnectApi.FilePreviewUrl: A URL to a file preview.
• ConnectApi.FileSummary: A file summary.
• ConnectApi.FindRoutesWithFewestSplitsOutputRepresentation: A list of inventory location combinations that can fulfill an order without exceeding the maximum number of shipments.
• ConnectApi.FindRoutesWithFewestSplitsUsingOCIOutputRepresentation: A list of order fulfillment routes with inventory availability information.
• ConnectApi.FindRoutesWithFewestSplitsWithInventoryOutputRepresentation: Sets of inventory locations that can combine to fulfill an order, with availability data for those locations.
• ConnectApi.FlowApprovalProcess: Details about a flow approval process, its status, and available actions.
• ConnectApi.FlowApprovalProcessAction: Available actions for a flow approval process.
• ConnectApi.FlowApprovalProcessCollection: The results of requesting a flow approval status.
• ConnectApi.OrchestrationInstance: Orchestration instance.
• ConnectApi.OrchestrationInstanceCollection: Collection of orchestration instances.
• ConnectApi.OrchestrationStageInstance: Orchestration stage instance.
• ConnectApi.OrchestrationStepInstance: Orchestration step instance.
• ConnectApi.OrchestrationWorkItem: Orchestration work item.
• ConnectApi.FollowSocialPersonaIntent: Follow intent on a social persona.
• ConnectApi.FollowIntents: A list of follow intents for a social persona.
• ConnectApi.FollowingCounts: Following counts.
• ConnectApi.FollowingPage: Page of following subscriptions.
• ConnectApi.Form: Marketing integration form.
• ConnectApi.FormField: Marketing integration form field.
• ConnectApi.FormFields: List of marketing integration form fields.
• ConnectApi.FormSubmission: Marketing integration form submission.
• ConnectApi.FormulaScope: Formula scope for a target.
• ConnectApi.FulfillmentGroupOutputRepresentation: Information about one FulfillmentOrder from a request to create fulfillment orders from multiple OrderDeliveryGroupSummaries. If the FulfillmentOrder was created, then its ID is returned. If it failed, then data from the input is returned so you can resubmit it.
• ConnectApi.FulfillmentOrderCancelLineItemsOutputRepresentation: Wraps the base output.
• ConnectApi.FulfillmentOrderInvoiceOutputRepresentation: ID of the created invoice.
• ConnectApi.FulfillmentOrderOutputRepresentation: A list of IDs of the created FulfillmentOrders.
• ConnectApi.GatewayLogResponse: Gateway log output.
• ConnectApi.GenericBundleCapability: If a feed element has this capability, the feed element has a group of other feed elements condensed into one feed element. This group is called a bundle.
• ConnectApi.GenericFeedElement: A concrete implementation of the abstract ConnectApi.FeedElement class.
• ConnectApi.GetFOCapacityValuesOutputRepresentation: Response to a request for fulfillment order capacity values for one or more locations.
• ConnectApi.GroupMemberPage: Page of group members.
• ConnectApi.GroupMembershipRequest: Request to become a group member.
• ConnectApi.GroupMembershipRequests: Requests to become group members.
• ConnectApi.GroupInformation: Describes the Information section of the group. If the group is private, this section is visible only to members.
• ConnectApi.HashtagSegment: Hashtag segment.
• ConnectApi.HideSocialPostIntent: Hide intent for a social post.
• ConnectApi.HoldFOCapacityOutputRepresentation: Response to a request to hold fulfillment order capacity at one or more locations. Can correspond to one action call.
• ConnectApi.HoldFOCapacityResponseOutputRepresentation: Response to a request to hold fulfillment order capacity at one or more locations.
• ConnectApi.HttpHeaderOutputRepresentation: HTTP header with information about a text classification
• ConnectApi.Icon: Icon.
• ConnectApi.ContentImageFileDetails: Image file details.
• ConnectApi.InlineImageSegment: An inline image in the feed body.
• ConnectApi.InsightValuesOutputRepresentation: Insight value details for a business objective, or goal.
• ConnectApi.InsightsOutputRepresentation: Insight details for a business objective, or goal.
• ConnectApi.InteractionsCapability: If a feed element has this capability, it has information about user interactions.
• ConnectApi.Invitation: An invitation.
• ConnectApi.Invitations: A collection of invitations.
• ConnectApi.ItemQuantityOutputRepresentation: The quantity for a specific item
• ConnectApi.KnowledgeArticleVersion: A knowledge article version.
• ConnectApi.KnowledgeArticleVersionCollection: A collection of knowledge article versions.
• ConnectApi.LabeledRecordField: Record field containing a label and a text value.
• ConnectApi.LeadStatusPicklistValueAttributes: Lead status picklist value attributes.
• ConnectApi.LightningExtensionInformation: Lightning extension information.
• ConnectApi.LikeIntent: Like intent for a social post.
• ConnectApi.ChatterLikePage: Page of Chatter likes.
• ConnectApi.LikeSocialPostIntent: Like intent on a social post.
• ConnectApi.LikeIntents: List of like intents for a social post.
• ConnectApi.LikeSummary: Summary of a like.
• ConnectApi.LineItemResponse: Response class that stores information about a list of one or more line items on which the tax engine has calculated tax.
• ConnectApi.LinkAttachment: Link attached to a feed item.
• ConnectApi.LinkCapability: If a feed element has this capability, it has a link.
• ConnectApi.LinkSegment: Link segment.
• ConnectApi.LinkMetadata: Metadata for a link.
• ConnectApi.LinkMetadataCollection: Collection of link metadata.
• ConnectApi.LocationCapacityOutputRepresentation: Fulfillment order capacity values for a location.
• ConnectApi.LocationOutputRepresentation: An inventory location’s distance to an order recipient.
• ConnectApi.MCSFolderShare: Target that a managed content space folder is shared with.
• ConnectApi.MCSFolderShareCollection: Collection of targets that a managed content space folder is shared with.
• ConnectApi.MCSFolderShareTarget: Target that a managed content space folder can be shared with.
• ConnectApi.MCSFolderShareTargetCollection: Collection of targets that a managed content space folder can be shared with.
• ConnectApi.MaintenanceInfo: Information about the upcoming scheduled maintenance for the organization.
• ConnectApi.ManagedContentAssociations: Content topics associated with managed content.
• ConnectApi.ManagedContentChannel: Managed content channel.
• ConnectApi.ManagedContentChannelCollection: Collection of managed content channels.
• ConnectApi.ManagedContentChannelDetail: Managed content channel detail.
• ConnectApi.ManagedContentChannelDomainRepresentation: Domain associated with a managed content channel.
• ConnectApi.ManagedContentChannelSummary: Managed content channel.
• ConnectApi.ManagedContentChannelTargetSummary: Target site associated with the channel.
• ConnectApi.ManagedContentChannelsRepresentation: Collection of managed content channels.
• ConnectApi.ManagedContentCloneStatus: Information about managed content's clone status.
• ConnectApi.ManagedContentClonedVariants: Information about clone variants.
• ConnectApi.ManagedContentCollectionItem: Managed content collection item.
• ConnectApi.ManagedContentCollectionItemTypeSummary: Summary of a collection item type.
• ConnectApi.ManagedContentCollectionItems: Managed content collection Items.
• ConnectApi.ManagedContentDateAndTimeNodeValue: Managed content node of date and time type.
• ConnectApi.ManagedContentDateNodeValue: Managed content node of date type.
• ConnectApi.ManagedContentDeliveryChannelRepresentation: Managed content delivery channel.
• ConnectApi.ManagedContentDeliveryChannelSummaryRepresentation: Summary information of a managed content delivery channel.
• ConnectApi.ManagedContentDeliveryChannelsRepresentation: Collection of managed content delivery channels.
• ConnectApi.ManagedContentDeliveryDocument: Managed content in delivery scope.
• ConnectApi.ManagedContentDeliveryDocumentCollection: Managed content delivery document collection.
• ConnectApi.ManagedContentDeliveryDocumentSummary: Managed content delivery document summary.
• ConnectApi.ManagedContentDeliveryRendition: Managed content rendition for delivery.
• ConnectApi.ManagedContentDeliveryUrlChannel: A delivery channel and the absolute public delivery URL it produces for a media content item.
• ConnectApi.ManagedContentDocument: Information about a piece of managed content in an authoring space.
• ConnectApi.ManagedContentDocumentClone: Managed content document clone.
• ConnectApi.ManagedContentFailedVariants: Information about failed cloned managed content variants if cloning was partially successful.
• ConnectApi.ManagedContentFolderSummary: Information about the managed content folder.
• ConnectApi.ManagedContentItemsDeleteOutput: Result of submitting an asynchronous managed content items delete job.
• ConnectApi.ManagedContentJob: Information about a managed content import or export job.
• ConnectApi.ManagedContentJobSummary: Summary of an asynchronous managed content job.
• ConnectApi.ManagedContentMediaNodeValue: Managed content node of media type.
• ConnectApi.ManagedContentMediaSourceNodeValue: Source of managed content media.
• ConnectApi.ManagedContentMetadata: Single managed content item that was exposed as metadata.
• ConnectApi.ManagedContentMetadataCollection: The results of exposing managed content as metadata.
• ConnectApi.ManagedContentNodeType: Managed content node type.
• ConnectApi.ManagedContentNodeValue: Managed content node.
• ConnectApi.ManagedContentProvider: Information about a managed content provider.
• ConnectApi.ManagedContentProviderCollection: Collection of managed content providers.
• ConnectApi.ManagedContentProviderInstance: Information about a managed content provider instance.
• ConnectApi.ManagedContentPublishOutput: Information about a Publish action
• ConnectApi.ManagedContentReference: Managed content reference.
• ConnectApi.ManagedContentReferenceSummary: Summary of the managed content reference.
• ConnectApi.ManagedContentSpace: Managed content space.
• ConnectApi.ManagedContentSpaceBaseType: Base type of the managed content space.
• ConnectApi.ManagedContentSpaceChannelRepresentation: Managed content space channel.
• ConnectApi.ManagedContentSpaceChannelsRepresentation: List of managed content space channels.
• ConnectApi.ManagedContentSpaceCollectionRepresentation: Collection of managed content spaces.
• ConnectApi.ManagedContentSpaceDeleteRepresentation: Details of an async managed content space delete operation.
• ConnectApi.ManagedContentSpaceSummary: Information about the managed content space.
• ConnectApi.ManagedContentTextNodeValue: Managed content node of text type.
• ConnectApi.ManagedContentType: Managed content type.
• ConnectApi.ManagedContentTypeSummary: Managed content type.
• ConnectApi.ManagedContentUnpublishOutput: Managed content unpublish action.
• ConnectApi.ManagedContentUserSummary: Information about the user who created or modified the content.
• ConnectApi.ManagedContentVariant: Managed content variant.
• ConnectApi.ManagedContentVariantStatusOutput: Information about a managed content variant's status in the authoring space.
• ConnectApi.ManagedContentVersion: Managed content version.
• ConnectApi.ManagedContentVersionCollection: Collection of managed content versions.
• ConnectApi.BaseManagedSocialAccount: Base information describing a managed social account or fan page of a social network.
• ConnectApi.ManagedSocialAccount: Information describing a managed social account or fan page of a social network.
• ConnectApi.ManagedSocialAccounts: A list of managed social accounts.
• ConnectApi.ManagedTopic: Represents a managed topic in an Experience Cloud site.
• ConnectApi.ManagedTopicCollection: A collection of managed topics.
• ConnectApi.MarkupBeginSegment: The beginning of rich text markup.
• ConnectApi.MarkupEndSegment: The end of rich text markup.
• ConnectApi.MatchInfo: Search information related to the search result.
• ConnectApi.MediaReference: A media reference.
• ConnectApi.MediaReferenceCapability: If a feed element has this capability, it has one or more media references.
• ConnectApi.MentionValidation: Information about whether a proposed mention is valid for the context user.
• ConnectApi.MentionValidations: Information about whether a set of mentions is valid for the context user.
• ConnectApi.MentionCompletion: Information about a record that could be used to @mention a user or group.
• ConnectApi.MentionCompletionPage: Paginated list of Mention Completion response bodies.
• ConnectApi.MentionSegment: Mention segment.
• ConnectApi.ModerationFlags: Information about the moderation flags on a feed item, comment, or file.
• ConnectApi.ModerationCapability: If a feed element has this capability, users in an Experience Cloud site can flag it for moderation.
• ConnectApi.ModerationFlagItemDetail: Flag details on a feed item, comment, or file.
• ConnectApi.ModerationFlagsCollection: A collection of flags on a feed item, comment, or file.
• ConnectApi.MoreChangesSegment: In feed items with a large number of tracked changes, the message is formatted as: “changed A, B, and made X more changes.” The MoreChangesSegment contains the “X more changes.”
• ConnectApi.Motif: The motif properties contain URLs for small, medium, and large icons that indicate the Salesforce record type. Common record types are files, users, and groups, but all record types have a set of motif icons. Custom object records use their tab style icon. All icons are available to unauthenticated users so that, for example, you can display the motif icons in an email. The motif can also contain the record type’s base color.
• ConnectApi.MessageBody: Message body.
• ConnectApi.MessageSegment: Message segment.
• ConnectApi.MultipleAsyncOutputRepresentation: IDs of the asynchronous background operations. This output only includes the operation IDs, regardless of whether calls are made to an external payment gateway. It doesn’t include any errors from the operations.
• ConnectApi.FilesCapability: If a feed element has this capability, it has one or more file attachments.
• ConnectApi.MultipleFulfillmentOrderInvoicesOutputRepresentation: IDs of the created Invoices.
• ConnectApi.MultipleFulfillmentOrderOutputRepresentation: A list of responses for the individual FulfillmentOrder creation attempts from a request to create multiple fulfillment orders.
• ConnectApi.MuteCapability: If a feed element has this capability, users can mute it. Muted feed elements are visible in the muted feed, and invisible in all other feeds that respect mute.
• ConnectApi.MuteSummary: Summary of a mute.
• ConnectApi.NBAActionParameter: A parameter for an action.
• ConnectApi.NBAFlowAction: A recommended flow.
• ConnectApi.NBANativeRecommendation: A record the user is recommended to take action on.
• ConnectApi.RecommendationReaction: A reaction to a recommendation produced by a recommendation strategy
• ConnectApi.RecommendationReactions: A list of recommendation reactions.
• ConnectApi.NBARecommendation: A recommendation returned by a recommendation strategy.
• ConnectApi.NBARecommendations: Recommendations returned by a recommendation strategy.
• ConnectApi.NamedCredential: Named credential associated with an external credential.
• ConnectApi.NamedCredentialCalloutOptions: Named credential callout options.
• ConnectApi.NamedCredentialList: List of named credentials.
• ConnectApi.NamedCredentialParameter: Named credential parameter.
• ConnectApi.NavigationMenuItem: Navigation menu item.
• ConnectApi.NavigationMenuItemCollection: Collection of navigation menu items.
• ConnectApi.NavigationMenuPageReference: Navigation menu item page reference.
• ConnectApi.NetworkConnection: External network connection.
• ConnectApi.ShiftsFromPattern: Shifts created from a pattern.
• ConnectApi.NewUserAudienceCriteria: Criteria for the new members type of custom recommendation audience.
• ConnectApi.NonEntityRecommendation: A recommendation for a non-Salesforce entity, such as an application.
• ConnectApi.OAuthCredentialAuthUrl: OAuth authentication URL for a credential.
• ConnectApi.OCIBaseOutputRepresentation: Base Omnichannel Inventory output class.
• ConnectApi.OCICreateReservationErrorOutputRepresentation: Error returned from an attempt to create an Omnichannel Inventory reservation.
• ConnectApi.OCICreateReservationOutputRepresentation: Result of an Omnichannel Inventory reservation creation request.
• ConnectApi.OCICreateReservationSingleOutputRepresentation: Details of an inventory reservation for one product.
• ConnectApi.OCIFulfillReservationErrorOutputRepresentation: Response to a request to fulfill one inventory reservation.
• ConnectApi.OCIFulfillReservationOutputRepresentation: Response to a request to fulfill one or more inventory reservations.
• ConnectApi.OCIFulfillReservationSingleOutputRepresentation: Details of a single fulfilled reservation.
• ConnectApi.OCIFutureInventoryOutputRepresentation: An expected future inventory restock.
• ConnectApi.OCIGetInventoryAvailabilityOutputRepresentation: Response to a request for inventory availability data.
• ConnectApi.OCIInventoryRecordOutputRepresentation: Inventory availability data for a product.
• ConnectApi.OCILocationAvailabilityOutputRepresentation: A set of inventory availability data for one inventory location.
• ConnectApi.OCILocationGroupAvailabilityOutputRepresentation: A set of inventory availability data for one inventory location group.
• ConnectApi.OCIPublishLocationStructureOutputRepresentation: Response to a publish location structure request.
• ConnectApi.OCIPublishLocationStructureStatusOutputRepresentation: Detailed status of a publish location structure job.
• ConnectApi.OCIReleaseReservationErrorOutputRepresentation: Response to a request to release one inventory reservation.
• ConnectApi.OCIReleaseReservationOutputRepresentation: Response to a request to release one or more inventory reservations.
• ConnectApi.OCIReleaseReservationSingleOutputRepresentation: Details of a single released reservation.
• ConnectApi.OCITransferReservationErrorOutputRepresentation: Response to a request to fulfill one inventory reservation.
• ConnectApi.OCITransferReservationOutputRepresentation: Response to a request to transfer one or more inventory reservations.
• ConnectApi.OCITransferReservationSingleOutputRepresentation: Details of a single transferred reservation.
• ConnectApi.OCIUpdateReservationErrorOutputRepresentation: Error output representation for the update inventory reservation.
• ConnectApi.OCIUpdateReservationOutputRepresentation: Result of an Omnichannel Inventory update request for reserved inventory.
• ConnectApi.OCIUpdateReservationSingleOutputRepresentation: Details of an updated reservation for one product.
• ConnectApi.OCIUploadInventoryAvailabilityOutputRepresentation: Response to an upload inventory availability job.
• ConnectApi.OCIUploadInventoryAvailabilityStatusOutputRepresentation: Detailed status of an upload inventory availability job.
• ConnectApi.OauthProviderInfo: OAuth provider information.
• ConnectApi.UserOauthInfo: User OAuth information.
• ConnectApi.ObjectMetadata: Search metadata related to the object.
• ConnectApi.ObjectQueryInfo: Search query metadata related to the object.
• ConnectApi.OpportunityStagePicklistValueAttributes: Opportunity stage picklist value attributes.
• ConnectApi.OrderDeliveryGroupSummary: Order delivery group summary.
• ConnectApi.OrderDeliveryGroupSummaryCollection: Collection of order delivery group summaries.
• ConnectApi.OrderDeliveryGroupSummaryLookupOutput: Order delivery group summary lookup output.
• ConnectApi.OrderDeliveryMethodLookupOutput: Order delivery method lookup output.
• ConnectApi.OrderItemSummary: Order item summary.
• ConnectApi.OrderItemSummaryAdjustmentAggregates: Adjustment aggregates associated with an order item summary.
• ConnectApi.OrderItemSummaryAdjustmentCollection: Collection of adjustments for order item summaries.
• ConnectApi.OrderItemSummaryAdjustmentList: Representation for list of adjustments for an Order Item Summary.
• ConnectApi.OrderItemSummaryCollection: Collection of order item summaries.
• ConnectApi.OrderItemSummaryLookupOutput: Order item summary lookup output.
• ConnectApi.OrderItemSummaryOutputRepresentation: Details of an OrderItemSummary from a failed FulfillmentOrder in a create multiple fulfillment orders request.
• ConnectApi.OrderItemSummaryProduct: Product item mapped to the order item summary.
• ConnectApi.OrderQuantitiesOutputRepresentation: Output groupings of items in an order
• ConnectApi.OrderShipment: Order shipment.
• ConnectApi.OrderShipmentCollection: Collection of order shipments.
• ConnectApi.OrderShipmentItem: Shipment item.
• ConnectApi.OrderShipmentItemCollection: Collection of order shipment items.
• ConnectApi.OrderSummaryRepresentation: Order summary.
• ConnectApi.OrderSummaryAdjustment: Adjustment associated with an order summary.
• ConnectApi.OrderSummaryAdjustmentAggregates: Adjustment aggregates associated with an order summary.
• ConnectApi.OrderSummaryAdjustmentAggregatesAsyncOutput: Async adjustment aggregates output.
• ConnectApi.OrderSummaryAdjustmentCollection: Collection of adjustments for an order summary.
• ConnectApi.OrderSummaryCollectionRepresentation: Collection of order summaries.
• ConnectApi.OrderSummaryLookupOutput: Order summary lookup output.
• ConnectApi.OrderSummaryOutputRepresentation: ID of the created Order Summary.
• ConnectApi.OrderSummaryProductAttribute: Order summary product attribute representation.
• ConnectApi.OrderSummaryProductLookupOutput: Order summary product lookup output.
• ConnectApi.OrderToCartFailedProduct: Product that could not be added to the cart from an order, with error information.
• ConnectApi.OrderToCartResult: Result of action adding an order to a cart.
• ConnectApi.OrganizationSettings: Org settings.
• ConnectApi.OriginCapability: If a feed element has this capability, it was created by a feed action.
• ConnectApi.OutOfOffice: User's out-of-office message.
• ConnectApi.PageInfo: Page position information for the object search.
• ConnectApi.PardotBusinessUnitContextItem: Pardot business unit context item.
• ConnectApi.PardotBusinessUnitContextOutput: Pardot business unit context.
• ConnectApi.PaymentAuthorizationResponse: Payment authorization output representation.
• ConnectApi.PaymentCreditOutputRepresentation: The payment credit ID, amount, and order payment summary ID for a newly created payment credit. Represents a single credit transaction that was applied to a specific payment method with the generated credit ID for tracking.
• ConnectApi.PaymentCreditSequenceItemOutputRepresentation: The representation of individual payment credit items. Each item represents a specific payment method and the amount of credit to be applied to it.
• ConnectApi.PaymentGroupResponse: Payment group.
• ConnectApi.PaymentMethodDetails: Details about the payment method.
• ConnectApi.PaymentMethodResponse: Payment method information response.
• ConnectApi.PaymentMethodTokenizationGatewayResponse: Payment method tokenization gateway response representation.
• ConnectApi.PaymentMethodTokenizationResponse: Payment method tokenization output representation.
• ConnectApi.PaymentResponse: Payment output.
• ConnectApi.PercentRecordField: Record field containing a percentage value.
• ConnectApi.PhoneNumber: Phone number.
• ConnectApi.Photo: Profile photo.
• ConnectApi.PicklistRecordField: Record field containing an enumerated value.
• ConnectApi.PicklistValue: Picklist value.
• ConnectApi.PicklistValues: Picklist values for a field, scoped to a record type. If a picklist is dependent, this response includes the values of its immediate controlling field and how they map to the picklist.
• ConnectApi.PicklistValuesCollection: Collection of picklist values for all the picklists of a record type.
• ConnectApi.PinCapability: If a feed element has this capability, users who have permission can pin it to a feed.
• ConnectApi.PinnedFeedElements: List of pinned feed elements for a feed.
• ConnectApi.PlatformAction: A platform action instance with state information for the context user.
• ConnectApi.PlatformActionGroup: A platform action group instance with state appropriate for the context user.
• ConnectApi.PollCapability: If a feed element has this capability, it includes a poll.
• ConnectApi.PostAuthGatewayResponse: Gateway response after confirmation that the merchant is ready to capture payment of an existing pre-authorized transaction.
• ConnectApi.PostAuthorizationResponse: Gateway response following a post authorization request.
• ConnectApi.PreserveCart: Represents a preserved cart.
• ConnectApi.PreviewCancelOutputRepresentation: Expected financial values for a proposed cancel action.
• ConnectApi.PreviewCartToExchangeOrderOutputRepresentation: Expected change order financial values for the preview cart to exchange order action.
• ConnectApi.PreviewChangeOrderSummaryOutputRepresentation: Expected financial values for a proposed change order summary action.
• ConnectApi.PreviewReturnOutputRepresentation: Expected financial values for a proposed return action.
• ConnectApi.PriceAdjustmentSchedule: Price adjustment schedule.
• ConnectApi.PriceAdjustmentTier: Price adjustment tier.
• ConnectApi.PricingResult: Product pricing result.
• ConnectApi.PricingResultLineItem: Pricing result line item.
• ConnectApi.ProductOutputRepresentation: Output representation for product data.
• ConnectApi.ProductAttributeInfo: Product attribute information.
• ConnectApi.ProductAttributeSelectionInfo: Product attribute.
• ConnectApi.ProductAttributeSet: Product attribute set data.
• ConnectApi.ProductAttributeSetInfo: Attribute set metadata.
• ConnectApi.ProductAttributeSetSummary: Summary of a product attribute set.
• ConnectApi.ProductAttributeSummary: Summary of a product attribute.
• ConnectApi.ProductAttributeValueMetadataRepresentation: Metadata for a product attribute value.
• ConnectApi.ProductAttributesToProductEntry: Mapping of an attribute value combination to a variation product ID.
• ConnectApi.ProductBundleChildOutput: Output representation of a product details bundle child.
• ConnectApi.ProductCartItem: Cart items of a specific product type.
• ConnectApi.ProductCartItemCollection: Items in the cart, grouped by product type.
• ConnectApi.ProductCategoryData: Product category.
• ConnectApi.ProductCategoryDetail: Details of a product category.
• ConnectApi.ProductCategoryDetailCollection: Collection of product category details.
• ConnectApi.ProductCategoryMedia: Media associated with a product category.
• ConnectApi.ProductCategoryMediaGroup: Media group associated with a product category.
• ConnectApi.ProductCategoryPath: List of product categories in a path.
• ConnectApi.ProductChild: Child product related to a parent product.
• ConnectApi.ProductChildCollection: Collection of child products related to a parent product.
• ConnectApi.ProductDeliverEstimationOutputRepresentation: Delivery estimation information for each product.
• ConnectApi.ProductDetail: Details of a product.
• ConnectApi.ProductDetailsOutputRepresentation: Details about a product.
• ConnectApi.ProductEntitlement: Entitlements for a product.
• ConnectApi.ProductExpandOutputRepresentation: Product expand information with return reasons.
• ConnectApi.ProductImageGroupOutputRepresentation: Details about a product image group.
• ConnectApi.ProductImageOutputRepresentation: Details about a product image.
• ConnectApi.ProductsListOutputRepresentation: Output representation of products with product data along with expand details.
• ConnectApi.ProductMedia: Media associated with a product.
• ConnectApi.ProductMediaGroup: Media group associated with a product.
• ConnectApi.ProductOverview: Overview of a product, with summary information about prices, selected fields, and the product’s default image.
• ConnectApi.ProductOverviewCollection: Collection of product overviews.
• ConnectApi.ProductPrice: Pricing information for a product.
• ConnectApi.ProductPriceEntry: Line item price for the product.
• ConnectApi.ProductReturnRateListOutputRepresentation: Products with corresponding return rates.
• ConnectApi.ProductReturnRateOutputRepresentation: Return rate of a product (units returned divided by units sold).
• ConnectApi.ProductSearchFacetOutputRepresentation: Product search facet value.
• ConnectApi.ProductSearchFacetValueOutputRepresentation: Output representation of a product search facet value.
• ConnectApi.ProductSearchImageOutputRepresentation: Output representation of the product search image.
• ConnectApi.ProductSearchOutputRepresentation: Output representation of the product search response
• ConnectApi.ProductSearchProductOutputRepresentation: Product found by a product search.
• ConnectApi.ProductSearchResults: Product search results.
• ConnectApi.ProductSearchSuggestionsResults: Product search suggestions results.
• ConnectApi.ProductSellingModel: Product selling model for Commerce subscriptions.
• ConnectApi.ProductSummary: Product summary.
• ConnectApi.ProductSummaryPage: Page of product summaries.
• ConnectApi.ProductVariantOutputRepresentation: Details about a product variation.
• ConnectApi.ProductVariationAttributeOutputRepresentation: Details about a product variation attribute.
• ConnectApi.ProductVariationAttributeValueOutputRepresentation: Valid value for a product variation attribute.
• ConnectApi.ProductVariationAttributesRepresentation: Representation of product variation attributes.
• ConnectApi.ProductVariationInfo: Product variation attributes, metadata, and mappings of attribute combinations to variation product IDs.
• ConnectApi.PromotionApproachingDiscount: Qualifier for a promotion with an approaching discount.
• ConnectApi.PromotionCart: A cart, its items, and its adjustment groups.
• ConnectApi.PromotionCartAdjustmentGroup: Adjustment group associated with a cart.
• ConnectApi.PromotionCartItem: A cart item and its adjustments.
• ConnectApi.PromotionCartItemPriceAdjustment: Price adjustments applied to a cart item.
• ConnectApi.PromotionCoupon: A coupon used in a promotion.
• ConnectApi.PromotionEvaluation: Results of a promotion evaluation.
• ConnectApi.Recommendation: A Next Best Action recommendation object.
• ConnectApi.PurchaseQuantityRule: Rule that restricts the quantity of a product that can be purchased.
• ConnectApi.QueryInfo: Query execution information.
• ConnectApi.QueryPath: Represents a query path.
• ConnectApi.QueryPathConfig: Represents a query path configuration.
• ConnectApi.QueryPathConfigList: Represents a list of query path configurations.
• ConnectApi.QuerySqlOutput: Represents the SQL query output.
• ConnectApi.QuerySqlMetadataItem: Represents the metadata associated with an SQL query output.
• ConnectApi.QuerySqlPageOutput: Represents the rows output for an SQL query.
• ConnectApi.QuerySqlRow: Represents data associated with the an SQL query output.
• ConnectApi.QuerySqlStatus: Represents the status of an SQL query.
• ConnectApi.QuestionAndAnswersSuggestions: Question and answers suggestions.
• ConnectApi.QuestionAndAnswersCapability: If a feed element has this capability, it has a question and comments on the feed element are answers to the question.
• ConnectApi.QuoteError: Error representation.
• ConnectApi.RangeFacetDisplayMetadataRepresentation: Display metadata representation for a range facet.
• ConnectApi.RangeSearchFacet: Range facet with minimum and maximum values in product search results.
• ConnectApi.RankAverageDistanceOutputRepresentation: The results of calculating the average distances from sets of inventory locations to an order recipient.
• ConnectApi.ReadBy: Information about who read the feed element and when.
• ConnectApi.ReadByCapability: If a feed element has this capability, the context user can mark it as read.
• ConnectApi.ReadByPage: A collection of information about who read the feed element and when.
• ConnectApi.RecRepresentation: Recommended action.
• ConnectApi.RecommendationExplanation: Explanation for a Chatter recommendation.
• ConnectApi.RecordSummary: Record summary.
• ConnectApi.RecencyCriteria: Represents recency criteria of the object data for a data graph.
• ConnectApi.RecommendationAudience: A custom recommendation audience.
• ConnectApi.RecommendationAudiencePage: A list of custom recommendation audiences.
• ConnectApi.RecommendationsCapability: If a feed element has this capability, it has a recommendation.
• ConnectApi.RecommendationCollection: A list of Chatter, custom, and static recommendations.
• ConnectApi.RecommendationDefinition: Represents a custom recommendation definition.
• ConnectApi.RecommendationDefinitionPage: A list of custom recommendation definitions.
• ConnectApi.RecommendationsOutputRepresentation: List of recommended actions.
• ConnectApi.RecommendedObject: A recommended object, such as a custom or static recommendation.
• ConnectApi.RecordField: Generic record field containing a label and text value.
• ConnectApi.RecordSummaryList: Summary information about a list of records in the organization including custom objects.
• ConnectApi.RecordView: A view of any record in the org, including a custom object record. This object is used if a specialized object, such as User or ChatterGroup, isn’t available for the record type.
• ConnectApi.RecordViewSection: Section of record fields and values on a record detail.
• ConnectApi.RecordCapability: If a comment has this capability, it has a record attachment.
• ConnectApi.RecordSnapshot: A record snapshot in a recommendation reaction.
• ConnectApi.RecordSnapshotAttachment: Fields of a record at the point in time when the record was created.
• ConnectApi.RecordSnapshotCapability: If a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event.
• ConnectApi.RecordsetFilterCriteria: Recordset filter criteria and the filtered records.
• ConnectApi.RecordsetFilterCriteriaCollection: List of the recordset filters and records.
• ConnectApi.Reference: Reference to a record.
• ConnectApi.ReferenceRecordField: Record field with a label and text value.
• ConnectApi.ReferenceWithDateRecordField: Record field containing a referenced object that acted at a specific time, for example, “Created By...”.
• ConnectApi.RefundGatewayResponse: Refund gateway response.
• ConnectApi.RefundInstructionsHintOutputRepresentation: Instructions showing the sequence in which credits and refunds were issued to the customer.
• ConnectApi.RefundResponse: Refund output.
• ConnectApi.RefundSequenceItemOutputRepresentation: The order payment summary ID and amount of the processed refund items.
• ConnectApi.ReferencedRefundResponse: Refund comprehensive output.
• ConnectApi.RegisterGuestBuyerOutputRepresentation: Indicates success or failure of a register guest buyer action.
• ConnectApi.RelatedQuestion: A related question.
• ConnectApi.ReleaseHeldFOCapacityOutputRepresentation: Response to a request to confirm held fulfillment order capacity at one or more locations. Can correspond to one action call.
• ConnectApi.ReleaseHeldFOCapacityResponseOutputRepresentation: Response to a request to release held fulfillment order capacity at one or more locations.
• ConnectApi.ReplyIntent: Reply intent for a social post.
• ConnectApi.ReplyIntents: List of reply intents for a social post.
• ConnectApi.RepositoryFileDetail: A detailed description of a repository file.
• ConnectApi.RepositoryFileSummary: A summary of a repository file.
• ConnectApi.RepositoryFolderDetail: A detailed description of a repository folder.
• ConnectApi.RepositoryFolderItem: A folder item.
• ConnectApi.RepositoryFolderItemsCollection: A collection of repository folder items.
• ConnectApi.RepositoryFolderSummary: A summary of a repository folder.
• ConnectApi.RepositoryGroupSummary: A group summary.
• ConnectApi.RepositoryUserSummary: A user summary.
• ConnectApi.Reputation: Reputation for a user.
• ConnectApi.ReputationLevel: Reputation level for a user.
• ConnectApi.RequestHeader: An HTTP request header name and value pair.
• ConnectApi.ResourceLinkSegment: Resource link segment.
• Retired ConnectApi Output Classes: These ConnectApi output classes are retired.
• ConnectApi.ReturnItemsOutputRepresentation: Output of Return Items. Includes the ID of the generated change order for items and delivery charges being returned, as well as the ID of the generated change order for any charged return fees. Also includes information about any ReturnOrderLineItems that were created to represent remaining return quantities.
• ConnectApi.ReturnOrderItemSplitLineOutputRepresentation: After a change order is created for a ReturnOrderLineItem, that ReturnOrderLineItem is read-only. If the Return Items API is used to return a partial quantity, it creates a new “split” ReturnOrderLineItem to hold the remaining quantity to be returned. In that case, it returns this output property, which contains the IDs of the original and split ReturnOrderLineItems.
• ConnectApi.ReturnOrderOutputRepresentation: ID of the created ReturnOrder.
• ConnectApi.RouteLocationOutputRepresentation: A fulfillment location within a route, including the products fulfilled from that location.
• ConnectApi.RouteOutputRepresentation: A single possible fulfillment route, including its aggregated score and the locations that make up the route.
• ConnectApi.RouteProductOutputRepresentation: A product allocated to a fulfillment location within a route, including its allocated quantity and score.
• ConnectApi.SaleGatewayResponse: Sale gateway response.
• ConnectApi.SaleResponse: Payment sale response.
• ConnectApi.ScheduledRecommendation: Represents a scheduled custom recommendation.
• ConnectApi.ScheduledRecommendationPage: A list of scheduled custom recommendations.
• ConnectApi.Scope: Scope information for a target.
• ConnectApi.ScopedSearchResults: Keyword search results for an object.
• ConnectApi.SearchAnswer: Results of searching objects using a natural language query.
• ConnectApi.SearchCategory: Search category.
• ConnectApi.SearchFacet: Search facet.
• ConnectApi.SearchObject: Record results for the keyword search.
• ConnectApi.SearchResult: Results from searching an object using keywords.
• ConnectApi.SearchResultGroups: Results of searching objects using keywords.
• ConnectApi.SearchResultGroup: Search result group.
• ConnectApi.SearchSuggestion: Search suggestion.
• ConnectApi.ServiceAppointmentOutput: Output of the create service appointment request.
• ConnectApi.ServiceAppointmentResult: Contains result of the service appointment.
• ConnectApi.ShiftsFromPatternError: Shifts from pattern error response.
• ConnectApi.SiteSearchItem: Site search result item.
• ConnectApi.SiteSearchResult: Site search result.
• ConnectApi.SocialAccount: A social account on a social network.
• ConnectApi.SocialAccountRelationship: Follow relationship between a managed social account and a social persona.
• ConnectApi.SocialPostCapability: If a feed element has this capability, it can interact with a social post on a social network.
• ConnectApi.SocialPostIntents: Intents available for a social post.
• ConnectApi.SocialPostMassApprovalOutput: Approval or rejection of a large number of social posts.
• ConnectApi.SocialPostStatus: The status of a social post.
• ConnectApi.SortRule: Sort rule.
• ConnectApi.SortRulesCollection: Collection of sort rules.
• ConnectApi.SpellCorrectionInfo: Spell correction information for object search.
• ConnectApi.Stamp: A user stamp.
• ConnectApi.StaticData: Represents the static data output.
• ConnectApi.StaticDataConfig: Represents the static attributes configuration output.
• ConnectApi.SearchStatus: Provides status on the object search.
• ConnectApi.StatusCapability: If a feed post or comment has this capability, it has a status that determines its visibility.
• ConnectApi.SocialStatusRepresentation: Status response for Webstore Meta Config entity creation.
• ConnectApi.StrategyTrace: Messages and trace nodes for a recommendation strategy execution.
• ConnectApi.StrategyTraceNode: A trace node for a recommendation strategy execution.
• ConnectApi.SubmitCancelOutputRepresentation: ID of the change order created for a cancel action, and a set of its financial values.
• ConnectApi.SubmitCartToExchangeOrderOutputRepresentation: Exhange order summary resulting from a submit cart to exchange order action.
• ConnectApi.SubmitChangeOrderSummaryOutputRepresentation: ID of the change order created for a submit change order summary action, and a set of its financial values.
• ConnectApi.SubmitReturnOutputRepresentation: ID of the change order created for a return action, and a set of its financial values.
• ConnectApi.Subscription: Subscription.
• ConnectApi.SubscriptionTermRule: Subscription term rules.
• ConnectApi.SupportedEmojis: A collection of supported emoji.
• ConnectApi.SurveyInvitationEmailOutput: Survey invitation email.
• ConnectApi.Target: Personalization target information.
• ConnectApi.TargetCollection: List of personalization targets.
• ConnectApi.TaxAmountDetailsResponse: Information about tax amount values on the line item.
• ConnectApi.TaxDetailsResponse: Tax details for each line item in a tax line item output.
• ConnectApi.TaxEngineLogResponse: Shows the results of the tax calculation request to the tax engine.
• ConnectApi.TaxImpositionResponse: Tax imposition output representation.
• ConnectApi.TaxJurisdictionResponse: Represents the address or jurisdiction of the primary business used for calculating tax.
• ConnectApi.TaxTransactionResponse: Tax transaction output representation
• ConnectApi.TextClassificationsOutputRepresentation: HTTP headers containing URLs associating text strings and classifications.
• ConnectApi.TextClassificationsBulkResultsOutputRepresentation: Text classification to get results for multiple text classification request IDs.
• ConnectApi.TextClassificationsResultWithIdOutputRepresentation: Classified text with status and text classification request IDs.
• ConnectApi.TextClassificationsResultOutputRepresentation: Text classifications result.
• ConnectApi.ThemeInfo: Theme information related to an object.
• ConnectApi.TimeZone: User's time zone as selected in the user’s personal settings in Salesforce. This value doesn’t reflect a device's current location.
• ConnectApi.Topic: Topic.
• ConnectApi.TopicPage: Page of topics.
• ConnectApi.TopicSuggestion: Topic suggestion.
• ConnectApi.TopicSuggestionPage: Page of topic suggestions.
• ConnectApi.TopicEndorsementSummary: Topic endorsement summary.
• ConnectApi.TopicImages: Images associated with a topic.
• ConnectApi.TopicSummary: Summary of a topic.
• ConnectApi.TopicEndorsement: Represents one user endorsing another user for a single topic.
• ConnectApi.TopicEndorsementCollection: Collection of topic endorsement response bodies.
• ConnectApi.TopicsCapability: If a feed element has this capability, the context user can add topics to it. Topics help users organize and discover conversations.
• ConnectApi.TrackedChangeBundleCapability: If a feed element has this capability, it has a group of other feed elements aggregated into one feed element called a bundle. This type of bundle aggregates feed tracked changes.
• ConnectApi.TrackedChangesCapability: If a feed element has this capability, it contains all changes to a record for a single tracked change event.
• ConnectApi.TextSegment: Text segment.
• ConnectApi.TypeAndFilter: Represents the type and filter output.
• ConnectApi.UnauthenticatedUser: Unauthenticated user.
• ConnectApi.UpDownVoteCapability: If a feed post or comment has this capability, users can upvote or downvote it.
• ConnectApi.UpVoteSummary: Summary of an upvote.
• ConnectApi.UpdateQuoteOutput: Representation of the quote update response.
• ConnectApi.UserActivitiesJob: User activities job.
• ConnectApi.UserActivityCollection: User activity collection.
• ConnectApi.UserCapabilities: Capabilities associated with a user profile.
• ConnectApi.UserChatterSettings: User’s global Chatter settings.
• ConnectApi.UserDetail: Details about a user in an org.
• ConnectApi.UserGroupDetailPage: A page of groups that a user is a member of.
• ConnectApi.UserGroupPage: A paginated list of groups the context user is a member of.
• ConnectApi.UserMission: Mission details for a user.
• ConnectApi.UserMissionActivitiesJob: User mission activities job.
• ConnectApi.UserMissionActivity: User activity associated with missions.
• ConnectApi.UserMissionActivityCollection: List of mission activities for a user.
• ConnectApi.UserMissionActivityStatus: Status of mission activity for a user.
• ConnectApi.UserPage: Page of users.
• ConnectApi.UserProfile: Details necessary to render a view of a user profile.
• ConnectApi.UserProfileTab: Information about a profile tab.
• ConnectApi.UserReferencePage: A list of user references.
• ConnectApi.UserSummary: User summary.
• ConnectApi.UserSettings: Settings specific to a user.
• ConnectApi.VerifiedCapability: If a comment has this capability, users with permission can mark it as verified or unverified.
• ConnectApi.Vote: An upvote or downvote on a feed element or comment.
• ConnectApi.VotePage: A page of upvotes or downvotes on a feed element or comment.
• ConnectApi.WebStoreMetaConfig: Details of a webstore Meta configuration.
• ConnectApi.WebStoreMetaConfigurations: List of webstore Meta configurations.
• ConnectApi.Wishlist: Wishlist, including summary and items.
• ConnectApi.WishlistItem: Item in a wishlist.
• ConnectApi.WishlistItemCollection: Collection of wishlist items.
• ConnectApi.WishlistsSummary: List of wishlist summaries and the displayed list for the context user.
• ConnectApi.WishlistSummary: Summary of a wishlist.
• ConnectApi.WishlistToCartResult: Result of adding a wishlist to a cart.
• ConnectApi.WorkStepPicklistValueAttribute: Work step picklist value attributes.
• ConnectApi.WrappedMapObject: Map of a parameter name and value.
• ConnectApi.Zone: Information about a Chatter Answers zone.
• ConnectApi.ZonePage: Page of zones.
• ConnectApi.ZoneSearchPage: Page of zone search results.
• ConnectApi.ZoneSearchResult: Information about a specific zone search result.
• ConnectApi Release Notes: Use the Salesforce Release Notes to learn about the most recent updates and changes to the ConnectApi namespace in Apex.
• LeadConvert Class: Contains information used for lead conversion.Creates a new instance of the Database.LeadConvert class.Gets the ID of the account into which the lead will be merged. This method is for internal use only.This method is for internal use only.This method is for internal use only.Gets the ID of the contact into which the lead will be merged. This method is for internal use only.Gets the lead status value for a converted lead.Gets the ID of the lead to convert. Gets the ID of the existing opportunity that will be related to the resulting contact.Gets the name of the opportunity to create. This method is for internal use only.Gets the ID of the person to own any newly created account, contact, and opportunity.Gets the ID of the existing person account into which the lead will be converted. Gets the entity record of the new person account into which the lead will be converted. Indicates whether an Opportunity is created during lead conversion (false, the default) or not (true).Indicates whether the LeadSource field on the target Contact object is overwritten with the contents of the LeadSource field in the source Lead object (true), or not (false, the default). Indicates whether a notification email is sent to the owner specified by setOwnerId (true) or not (false, the default).Sets the ID of the account into which the lead is merged. This value is required only when updating an existing account, including person accounts. This method is for internal use only.This method is for internal use only.This method is for internal use only.Sets the ID of the contact into which the lead will be merged (this contact must be associated with the account specified with setAccountId, and setAccountId must be specified). This value is required only when updating an existing contact.This method is for internal use only. Sets the lead status value for a converted lead. This field is required. Specifies whether to create an opportunity during lead conversion. The default value is false: opportunities are created by default. Set this flag to true only if you do not want to create an opportunity from the lead. Sets the ID of the lead to convert. This field is required. Sets the ID of the opportunity into which the lead is merged. This value is required only when updating an existing opportunity.Sets the name of the opportunity to create. If no name is specified, this value defaults to the company name of the lead.This method is for internal use only.Specifies whether to overwrite the LeadSource field on the target contact object with the contents of the LeadSource field in the source lead object. The default value is false, to not overwrite the field. If you specify this as true, you must also specify setContactId for the target contact.Specifies the ID of the person to own any newly created account, contact, and opportunity. If the application does not specify this value, the owner of the new object will be the owner of the lead.Sets the ID of the existing person account into which to convert the lead. This value is required only when updating an existing person account.Specifies whether to send a notification email to the owner specified by setOwnerId. The default value is false, that is, to not send email.
• Apex DML Operations: You can perform DML operations using the Apex DML statements or the methods of the Database class. For lead conversion, use the convertLead method of the Database class. There is no DML counterpart for it.
• EmailTemplateSelector Interface: The Support.EmailTemplateSelector interface enables providing default email templates in Case Feed. With default email templates, specified email templates are preloaded for cases based on criteria such as case origin or subject. Returns the ID of the email template to preload for the case currently being viewed in the case feed using the specified case ID.
• CustomOneTimePasswordDeliveryResult Enum: Indicates the status of an attempt to send a one-time password (OTP) to an external user via a custom messaging provider.
• IntegratingAppType Enum: Specifies whether you’re integrating your app as a connected app or as an external client app in methods used in your customized Apex token exchange handler, which extends the Auth.Oauth2TokenExchangeHandler class.
• InvocationContext Enum: The context in which the connected app is invoked, such as the protocol flow used and the token type issued, if any. Developers can use the context information to write code that is unique to the type of invocation.
• LightningLoginEligibility Enum: Contains a Lightning Login eligibility value used by the Auth.SessionManagement.getLightningLoginEligibility method.
• LoginDiscoveryMethod Enum: Contains methods used to verify the user’s identity when the My Domain login process uses Login Discovery.
• OAuth2TokenExchangeType Enum: Used during the OAuth 2.0 token exchange flow to specify the type of token that’s being exchanged for a Salesforce token.
• OauthTokenType Enum: Specifies the type of Salesforce-issued OAuth 2.0 token being revoked in the OauthToken.revokeToken method.
• SessionLevel Enum: An Auth.SessionLevel enum value is used by the SessionManagement.setSessionLevel method.
• VerificationAction Enum: Indicates the method that you use to send a one-time password (OTP) to a user during the headless passwordless login flow.
• VerificationMethod Enum: Contains the different ways users can identify themselves when logging in. You can use it to implement mobile-centric passwordless login pages and to self-register (and deregister) verification methods.
• VerificationPolicy Enum: The Auth.VerificationPolicy enum contains an identity verification policy value used by the SessionManagement.generateVerificationUrl method.
• ResolutionStates Enum: Potential resolution states for a resolution strategy.
• AuthenticationCapability Enum: Specifies the types of authentication that can be used to access the external system.
• AuthenticationProtocol Enum: Determines what type of credentials are used to authenticate to the external system.
• Capability Enum: Declares which functional operations the external system supports. Also specifies required endpoint settings for the external data source definition.
• DataType Enum: Specifies the data types that are supported by the Apex Connector Framework.
• FilterType Enum: Referenced by the type property on a DataSource.Filter.
• IdentityType Enum: Determines which set of credentials is used to authenticate to the external system.
• OrderDirection Enum: Specifies the direction for sorting rows based on column values.
• QueryAggregation Enum: Specifies how to aggregate a column in a query.
• XmlNodeType Enum: Specifies the node type in an XML document.
• ActionError Enum: Specifies the error that occurred during the execution of an actionable notification.
• AttachmentRetrievalOption Enum: Provides options for including attachment metadata only, attachment metadata and content, or excluding attachments.
• DeployProblemType Enum: Describes the problem type for an unsuccessful component deploy.
• DeployStatus Enum: The result status of a deployment.
• FeedItemTypeEnum Enum: The type of feed item in a feed-based page layout.
• FeedLayoutComponentType Enum: Indicates the type of feed layout component.
• FeedLayoutFilterPosition Enum: Describes where the feed filters list is included in the layout.
• FeedLayoutFilterType Enum: The type of feed layout filter.
• LayoutHeader Enum: Represents tagging types used for Metadata.Layout.headers
• LayoutSectionStyle Enum: Describes the possible styles for a layout section.
• MetadataType Enum: Represents the custom metadata components available in Apex.
• PlatformActionListContextEnum Enum: Describes the different contexts of action lists.
• PlatformActionTypeEnum Enum: The type of action for a PlatformActionListItem.
• ReportChartComponentSize Enum: Describes the size of the displayed report chart component.
• SortOrder Enum: Describes the sort order of a related list.
• StatusCode Enum: Describes the status code for an unsuccessful component deploy.
• SummaryLayoutStyleEnum Enum: Describes the highlights panel style for a SummaryLayout.
• UiBehavior Enum: Describes the behavior for a layout item on a layout page.
• PluginDescribeResult.ParameterType Enum: Specifies the data types of input and output parameters of the Process.PluginDescribeResult class.
• AuthRequestResultStatus Enum: This enum describes the authentication result status.
• OrderItemCategory Enum: Represents the category of an order item.
• OrderType Enum: Represents the type of an order.
• PaymentCheckoutBehavior Enum: Represents the checkout behavior of a payment.
• PaymentInitiationMode Enum: Represents the mode used to initiate a payment.
• PaymentInitiationPixKeyType Enum: Represents the type of PIX key used for a payment.
• PaymentItemStatus Enum: Represents the status of a payment item in payment requests sent in enhanced Messaging channels.
• PaymentMethodHint Enum: Represents a hint for the payment method to be used.
• PaymentTransactionStatus Enum: Represents the status of a payment transaction.
• PaymentTransactionType Enum: Represents the type of payment transaction.
• ProcessPaymentResultStatus Enum: Represents the status of a payment processing result.
• TimingIntervalUnit Enum: Represents an enumerated type that describes the timing interval.
• TimingType Enum: Represents an enumerated type that describes the type of timing.
• DisplayType Enum: A Schema.DisplayType enum value is returned by the field describe result's getType method.
• FieldDescribeOptions Enum: A Schema.FieldDescribeOptions enum value is a parameter in the SObjectType.getDescribe method.
• SOAPType Enum: A Schema.SOAPType enum value is returned by the field describe result getSoapType method.
• SObjectDescribeOptions Enum: A Schema.SObjectDescribeOptions enum value is a parameter in the SObjectType.getDescribe method.
• ContentDownloadContext Enum: This enum specifies the download context.
• AccessType Enum: Specifies the access check type for the fields of an sObject.
• CallbackStatus Enum: Specifies the status of asynchronous requests to an external system.
• DomainType Enum: Specifies the domain type for a System.Domain.
• JSONToken Enum: Contains all token values used for parsing JSON content.
• LoggingLevel Enum: Specifies the logging level for the System.debug method.
• ParentJobResult Enum: Specifies the success or exception status of the parent Queueable job to which a Transaction Finalizer is attached.
• Quiddity Enum: Specifies a Quiddity value used by the methods in the System.Request class
• TriggerOperation Enum: System.TriggerOperation enum values are associated with trigger events.
• Visibility Enum: Use the Cache.Visibility enumeration in the Cache.Session or Cache.Org methods to indicate whether a cached value is visible only in the value’s namespace or in all namespaces.
• ContextTypeEnum Enum: Describes context data that can be excluded from canvas app context data. You specify which context types to exclude in the excludeContextTypes() method in your CanvasLifecycleHandler implementation.
• AccountHolderType Enum: Specifies the type of the account holder.
• AccountType Enum: Specifies the account type.
• BankType Enum: Specifies the bank type.
• CardCategory Enum: Defines whether the payment method represents a credit card or a debit card.
• CardType Enum: Specifies the credit card issuer.
• NotificationStatus Enum: Shows whether the payments platform successfully received the notification from the gateway.
• PaymentMethodIdType Enum: Specifies the ID of the payment method type.
• RequestType Enum: Defines the type of payment transaction request made to the payment gateway.
• RetryCategory Enum: Specifies the retry category.
• RetryDecision Enum: Specifies the retry decision.
• SalesforceResultCode Enum: Defines the gateway call status values in Salesforce based on the call status values that the payment gateway returned.
• StandardEntryClassCode Enum: Specifies the three-letter code that identifies the type of electronic payment transaction being processed within the Automated Clearing House (ACH) network.
• CalculateTaxType Enum: Shows whether a tax calculation request is for estimated or actual tax.
• RequestType Enum: Shows the type of tax request made to the tax engine.
• ResultCode Enum: Code that represents the results of a tax request made to the tax engine.
• TaxTransactionStatus Enum: Shows whether the tax transaction has been committed or uncommitted.
• TaxTransactionType Enum: Shows whether the tax transaction is for a credit or debit transaction.
• Level Enum: Specifies the compression level for creating a zip file.
• Method Enum: Specifies the compression method for the zip entries.
• FormulaGlobal Enum: Specifies a global variable that references data in your organization in the withGlobalVariables(formulaGlobals) method.
• FormulaReturnType Enum: Specifies the return type for the withReturnType(returnType) method.
• FunctionErrorType Enum: Represents the error type of FunctionInvocationError.
• FunctionInvocationStatus Enum: Represents the status of a Function invocation.
• TokenType Enum: Defines the types of values supported by the TokenUtility methods.
• BucketType Enum: The types of values included in a bucket.
• CsfGroupType Enum: The group level at which the custom summary format aggregate is displayed in a report.
• ReportFilterType Enum: The types of values included in a report filter type.
• FormulaType Enum: The format of the numbers in a custom summary formula.
• StandardFilterType Enum: The StandardFilterType enum describes the type of standard filters in a report. The getType() method returns a Reports.StandardFilterType enum value.
• ColumnDataType Enum: The Reports.ColumnDataType enum describes the type of data in a column. It is returned by the getDataType method.
• ColumnSortOrder Enum: The Reports.ColumnSortOrder enum describes the order that the grouping column uses to sort data.
• DateGranularity Enum: The Reports.DateGranularity enum describes the date interval that is used for grouping.
• EvaluatedConditionOperator Enum: The Reports.EvaluatedConditionOperator enum describes the type of operator used to compare an aggregate to a value. It is returned by the getOperator method.
• ReportFormat Enum: Contains the possible report format types.
• LearningItemProgressStatus Enum: Represents the status of a user’s progress for a learning item in an Enablement program.
• Canvas Exceptions: The Canvas namespace contains exception classes.
• Compression Exceptions: The Compression namespace contains exception classes.
• errors: Represents the property to store errors that occurred as a result of the NLP Operation.
• NlpResponse Properties
• summarizationResult: Represents the property that stores the NLP Summarization result performed for an NLP Operation. NLP operation can be SurveyLongSummarization and SurveyShortSummarization.
• NlpSummarizationResult Class: Provides the summary obtained as result of NLP Operation.
• NlpSummarizationResult Properties
• summary: Represents the field that captures the summary obtained as result of NLP Operation.
• InstallHandler Interface: Enables custom code to run after a managed package installation or upgrade.Specifies the actions to be performed on install/upgrade.
• AuthProviderPlugin Interface: This interface is deprecated. For new development, use the abstract class Auth.AuthProviderPluginClass to create a custom OAuth-based authentication provider plug-in for single sign-on in to Salesforce.Deprecated as of API version 39.0. Use the corresponding method in Auth.AuthProviderPluginClass. Deprecated as of API version 39.0. Use the corresponding method in Auth.AuthProviderPluginClass. Deprecated as of API version 39.0. Use the corresponding method in Auth.AuthProviderPluginClass.Deprecated as of API version 39.0. Use the corresponding method in Auth.AuthProviderPluginClass.
• ConfigurableSelfRegHandler Interface: Gives you more control over how customers or partners self-register for your Experience Cloud site by creating a class that implements Auth.ConfigurableSelfRegHandler. You choose the user information to collect, and how users identify themselves—with their email address, phone number, or another identifier. When verified, you create a customer or partner user and log in the user to your Experience Cloud site.Create a community member from the information that the visitor provided on your community’s self-registration page.This Apex code implements the Auth.ConfigurableSelfRegHandler interface. After the customer or partner fills out the sign-up page and submits it, the handler is invoked to create an Experience Cloud member with the supplied information. If the registration process requires email or phone verification, the verification process finishes before the Auth.ConfigurableSelfRegHandler.createUser is invoked. If verification isn’t required, createUser is invoked when the customer or partner submits the page.
• ConfirmUserRegistrationHandler Interface: Manages single sign-on (SSO) user mappings between Salesforce and a third-party identity provider. Use this interface to confirm user mappings before updating them.Returns the ID of the user to be logged in based on their mapping to a third-party identifier. This method is called before calling the updateUser() method. It's called only if the incoming user has previously logged in and has a third-party account link to a Salesforce user.
• CustomOneTimePasswordDeliveryHandler Interface: To use a custom SMS provider to send one-time passwords (OTPs) for Experience Cloud identity verification, create a class that implements the Auth.CustomOneTimePasswordDeliveryHandler interface.Calls out to an external SMS messaging provider to send a Salesforce one-time password to an external user for identity verification. Returns an Auth.CustomOneTimePasswordDeliveryResult indicating whether the provider sent the message.
• HeadlessSelfRegistrationHandler Interface: Creates customer and partner users during the Headless Registration Flow.The following are methods for HeadlessSelfRegistrationHandler.Returns a User object using information submitted by your off-platform app to Headless Registration API. The User object can be a new user that hasn’t been inserted in your org’s database, or it can represent an existing user record. If it’s a new User object, Salesforce inserts the user record for you.This example class implements the Auth.HeadlessSelfRegistrationHandler interface to create a user. It finds or creates an account to store the new user and creates a contact to associate with the account. It then creates the user based on information that your client sends to Headless Registration API.
• HeadlessUserDiscoveryHandler Interface: Use this interface to create a headless user discovery handler that you implement during headless login, passwordless login, and forgot password flows. Finds a user's Salesforce account based on user information, such as their email address, phone number, or other data, that's passed to a Salesforce endpoint during headless login, passwordless login, and forgot password flows.
• LoginDiscoveryHandler Interface: Salesforce gives you the ability to log in users based on other verification methods than username and password. For example, it can prompt users to log in with their email, phone number, or another identifier like a Federation ID or device identifier. Login Discovery is available to these licenses: Customer Community, Customer Community Plus, External Identity, Partner Community, and Partner Community Plus.Log in the customer or partner given the specified identifier, such as email or phone number. If successful, redirect the user to the Experience Cloud site page specified by the start URL.
• MyDomainLoginDiscoveryHandler Interface: The handler used to implement the My Domain Login Discovery page, which is an interview-based (two-step) login process. First the user is prompted for a unique identifier such as an email address or phone number. Then the handler determines (discovers) how to authenticate the user. Either the user enters a password or is directed to an identity provider’s login page.Log in a Salesforce user given the specified identifier, such as email or phone number. If successful, redirect the user to the page specified by the start URL.
• SamlJitHandler Interface: Use this interface to control and customize Just-in-Time user provisioning logic during SAML single sign-on.Returns a User object using the specified Federation ID. The User object corresponds to the user information. This object can be a new user that hasn’t been inserted in the database or an existing user record in the database.Updates the specified user’s information. This method is called if the user has logged in before with SAML single sign-on and then logs in again, or if your application is using the Existing User Linking URL.
• ResolutionStrategy Interface: Interface for a resolution strategy. Returns a resolution object, which indicates how the resolution strategy was resolved. The resolution indicates whether default logic, extension provider logic, or no logic is executed.
• NotificationActionHandler Interface: Implement this interface to execute an action on a custom notification.Executes the actionable notification.This is an example implementation of the Messaging.NotificationActionHandler interface.
• DeployCallback Interface: An interface for metadata deployment callback classes.Method that is called when the asynchronous deployment of custom metadata completes.
• Plugin Interface: Allows you to pass data between your organization and a specified flow.Returns a Process.PluginDescribeResult object that describes this method call. Primary method that the system invokes when the class that implements the interface is instantiated.
• QuickActionDefaultsHandler Interface: The QuickAction.QuickActionDefaultsHandler interface lets you specify the default values for the standard Email and Send Email actions in the case feed. You can use this interface to specify the From address, CC address, BCC address, subject, and email body for the Email action in the case feed. You can use the interface to pre-populate these fields based on the context where the action is displayed, such as the case origin (for example, country) and subject. Implement this method to provide default values for the standard Email action in the case feed. These examples are implementations of the QuickAction.QuickActionDefaultsHandler interface.
• AuthRequestHandler Interface: Use this interface to handle authorization request responses.Handles authorization request response.
• ProcessFormHandler Interface: Apex interface that processes the responses to forms submitted in a messaging session.Processes the form request and returns the ID of the record created during form processing.
• ProcessPaymentHandler Interface: Interface used to process payment requests.Processes a payment request.
• ProcessPaymentStatusHandler Interface: Interface used to process payment status updates.Processes a payment status update.
• ContentDownloadHandlerFactory Interface: Use this interface to provide a class factory that Salesforce can call to create instances of your custom ContentDownloadHandler. Returns a ContentDownloadHandler for a given list of content IDs and a download context.
• Callable Interface: Enables developers to use a common interface to build loosely coupled integrations between Apex classes or triggers, even for code in separate packages. Agreeing upon a common interface enables developers from different companies or different departments to build upon one another’s solutions. Implement this interface to enable the broader community, which might have different solutions than the ones you had in mind, to extend your code’s functionality.Provides functionality that other classes or packages can utilize and build upon.
• Comparator Interface: Implement different sort orders with the Comparator interface’s compare() method, and pass the Comparator as a parameter to List.sort(). Your implementation must explicitly handle null inputs in the compare() method to avoid a null pointer exception.Compares the two arguments and returns a negative integer, zero, or a positive integer depending on whether the first argument is less than, equal to, or greater than the second argument.Use the Comparator interface to impose different kinds of sorting.
• Finalizer Interface: Use this interface to attach actions that are executed at the end of asynchronous Queueable job executions. A specific use case is to design recovery actions when a Queueable job fails.The execute method is called on the provided Finalizer instance for every enqueued job that has an attached finalizer. Within the execute method, you can define the actions to be taken at the end of the Queueable job.
• FinalizerContext Interface: Represents the parameter type of the execute method in a class that implements the Finalizer interface. This interface is implemented internally by Apex. The System.FinalizerContext interface contains four methods: getAsyncApexJobId, getRequestId, getResult, and getException. An instance of System.FinalizerContext is injected by the Apex runtime engine as an argument to the Finalizer.execute method. Returns the ID of the Queueable job for which this finalizer is defined.Returns the exception with which the Queueable job failed when getResult is UNHANDLED_EXCEPTION, null otherwise.Returns the request ID that can be correlated with Event Monitoring logs. To correlate the request with the AsyncApexJob table, use the getAsyncApexJobId method instead. The Queueable job and the Finalizer execution share the same request ID.Returns the System.ParentJobResult enum, which represents the result of the parent asynchronous Apex Queueable job to which the finalizer is attached. The enum takes these values: SUCCESS, UNHANDLED_EXCEPTION.
• SandboxPostCopy Interface: To make your sandbox environment business ready, automate data manipulation or business logic tasks. Extend this interface and add methods to perform post-copy tasks, then specify the class during sandbox creation.Executes actions in a new sandbox to prepare it for use. For example, add logic to this method to create users, run sanitizing code on records, and perform other setup tasks.These examples show a simple implementation of the SandboxPostCopy interface and a test for that implementation. To test your SandboxPostCopy implementation, use the System.Test.testSandboxPostCopyScript() method.
• StubProvider Interface: StubProvider is a callback interface that you can use as part of the Apex stub API to implement a mocking framework. Use this interface with the Test.createStub() method to create stubbed Apex objects for testing.Use this method to define the behavior of each method of a stubbed class.
• OpportunityTerritory2AssignmentFilter Global Interface: Apex interface that allows an implementing class to assign a single territory to an opportunity.Returns the mapping of opportunities to territory IDs. When Salesforce invokes this method, it supplies the list of opportunity IDs, except for opportunities that have been excluded from territory assignment (IsExcludedFromTerritory2Filter=false).
• AsyncCondition Interface: Allows an implementing class to make asynchronous Apex calls. This interface is used only for transaction security Apex policies created in Real-Time Event Monitoring.
• EventCondition Interface: Allows an implementing class to specify whether to take action when certain events occur based on a transaction security policy. This interface is only used for Apex policies created in Real-Time Event Monitoring.The EventCondition interface has one method, evaluate(event).Evaluates an event against a transaction security policy created in Real-Time Event Monitoring. If the event triggers the policy, the method returns true.Use EventCondition to create a custom condition for Shield Platform Encryption.
• PolicyCondition Interface: Apex interface that allows an implementing class to specify actions to take when certain events occur based on a transaction security policy.Evaluates an event against a transaction security policy. If the event triggers the policy, true is returned.
• CacheBuilder Interface: An interface for safely retrieving and removing values from a session or org cache. Use the interface to generate a value that you want to store in the cache. The interface checks for cache misses, which means you no longer need to check for null cache values yourself.Contains the logic that builds a cached value. You don’t call this method directly. Instead, it’s called indirectly when you reference the class that implements the CacheBuilder interface.
• ApplicationContext Interface: Use this interface to retrieve application context information, such as the application version or URL.
• CanvasLifecycleHandler Interface: Implement this interface to control context information and add custom behavior during the application render phase.
• EnvironmentContext Interface: Use this interface to retrieve environment context information, such as the app display location or the configuration parameters.
• RenderContext Interface: A wrapper interface that is used to retrieve application and environment context information.
• AccountCreator Interface: Creates Account records that will be associated with Chatter Answers users.Accepts basic user information and creates an Account record. The implementation of this method returns the account ID.
• GatewayResponse Interface: Generic payment gateway response interface. This class extends the CaptureResponse, AbstractTransactionResponse, and AbstractResponse classes and inherits all their properties. It has no unique methods or parameters.
• PaymentGatewayAdapter Interface: PaymentGatewayAdapters can implement this interface in order to process requests.The entry point for processing payment requests. Returns the response from the payment gateway.
• PaymentGatewayAsyncAdapter Interface: Implement the interface to allow customers to process payments asynchronously. Entry point for processing notifications from payment gateways.
• TaxEngineAdapter Interface: Retrieves information from the tax engine and evaluates the information to define tax details.Learn more about the available methods with the TaxEngineAdapter class.The processRequest method takes an instance of TaxEngineContext class and returns a response with the calculated tax details through the TaxDetailsResponse class or an error response through the ErrorResponse class.Refer to the example implementation of the TaxEngineAdapter interface to accept information from a tax engine and evaluate the information to define tax details.You can extend and customize the tax interface for quotes and orders by using custom metadata types and tax mappings. These customizations help you with unique business requirements such as the inclusion of specific data for accurate calculations and audits.
• Batchable Interface: The class that implements this interface can be executed as a batch Apex job.Gets invoked when the batch job executes and operates on one batch of records. Contains or calls the main execution logic for the batch job.Gets invoked when the batch job finishes. Place any clean up code in this method.Gets invoked when the batch job starts. Returns the record set as an iterable that will be batched for execution.Gets invoked when the batch job starts. Returns the record set as a QueryLocator object that will be batched for execution.
• BatchableContext Interface: Represents the parameter type of a batch job method and contains the batch job ID. This interface is implemented internally by Apex.Returns the ID of the current batch job chunk that is being processed.Returns the batch job ID.
• EventPublishFailureCallback Interface: Implement this interface to track platform event messages that failed to publish. The onFailure() method in this interface is called when the final result of the asynchronous publish operation becomes available. The system invokes this method when the final result of EventBus.publish is available and the publishing of the platform event message failed.
• EventPublishSuccessCallback Interface: Implement this interface to track platform event messages that were published successfully. The onSuccess() method in this interface is called when the final result of the asynchronous publish operation becomes available.The system invokes this method when the final result of EventBus.publish is available and the publishing of the platform event message succeeded.
• FailureResult Interface: Contains the result of an Apex publish callback when the event publishing failed. This interface is used as a parameter in the onFailure method of the EventPublishFailureCallback interface.Returns a list of EventUuid field values of each platform event that is included in EventBus.EventPublishFailureCallback.
• SuccessResult Interface: Contains the result of an Apex publish callback when the event publishing succeeded. This interface is used as a parameter in the onSuccess method of the EventPublishSuccessCallback interface.Returns a list of EventUuid field values of each platform event that is included in the EventBus.EventPublishSuccessCallback.
• FunctionCallback Interface: Represents the callback Salesforce calls when an asynchronous, queued Function invocation has completed.Called when an asynchronous Function invocation has completed.
• FunctionInvocation Interface: Use FunctionInvocation to get the status and results of a synchronous or asynchronous Function invocation.Returns error information for a Function invocation.Returns the invocation ID of the Function invocation.Returns the response string of the Function invocation.Returns the status of the Function invocation.
• FunctionInvocationError Interface: Use FunctionInvocationError to get detailed error information about a failed Function invocation.Returns the error message from a Function invocation error.Returns the error type for FunctionInvocationError.
• FunctionInvokeMock Interface: Use the FunctionInvokeMock interface to mock Salesforce Functions responses during testing.The mock response implemented in the Functions.FunctionInvokeMock interface. The response is sent by Apex runtime when the Test.setMock() method is called.
• HttpCalloutMock Interface: Enables sending fake responses when testing HTTP callouts.Returns an HTTP response for the given request. The implementation of this method is called by the Apex runtime to send a fake response when an HTTP callout is made after Test.setMock has been called.
• ServiceResourceScheduleHandler Interface: Allows an implementing class to check external calendar events to find already booked time slots for the requested service resources. This interface is part of Salesforce Scheduler.Passes the required information to get unavailable time slots from an external system. The implementation of this method returns the lxscheduler.ServiceResourceSchedule class.
• PreferenceCenterApexHandler Interface: Pass data between your organization and a form in Preference Manager.Retrieve the record IDs and initial values from a preference form before it is edited and submitted.Updates the changed values of fields when the preference form is submitted.
• NotificationAction Interface: Implement this interface to trigger a custom Apex class when the conditions for a report notification are met.Executes the custom Apex action specified in the context parameter of the context object, NotificationActionContext. The object contains information about the report instance and the conditions that must be met for a notification to be triggered. The method executes whenever the specified conditions are met.
• AsyncCartProcessor Interface: Use this interface to implement asynchronous integrations in B2B Commerce.The startCartProcessAsync method is called asynchronously by the integration framework. Calling this method begins cart processing for Commerce checkout.
• SurveyInvitationLinkShortener Interface: Use this interface to provide a class factory that Salesforce can call to create instances of your custom SurveyInvitationLinkShortener.Returns a shortened URL for a given survey invitation.
• Example Implementation to Associate SurveySubjects with SurveyInvitation and SurveyResponses: If no survey responses are populated, create a custom code to associate SurveySubjects with SurveyInvitation and SurveyResponses.
• MilestoneTriggerTimeCalculator Interface: The Support.MilestoneTriggerTimeCalculator interface calculates the time trigger for a milestone.Calculates the milestone trigger time based on the specified case and milestone type and returns the time in minutes.
• QueueableContext Interface: Represents the parameter type of the execute() method in a class that implements the Queueable interface and contains the job ID. This interface is implemented internally by Apex.Returns the ID of the submitted job that uses the Queueable interface.
• Schedulable Interface: The class that implements this interface can be scheduled to run at different intervals.Executes the scheduled Apex job.
• SchedulableContext Interface: Represents the parameter type of a method in a class that implements the Schedulable interface and contains the scheduled job ID. This interface is implemented internally by Apex.Returns the ID of the CronTrigger scheduled job.
• WebServiceMock Interface: Enables sending fake responses when testing Web service callouts of a class auto-generated from a WSDL.The implementation of this method is called by the Apex runtime to send a fake response when a Web service callout is made after Test.setMock has been called.
• ApexPages Class: Use ApexPages to add and check for messages associated with the current page, as well as to reference the current page.Add a message to the current page context.Adds a list of messages to the current page context based on a thrown exception.Returns the current page's PageReference.Returns a list of the messages associated with the current context.Returns true if there are messages associated with the current context, false otherwise.Returns true if messages of the specified severity exist, false otherwise.
• Approval Class: Contains methods for processing approval requests and setting approval-process locks and unlocks on records.Returns true if the record with the ID id is locked, or false if it’s not.Returns a map of record IDs and their lock statuses. If the record is locked the status is true. If the record is not locked the status is false.Returns true if the sobject record is locked, or false if it’s not.Returns a map of record IDs to lock statuses. If the record is locked the status is true. If the record is not locked the status is false.Locks an object, and returns the lock results.Locks a set of objects, and returns the lock results, including failures.Locks an object, and returns the lock results.Locks a set of objects, and returns the lock results, including failures.Locks an object, with the option for partial success, and returns the lock result.Locks a set of objects, with the option for partial success. It returns the lock results, including failures.Locks an object, with the option for partial success, and returns the lock result.Locks a set of objects, with the option for partial success. It returns the lock results, including failures.Submits a new approval request and approves or rejects existing approval requests. Submits a new approval request and approves or rejects existing approval requests. Submits a list of new approval requests, and approves or rejects existing approval requests. Submits a list of new approval requests, and approves or rejects existing approval requests. Unlocks an object, and returns the unlock results.Unlocks a set of objects, and returns the unlock results, including failures.Unlocks an object, and returns the unlock results.Unlocks a set of objects, and returns the unlock results, including failures.Unlocks an object, with the option for partial success, and returns the unlock result.Unlocks a set of objects, with the option for partial success. It returns the unlock results, including failures.Unlocks an object, with the option for partial success, and returns the unlock result.Unlocks a set of objects, with the option for partial success. It returns the unlock results, including failures.
• Blob Class: Contains methods for the Blob primitive data type.Returns the number of bytes in the Blob.Creates a binary object out of the given string, encoding it as a PDF file. Casts the Blob into a String.Casts the specified String to a Blob.
• Boolean Class: Contains methods for the Boolean primitive data type.Converts the specified string to a Boolean value and returns true if the specified string value is true. Otherwise, returns false.Converts the specified object to a Boolean value. Use this method to convert a history tracking field value or an object that represents a Boolean value.
• Custom Metadata Type Methods: Custom metadata types are customizable, deployable, packageable, and upgradeable application metadata. All custom metadata is exposed in the application cache, which allows access without repeated queries to the database. The metadata is then available for formula fields, validation rules, flows, Apex, and SOAP API. All methods are static.Returns a map containing custom metadata records for the specific custom metadata type. The map keys are the record DeveloperNames and the map values are the record sObjects.Returns a single custom metadata type record sObject for a specified record ID. Returns null if no record matches the parameter.Returns a single custom metadata type record sObject for a specified developerName field of the custom metadata type object. Returns null if no record matches the parameter.Returns a single custom metadata type record sObject for a qualified API name. Returns null if no record matches the parameter.
• Custom Settings Methods: Custom settings are similar to custom objects and enable application developers to create custom sets of data, as well as create and associate custom data for an organization, profile, or specific user. All custom settings data is exposed in the application cache, which enables efficient access without the cost of repeated queries to the database. This data is then available for formula fields, validation rules, flows, Apex, and the SOAP API.Returns a map of the data sets defined for the custom setting.Returns the custom setting data set record for the specified data set name. This method returns the exact same object as getValues(dataSetName).Returns the custom setting data set record for the specified data set name. This method returns the exact same object as getInstance(dataSetName).Returns a custom setting data set record for the current user. The fields returned in the custom setting record are merged based on the lowest level fields that are defined in the hierarchy.Returns the custom setting data set record for the specified user ID. The lowest level custom setting record and fields are returned. Use this when you want to explicitly retrieve data for the custom setting at the user level.Returns the custom setting data set record for the specified profile ID. The lowest level custom setting record and fields are returned. Use this when you want to explicitly retrieve data for the custom setting at the profile level.Returns the custom setting data set record for the organization.Returns the custom setting data set record for the specified user ID.Returns the custom setting data set for the specified profile ID.
• Database Class: Contains methods for creating and manipulating data.Converts a lead into an account and contact, and, optionally, an opportunity.Converts a list of LeadConvert objects into accounts and contacts, and, optionally, opportunities. Converts a lead into an account and contact, as well as (optionally) an opportunity.Converts a list of LeadConvert objects into accounts and contacts, as well as (optionally) opportunities. Converts a lead into an account and contact, as well as (optionally) an opportunity.Converts a list of LeadConvert objects into accounts and contacts, as well as (optionally) opportunities. Converts a lead into an account and contact, as well as (optionally) an opportunity.Converts a list of LeadConvert objects into accounts and contacts, as well as (optionally) opportunities. Converts a lead into an account and contact, as well as (optionally) an opportunity.Converts a list of LeadConvert objects into accounts and contacts, as well as (optionally) opportunities. Returns the number of records that a dynamic SOQL query would return when executed.Returns the number of records that a dynamic SOQL query would return when executed.Returns the number of records that a dynamic SOQL query would return when executed. Bind variables in the query are resolved from the bindMap Map parameter directly with the key, rather than from Apex code variables.Deletes an existing sObject record, such as an individual account or contact, from your organization's data.Deletes a list of existing sObject records, such as individual accounts or contacts, from your organization’s data.Deletes existing sObject records, such as individual accounts or contacts, from your organization’s data.Deletes a list of existing sObject records, such as individual accounts or contacts, from your organization’s data.Deletes an existing sObject record, such as an individual account or contact, from your organization's data.Deletes a list of existing sObject records, such as individual accounts or contacts, from your organization’s data.Deletes existing sObject records, such as individual accounts or contacts, from your organization’s data.Deletes a list of existing sObject records, such as individual accounts or contacts, from your organization’s data.Initiates requests to delete the external data that corresponds to the specified external object records. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source. Allows referencing a callback class whose processDelete method is called for each record after deletion.Initiates a request to delete the external data that corresponds to the specified external object record. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source. Allows referencing a callback class whose processDelete method is called after deletion.Initiates requests to delete the external data that corresponds to the specified external object records. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources.Initiates a request to delete the external data that corresponds to the specified external object record. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source.Initiates requests to delete the external data that corresponds to the specified external object records. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source. Allows referencing a callback class whose processDelete method is called for each record after deletion.Initiates a request to delete the external data that corresponds to the specified external object record. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source. Allows referencing a callback class whose processDelete method is called after deletion.Initiates requests to delete the external data that corresponds to the specified external object records. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources.Initiates a request to delete the external data that corresponds to the specified external object record. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source.Initiates requests to delete the external data that corresponds to the specified external object records. The requests are executed synchronously and are sent to the external systems that are defined by the external objects' associated external data sources. If the Apex transaction contains pending changes, the synchronous operations can't be completed and throw exceptions.Initiates a request to delete the external data that corresponds to the specified external object record. The request is executed synchronously and is sent to the external system that's defined by the external object's associated external data source. If the Apex transaction contains pending changes, the synchronous operation can't be completed and throws an exception.Initiates requests to delete the external data that corresponds to the specified external object records. The requests are executed synchronously and are sent to the external systems that are defined by the external objects' associated external data sources. If the Apex transaction contains pending changes, the synchronous operations can't be completed and throw exceptions.Initiates a request to delete the external data that corresponds to the specified external object record. The request is executed synchronously and is sent to the external system that's defined by the external object's associated external data source. If the Apex transaction contains pending changes, the synchronous operation can't be completed and throws an exception.Permanently deletes the specified records from the Recycle Bin.Permanently deletes the specified sObject from the Recycle Bin. Permanently deletes the specified sObjects from the Recycle Bin.Submits a batch Apex job for execution corresponding to the specified class.Submits a batch Apex job for execution using the specified class and scope.Retrieves the status of an asynchronous delete operation that’s identified by a Database.DeleteResult object.Retrieves the result of an asynchronous delete operation based on the result’s unique identifier.Returns the asyncLocator associated with the result of a specified asynchronous insert, update, or delete operation.Returns the status of an asynchronous insert or update operation that’s identified by a Database.SaveResult object.Returns the status of an asynchronous insert or update operation based on the unique identifier associated with each modification.Creates a cursor when the specified SOQL query is executed.Creates a cursor when the specified SOQL query is executed.Creates a cursor when the specified SOQL query is executed.Returns the list of individual records that have been deleted for an sObject type within the specified start and end dates and times and that are still in the Recycle Bin.Creates a pagination cursor when the specified SOQL query is executed.Creates a pagination cursor when the specified SOQL query is executed.Creates a pagination cursor when the specified SOQL query is executed.Creates a QueryLocator object used in batch Apex or Visualforce.Creates a QueryLocator object used in batch Apex or Visualforce.Creates a QueryLocator object used in batch Apex or Visualforce.Creates a QueryLocator object used in batch Apex or Visualforce.Creates a QueryLocator object used in batch Apex or Visualforce. Bind variables in the query are resolved from the bindMap Map parameter directly with the key, rather than from Apex code variables. Returns the list of individual records that have been updated for an sObject type within the specified start and end dates and times.Adds an sObject, such as an individual account or contact, to your organization's data.Adds one or more sObjects, such as individual accounts or contacts, to your organization’s data.Adds an sObject, such as an individual account or contact, to your organization's data.Adds one or more sObjects, such as individual accounts or contacts, to your organization's data.Adds an sObject, such as an individual account or contact, to your organization's data.Adds one or more sObjects, such as individual accounts or contacts, to your organization’s data.Adds an sObject, such as an individual account or contact, to your organization's data.Adds one or more sObjects, such as individual accounts or contacts, to your organization's data.Initiates requests to add external object data to the relevant external systems. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources. Allows referencing a callback class whose processSave method is called for each record after the remote operations are completed.Initiates a request to add external object data to the relevant external system. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source. Allows referencing a callback class whose processSave method is called after the remote operation is completed.Initiates requests to add external object data to the relevant external systems. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources.Initiates a request to add external object data to the relevant external system. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source.Initiates requests to add external object data to the relevant external systems. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources. Allows referencing a callback class whose processSave method is called for each record after the remote operations are completed.Initiates a request to add external object data to the relevant external system. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source. Allows referencing a callback class whose processSave method is called after the remote operation is completed.Initiates requests to add external object data to the relevant external systems. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources.Initiates a request to add external object data to the relevant external system. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source.Initiates requests to add external object data to the relevant external systems. The requests are executed synchronously and are sent to the external systems that are defined by the external objects' associated external data sources. If the Apex transaction contains pending changes, the synchronous operations can't be completed and throw exceptions.Initiates a request to add external object data to the relevant external system. The request is executed synchronously and is sent to the external system that's defined by the external object's associated external data source. If the Apex transaction contains pending changes, the synchronous operation can't be completed and throws an exception.Initiates requests to add external object data to the relevant external systems. The requests are executed synchronously and are sent to the external systems that are defined by the external objects' associated external data sources. If the Apex transaction contains pending changes, the synchronous operations can't be completed and throw exceptions.Initiates a request to add external object data to the relevant external system. The request is executed synchronously and is sent to the external system that's defined by the external object's associated external data source. If the Apex transaction contains pending changes, the synchronous operation can't be completed and throws an exception.Merges the duplicate record into the mergeToRecord sObject record of the same type, deleting the duplicate, and reparenting any related records. Merges only accounts, contacts, or leads.Merges the duplicate sObject record into the mergeToRecord sObject record of the same type, deleting the duplicate, and reparenting any related records.Merges up to two records of the same sObject type into the mergeToRecord sObject record, deleting the others, and reparenting any related records.Merges up to two records of the same object type into the mergeToRecord sObject record, deleting the others, and reparenting any related records.Merges the duplicate record into the mergeToRecord sObject record of the same type, optionally returning any errors, deleting the duplicate, and reparenting any related records. Merges only accounts, contacts, or leads.Merges the duplicate sObject record into the mergeToRecord sObject of the same type, optionally returning any errors, deleting the duplicate, and reparenting any related records.Merges up to two records of the same sObject type into the mergeToRecord sObject record, optionally returning any errors, deleting the duplicates, and reparenting any related records.Merges up to two records of the same object type into the mergeToRecord sObject record, optionally returning any errors, deleting the duplicates, and reparenting any related records.Merges the duplicate record into the mergeToRecord sObject record of the same type, deleting the duplicate, and reparenting any related records. Merges only accounts, contacts, or leads.Merges the specified duplicate sObject record into the mergeToRecord sObject of the same type, deleting the duplicate, and reparenting any related records.Merges up to two records of the same sObject type into the mergeToRecord sObject record, deleting the others, and reparenting any related records.Merges up to two records of the same object type into the mergeToRecord sObject record, deleting the others, and reparenting any related records.Merges the duplicate record into the mergeToRecord sObject record of the same type, optionally returning any errors, deleting the duplicate, and reparenting any related records. Merges only accounts, contacts, or leads.Merges the duplicate sObject record into the mergeToRecord sObject record of the same type, optionally returning any errors, deleting the duplicate, and reparenting any related records.Merges up to two records of the same sObject type into the mergeToRecord sObject record, optionally returning any errors, deleting the duplicates, and reparenting any related records.Merges up to two records of the same object type into the mergeToRecord sObject record, optionally returning any errors, deleting the duplicates, and reparenting any related records.Creates a dynamic SOQL query at runtime.Creates a dynamic SOQL query at runtime.Creates a dynamic SOQL query at runtime. Bind variables in the query are resolved from the bindMap Map parameter directly with the key, rather than from Apex code variables.Releases a given savepoint. All savepoints that are subsequent to the given one are also released.Restores the database to the state specified by the savepoint variable. Any emails submitted since the last savepoint are also rolled back and not sent. Returns a savepoint variable that can be stored as a local variable, then used with the rollback method to restore the database to that point.Restores an existing sObject record, such as an individual account or contact, from your organization's Recycle Bin.Restores one or more existing sObject records, such as individual accounts or contacts, from your organization’s Recycle Bin.Restores an existing sObject record, such as an individual account or contact, from your organization's Recycle Bin. Restores one or more existing sObject records, such as individual accounts or contacts, from your organization’s Recycle Bin.Restores an existing sObject record, such as an individual account or contact, from your organization's Recycle Bin.Restores one or more existing sObject records, such as individual accounts or contacts, from your organization’s Recycle Bin.Restores an existing sObject record, such as an individual account or contact, from your organization's Recycle Bin. Restores one or more existing sObject records, such as individual accounts or contacts, from your organization’s Recycle Bin.Modifies an existing sObject record, such as an individual account or contact, in your organization's data.Modifies one or more existing sObject records, such as individual accounts or contacts, in your organization’s data.Modifies an existing sObject record, such as an individual account or contact, in your organization's data.Modifies one or more existing sObject records, such as individual accounts or contacts, in your organization’s data.Modifies an existing sObject record, such as an individual account or contact, in your organization's data.Modifies one or more existing sObject records, such as individual accounts or contacts, in your organization’s data.Modifies an existing sObject record, such as an individual account or contact, in your organization's data.Modifies one or more existing sObject records, such as individual accounts or contacts, in your organization’s data.Creates a new sObject record or updates an existing sObject record within a single statement, using a specified field to determine the presence of existing objects, or the ID field if no field is specified.Creates new sObject records or updates existing sObject records within a single statement, using a specified field to determine the presence of existing objects, or the ID field if no field is specified.Creates a new sObject record or updates an existing sObject record within a single statement, using a specified field to determine the presence of existing objects, or the ID field if no field is specified.Creates new sObject records or updates existing sObject records within a single statement, using a specified field to determine the presence of existing objects, or the ID field if no field is specified.Initiates requests to update external object data on the relevant external systems. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources. Allows referencing a callback class whose processSave method is called for each record after the remote operations are completed.Initiates a request to update external object data on the relevant external system. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source. Allows referencing a callback class whose processSave method is called after the remote operation is completed.Initiates requests to update external object data on the relevant external systems. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources.Initiates a request to update external object data on the relevant external system. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source.Initiates requests to update external object data on the relevant external systems. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources. Allows referencing a callback class whose processSave method is called for each record after the remote operations are completed.Initiates a request to update external object data on the relevant external system. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source. Allows referencing a callback class whose processSave method is called after the remote operation is completed.Initiates requests to update external object data on the relevant external systems. The requests are executed asynchronously, as background operations, and are sent to the external systems that are defined by the external objects' associated external data sources.Initiates a request to update external object data on the relevant external system. The request is executed asynchronously, as a background operation, and is sent to the external system that's defined by the external object's associated external data source.Initiates requests to update external object data on the relevant external systems. The requests are executed synchronously and are sent to the external systems that are defined by the external objects' associated external data sources. If the Apex transaction contains pending changes, the synchronous operations can't be completed and throw exceptions.Initiates a request to update external object data on the relevant external system. The request is executed synchronously and is sent to the external system that's defined by the external object's associated external data source. If the Apex transaction contains pending changes, the synchronous operation can't be completed and throws an exception.Initiates requests to update external object data on the relevant external systems. The requests are executed synchronously and are sent to the external systems that are defined by the external objects' associated external data sources. If the Apex transaction contains pending changes, the synchronous operations can't be completed and throw exceptions.Initiates a request to update external object data on the relevant external system. The request is executed synchronously and is sent to the external system that's defined by the external object's associated external data source. If the Apex transaction contains pending changes, the synchronous operation can't be completed and throws an exception.
• EmptyRecycleBinResult Class: The result of the emptyRecycleBin DML operation returned by the Database.emptyRecycleBin method.If an error occurred during the delete for this record or sObject, returns a list of one or more Database.Error objects. If no errors occurred, the returned list is empty.Returns the ID of the record or sObject you attempted to delete.Returns true if the record or sObject was successfully removed from the Recycle Bin; otherwise false.
• QueryLocator Class: Represents the record set returned by Database.getQueryLocator and used with Batch Apex.Returns the query used to instantiate the Database.QueryLocator object. This is useful when testing the start method.Returns a new instance of a query locator iterator.
• DeleteResult Class: Represents the result of a delete DML operation returned by the Database.delete method.If an error occurred, returns an array of one or more database error objects providing the error code and description. If no error occurred, returns an empty set.Returns the ID of the sObject you were trying to delete.A Boolean value that is set to true if the DML operation was successful for this object, false otherwise.
• DMLOptions Class: Enables you to set options related to DML operations.Specifies the truncation behavior of large strings. Specifies the assignment rule to be used when creating a case or lead.Specifies additional information regarding the automatic email that gets sent when an events occurs.Specifies the language of any labels that are returned by Apex.Specifies whether the operation allows for partial success.
• Error Class: Represents information about an error that occurred during a DML operation when using a Database method.Returns an array of one or more field names. Identifies which fields in the object, if any, affected the error condition.Returns the error message text.Returns a code that characterizes the error.
• SaveResult Class: The result of an insert or update DML operation returned by a Database method.If an error occurred, returns an array of one or more database error objects providing the error code and description. If no error occurred, returns an empty set.Returns the ID of the sObject you were trying to insert or update.Returns a Boolean that is set to true if the DML operation was successful for this object, false otherwise.
• UndeleteResult Class: The result of an undelete DML operation returned by the Database.undelete method.If an error occurred, returns an array of one or more database error objects providing the error code and description. If no error occurred, returns null.Returns the ID of the sObject you were trying to undelete.Returns a Boolean value that is set to true if the DML operation was successful for this object, false otherwise.
• UpsertResult Class: The result of an upsert DML operation returned by the Database.upsert method.If an error occurred, returns an array of one or more database error objects providing the error code and description. If no error occurred, returns an empty set.Returns the ID of the sObject you were trying to update or insert.A Boolean value that is set to true if the record was created, false if the record was updated.Returns a Boolean value that is set to true if the DML operation was successful for this object, false otherwise.
• Date Class: Contains methods for the Date primitive data type.Adds the specified number of additional days to a Date.Adds the specified number of additional months to a DateAdds the specified number of additional years to a DateReturns the day-of-month component of a Date.Returns the day-of-year component of a Date.Returns the number of days between the Date that called the method and the specified date.Returns the number of days in the month for the specified year and month (1=Jan).Returns the Date as a string using the locale of the context userReturns true if the specified year is a leap year.Returns true if the Date that called the method is the same as the specified date.Returns the month component of a Date (1=Jan).Returns the number of months between the Date that called the method and the specified date, ignoring the difference in days.Constructs a Date from Integer representations of the year, month (1=Jan), and day.Constructs a Date from a String. The format of the String depends on the local date format.Returns the current date in the current user's time zone.Returns the first of the month for the Date that called the method.Returns the start of the week for the Date that called the method, depending on the context user's locale.Returns a Date that contains the value of the specified String.Converts the specified object to a Date. Use this method to convert a history tracking field value or an object that represents a Date value.Returns the year component of a Date
• Datetime Class: Contains methods for the Datetime primitive data type.Adds the specified number of days to a Datetime.Adds the specified number of hours to a Datetime.Adds the specified number of minutes to a Datetime.Adds the specified number of months to a Datetime.Adds the specified number of seconds to a Datetime.Adds the specified number of years to a Datetime.Returns the Date component of a Datetime in the local time zone of the context user. Return the Date component of a Datetime in the GMT time zone.Returns the day-of-month component of a Datetime in the local time zone of the context user.Returns the day-of-month component of a Datetime in the GMT time zone.Returns the day-of-year component of a Datetime in the local time zone of the context user.Returns the day-of-year component of a Datetime in the GMT time zone.Converts the date to the local time zone and returns the converted date as a formatted string using the locale of the context user. If the time zone cannot be determined, GMT is used.Converts the date to the local time zone and returns the converted date as a string using the supplied Java simple date format. If the time zone cannot be determined, GMT is used.Converts the date to the specified time zone and returns the converted date as a string using the supplied Java simple date format. If the supplied time zone is not in the correct format, GMT is used.Returns a Datetime as a string using the supplied Java simple date format and the GMT time zone.Converts the date to the local time zone and returns the converted date in long date format.Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this DateTime object.Returns the hour component of a Datetime in the local time zone of the context user.Returns the hour component of a Datetime in the GMT time zone.Returns true if the Datetime that called the method is the same as the specified Datetime in the local time zone of the context user.Return the millisecond component of a Datetime in the local time zone of the context user.Return the millisecond component of a Datetime in the GMT time zone.Returns the minute component of a Datetime in the local time zone of the context user.Returns the minute component of a Datetime in the GMT time zone.Returns the month component of a Datetime in the local time zone of the context user (1=Jan).Returns the month component of a Datetime in the GMT time zone (1=Jan).Constructs a Datetime and initializes it to represent the specified number of milliseconds since January 1, 1970, 00:00:00 GMT.Constructs a DateTime from the specified date and time in the local time zone.Constructs a Datetime from Integer representations of the specified year, month (1=Jan), and day at midnight in the local time zone.Constructs a Datetime from Integer representations of the specified year, month (1=Jan), day, hour, minute, and second in the local time zone.Constructs a DateTime from the specified date and time in the GMT time zone. Constructs a Datetime from Integer representations of the specified year, month (1=Jan), and day at midnight in the GMT time zoneConstructs a Datetime from Integer representations of the specified year, month (1=Jan), day, hour, minute, and second in the GMT time zoneReturns the current Datetime based on a GMT calendar. Constructs a Datetime from the given String in the local time zone and in the format of the user locale. Returns the second component of a Datetime in the local time zone of the context user.Returns the second component of a Datetime in the GMT time zone.Returns the time component of a Datetime in the local time zone of the context user.Returns the time component of a Datetime in the GMT time zone.Returns a Datetime that contains the value of the specified string.Converts the specified object to a Datetime. Use this method to convert a history tracking field value or an object that represents a Datetime value.Returns a Datetime that contains the value of the specified String.Returns the year component of a Datetime in the local time zone of the context user.Returns the year component of a Datetime in the GMT time zone.
• Decimal Class: Contains methods for the Decimal primitive data type.Rounding mode specifies the rounding behavior for numerical operations capable of discarding precision.Returns the absolute value of the Decimal.Divides this Decimal by the specified divisor, and sets the scale, that is, the number of decimal places, of the result using the specified scale.Divides this Decimal by the specified divisor, sets the scale, that is, the number of decimal places, of the result using the specified scale, and if necessary, rounds the value using the rounding mode.Returns the Double value of this Decimal.Returns the String value of this Decimal using the locale of the context user. Returns the Integer value of this Decimal.Returns the Long value of this Decimal.Returns the value of this decimal raised to the power of the specified exponent.Returns the total number of digits for the Decimal.Returns the rounded approximation of this Decimal. The number is rounded to zero decimal places using half-even rounding mode, that is, it rounds towards the “nearest neighbor” unless both neighbors are equidistant, in which case, this mode rounds towards the even neighbor.Returns the rounded approximation of this Decimal. The number is rounded to zero decimal places using the rounding mode specified by the rounding mode. Returns the scale of the Decimal, that is, the number of decimal places.Returns the Decimal scaled to the specified number of decimal places, using half-even rounding, if necessary. Half-even rounding mode rounds toward the “nearest neighbor.” If both neighbors are equidistant, the number is rounded toward the even neighbor.Returns the Decimal scaled to the specified number of decimal places, using the specified rounding mode, if necessary.Returns the Decimal with any trailing zeros removed.Returns the String value of this Decimal, without using scientific notation.Returns a Decimal that contains the value of the specified Double.Returns a Decimal that contains the value of the specified Long.Returns a Decimal that contains the value of the specified String. As in Java, the string is interpreted as representing a signed Decimal.
• Double Class: Contains methods for the Double primitive data type.Returns the String value for this Double using the locale of the context userReturns the Integer value of this Double by casting it to an Integer.Returns the Long value of this Double.Returns the closest Long to this Double value.Returns a Double that contains the value of the specified String. As in Java, the String is interpreted as representing a signed decimal.Converts the specified object to a Double value. Use this method to convert a history tracking field value or an object that represents a Double value.
• Enum Methods: An enum is an abstract data type with values that each take on exactly one of a finite set of identifiers that you specify. Apex provides built-in enums, such as LoggingLevel, and you can define your own enum.
• DescribeFieldResult Class: Contains methods for describing sObject fields.For variable-length fields (including binary fields), returns the maximum size of the field, in bytes.Returns the formula specified for this field.Returns the token of the controlling field.Returns the default value for this field.Returns the default formula value that is specified for this formula field.Returns the maximum number of digits specified for the field. This method is only valid with Integer fields.Returns the content of the field-level help.Returns the text label that is displayed next to the field in the Salesforce user interface. This label can be localized.Returns the maximum size of the field for the DescribeFieldResult object in Unicode characters (not bytes).Returns the name of the field, similar to the getName method. However, if the field is part of the current namespace, the namespace portion of the name is omitted.Returns the field name used in Apex.Returns a list of active PicklistEntry objects. A runtime error is returned if the field isn’t a picklist. Only active picklist values are returned.For fields of type Double, returns the maximum number of digits that can be stored, including all numbers to the left and to the right of the decimal point (but excluding the decimal point character).Returns the name of the custom field on the parent standard or custom object whose values are matched against the values of the child external object's indirect lookup relationship field. The match is done to determine which records are related to each other.Returns a list of Schema.sObjectType objects for the parent objects of this field. If the isNamePointing method returns true, there is more than one entry in the list, otherwise there is only one.Returns the name of the child-to-parent relationship.Returns 0 if the field is the primary relationship field or 1 if the field is the secondary relationship field.For fields of type Double, returns the number of digits to the right of the decimal point. Returns one of the SoapType enum values, depending on the type of field.Returns the token for this field.Returns the Salesforce object type from which this field originates.Returns one of the DisplayType enum values, depending on the type of field.Returns true if the current user can see this field, false otherwise.Returns true if the current field is enabled to display Einstein prediction data, false otherwise.Returns true if the field is an Auto Number field, false otherwise.Returns true if the field is a custom formula field, false otherwise. Note that custom formula fields are always read-only.Returns true if the child object is deleted when the parent object is deleted, false otherwise.Returns true if the field is case sensitive, false otherwise.Returns true if the field can be created by the current user, false otherwise.Returns true if the field is a custom field, false if it is a standard field, such as Name.Returns true if the field receives a default value when created, false otherwise.Returns true if the picklist is a dependent picklist, false otherwise.Reserved for future use.Returns true if the field is encrypted with Shield Platform Encryption, false otherwise.Returns true if the field is used as an external ID, false otherwise.Returns true if the field can be used as part of the filter criteria of a WHERE statement, false otherwise.Returns true if null is treated as zero in a formula field, false otherwise.Returns true if the field can be included in the GROUP BY clause of a SOQL query, false otherwise. This method is only available for Apex classes and triggers saved using API version 18.0 and higher.Returns true if the field has been formatted for HTML and should be encoded for display in HTML, false otherwise. One example of a field that returns true for this method is a hyperlink custom formula field. Another example is a custom formula field that has an IMAGE text function.Returns true if the field can be used to specify a record in an upsert method, false otherwise.Returns true if the field is a name field, false otherwise.Returns true if the field can have multiple types of objects as parents. For example, a task can have both the Contact/Lead ID (WhoId) field and the Opportunity/Account ID (WhatId) field return true for this method. because either of those objects can be the parent of a particular task record. This method returns false otherwise.Returns true if the field is nillable, false otherwise. A nillable field can have empty content. A non-nillable field must have a value for the object to be created or saved.Returns true if field permissions can be specified for the field, false otherwise.Returns true if the parent object can't be deleted because it is referenced by a child object, false otherwise.Returns true if the field is a restricted picklist, false otherwiseReturns true if a foreign key can be included in prefiltering when used in a SOSL WHERE clause, false otherwise.Returns true if a query can sort on the field, false otherwiseReturns true if the value for the field must be unique, false otherwiseReturns true if the field can be edited by the current user, or child records in a master-detail relationship field on a custom object can be reparented to different parent records; false otherwise.Returns true if writing to the detail object requires read sharing instead of read/write sharing of the parent.
• FieldSet Class: Contains methods for discovering and retrieving the details of field sets created on sObjects.Returns the field set’s description.Returns a list of Schema.FieldSetMember objects for the fields making up the field set.Returns the translation of the text label that is displayed next to the field in the Salesforce user interface.Returns the field set’s name.Returns the field set’s namespace.Returns the Schema.sObjectType of the sObject containing the field set definition.
• Id Class: Contains methods for the ID primitive data type.Marks a trigger record with a custom error message and prevents any DML operation from occurring.Marks a trigger record with a custom error message, specifies if the error message should be escaped, and prevents any DML operation from occurring.Marks a trigger record with a custom error message and prevents any DML operation from occurring.Marks a trigger record with a custom error message and prevents any DML operation from occurring.Returns the token for the sObject corresponding to this ID. This method is primarily used with describe information.Converts an 18-character Id value to a 15-character case-sensitive string.Converts the specified String into an ID and returns the ID.Converts the specified string into an ID and returns the ID. If restoreCasing is true, and the string represents an 18-character ID that has incorrect casing, the method returns an 18-character ID that is correctly aligned with its encoded casing.
• Integer Class: Contains methods for the Integer primitive data type.Returns the integer as a string using the locale of the context user.Returns an Integer that contains the value of the specified String. As in Java, the String is interpreted as representing a signed decimal integer.Converts the specified object to an Integer. Use this method to convert a history tracking field value or an object that represents an Integer value.
• Limits Class: Contains methods that return limit information for specific resources.Returns the number of aggregate queries that have been processed with any SOQL query statement.Returns the total number of aggregate queries that can be processed with SOQL query statements.Gets the number of Apex cursors that are created.Gets the maximum number of Apex cursors that can be created per transaction.Gets the number of rows returned by an Apex cursor.Gets the maximum number of rows that can be returned by an Apex cursor.Gets the number of Apex pagination cursors that are created.Gets the maximum number of Apex pagination cursors that can be created per transaction.Gets the number of rows returned by an Apex pagination cursor.Gets the maximum number of rows that can be returned by an Apex pagination cursor.Gets the number of fetch calls on an Apex cursor.Gets the maximum number of fetch calls that can be made on an Apex cursor.Reserved for future use.Reserved for future use.Returns the number of Web service statements that have been processed.Deprecated. Returns the number of child relationship objects that have been returned.Returns the total number of Web service statements that can be processed. Returns the CPU time (in milliseconds) that has been used in the current transaction.Returns the maximum CPU time (in milliseconds) that can be used in a transaction.Returns the number of cursors created so far in this transaction.Returns the maximum number of Data 360 cursors createable in this transaction. Defaults to 50.Returns the number of rows charged so far in this transaction. Returns the maximum total rows across Data 360 cursors this transaction. Defaults to 50 million.Reserved for future use. Reserved for future use.Returns the number of records that have been processed with any statement that counts against DML limits, such as DML statements, the Database.emptyRecycleBin method, and other methods.Returns the total number of records that can be processed with any statement that counts against DML limits, such as DML statements, the database.EmptyRecycleBin method, and other methods. Returns the number of DML statements (such as insert, update or the database.EmptyRecycleBin method) that have been called.Returns the total number of DML statements or the database.EmptyRecycleBin methods that can be called.Returns the number of email invocations (such as sendEmail) that have been called.Returns the total number of email invocation (such as sendEmail) that can be called. Deprecated. Returns the same value as getSoslQueries. The number of findSimilar methods is no longer a separate limit, but is tracked as the number of SOSL queries issued. Deprecated. Returns the same value as getLimitSoslQueries. The number of findSimilar methods is no longer a separate limit, but is tracked as the number of SOSL queries issued. Returns the number of methods with the future annotation that have been executed (not necessarily completed).Returns the total number of methods with the future annotation that can be executed (not necessarily completed).Returns the approximate amount of memory (in bytes) that has been used for the heap.Returns the total amount of memory (in bytes) that can be used for the heap.Returns the number of Apex calls that have been used by mobile push notifications during the current metering interval.Returns the total number of Apex calls that are allowed per transaction for mobile push notifications.Returns the number of EventBus.publish calls that have been made for platform events configured to publish immediately.Returns the total number of EventBus.publish statements that can be called for platform events configured to publish immediately.Returns the number of SOQL queries that have been issued.Returns the total number of SOQL queries that can be issued.Returns the number of records that have been returned by the Database.getQueryLocator method.Returns the total number of records that can be returned by the Database.getQueryLocator method.Returns the number of records that have been returned by issuing SOQL queries.Returns the total number of records that can be returned by issuing SOQL queries.Returns the number of queueable jobs that have been added to the queue per transaction. A queueable job corresponds to a class that implements the Queueable interface.Returns the maximum number of queueable jobs that can be added to the queue per transaction. A queueable job corresponds to a class that implements the Queueable interface.Deprecated. Returns the same value as getDMLStatements.Deprecated. Returns the same value as getLimitDMLStatements.Deprecated. Returns the same value as getDMLStatements.Deprecated. Returns the same value as getLimitDMLStatements.Deprecated. Returns the same value as getDMLStatements.Deprecated. Returns the same value as getLimitDMLStatements.Returns the number of SOSL queries that have been issued.Returns the total number of SOSL queries that can be issued.
• List Class: Contains methods for the List collection type.Creates a new instance of the List class. A list can hold elements of any data type T.Creates a new instance of the List class by copying the elements from the specified list. T is the data type of the elements in both lists and can be any data type.Creates a new instance of the List class by copying the elements from the specified set. T is the data type of the elements in the set and list and can be any data type.Adds an element to the end of the list.Inserts an element into the list at the specified index position and shifts all subsequent elements one index position to the right.Adds all of the elements in the specified list to the list that calls the method. Both lists must be of the same type.Add all of the elements in specified set to the list that calls the method. The set and the list must be of the same type.Removes all elements from a list, consequently setting the list's length to zero.Makes a duplicate copy of a list. Returns true if the list contains the specified element.Makes a duplicate copy of a list of sObject records, including the sObject records themselves.Compares this list with the specified list and returns true if both lists are equal; otherwise, returns false.Returns the list element stored at the specified index.Returns the token of the sObject type that makes up a list of sObjects.Returns the hashcode corresponding to this list and its contents.Returns the index of the first occurrence of the specified element in this list. If this list does not contain the element, returns -1.Returns true if the list has zero elements.Returns an instance of an iterator for this list.Removes the list element stored at the specified index, returning the element that was removed.Sets the specified value for the element at the given index.Returns the number of elements in the list.Sorts the items in the list in ascending order.Returns the string representation of the list.
• Long Class: Contains methods for the Long primitive data type.Returns the String format for this Long using the locale of the context user.Returns the Integer value for this Long.Returns a Long that contains the value of the specified String. As in Java, the string is interpreted as representing a signed decimal Long.
• Map Class: Contains methods for the Map collection type.Creates a new instance of the Map class. T1 is the data type of the keys and T2 is the data type of the values.Creates a new instance of the Map class and initializes it by copying the entries from the specified map. T1 is the data type of the keys and T2 is the data type of the values.Creates a new instance of the Map class and populates it with the passed-in list of sObject records. The keys are populated with the sObject IDs and the values are the sObjects. Removes all of the key-value mappings from the map.Makes a duplicate copy of the map. Returns true if the map contains a mapping for the specified key.Makes a duplicate copy of a map, including sObject records if this is a map with sObject record values.Compares this map with the specified map and returns true if both maps are equal; otherwise, returns false.Returns the value to which the specified key is mapped, or null if the map contains no value for this key. Returns the token of the sObject type that makes up the map values.Returns the hashcode corresponding to this map.Returns true if the map has zero key-value pairs.Returns a set that contains all of the keys in the map.Associates the specified value with the specified key in the map.Copies all of the mappings from the specified map to the original map.Adds the list of sObject records to a map declared as Map<ID, sObject> or Map<String, sObject>.Removes the mapping for the specified key from the map, if present, and returns the corresponding value.Returns the number of key-value pairs in the map. Returns the string representation of the map.Returns a list that contains all the values in the map.
• Math Class: Contains methods for mathematical operations.Returns the mathematical constant e, which is the base of natural logarithms.Returns the mathematical constant pi, which is the ratio of the circumference of a circle to its diameter.Returns the absolute value of the specified Decimal.Returns the absolute value of the specified Double.Returns the absolute value of the specified Integer.Returns the absolute value of the specified Long.Returns the arc cosine of an angle, in the range of 0.0 through pi.Returns the arc cosine of an angle, in the range of 0.0 through pi.Returns the arc sine of an angle, in the range of -pi/2 through pi/2.Returns the arc sine of an angle, in the range of -pi/2 through pi/2.Returns the arc tangent of an angle, in the range of -pi/2 through pi/2.Returns the arc tangent of an angle, in the range of -pi/2 through pi/2.Converts rectangular coordinates (xCoordinate and yCoordinate) to polar (r and theta). This method computes the phase theta by computing an arc tangent of xCoordinate/yCoordinate in the range of -pi to pi. Converts rectangular coordinates (xCoordinate and yCoordinate) to polar (r and theta). This method computes the phase theta by computing an arc tangent of xCoordinate/yCoordinate in the range of -pi to pi. Returns the cube root of the specified Decimal. The cube root of a negative value is the negative of the cube root of that value's magnitude.Returns the cube root of the specified Double. The cube root of a negative value is the negative of the cube root of that value's magnitude.Returns the smallest (closest to negative infinity) Decimal that is not less than the argument and is equal to a mathematical integer.Returns the smallest (closest to negative infinity) Double that is not less than the argument and is equal to a mathematical integer.Returns the trigonometric cosine of the angle specified by decimalAngle. Returns the trigonometric cosine of the angle specified by doubleAngle. Returns the hyperbolic cosine of decimalAngle. The hyperbolic cosine of d is defined to be (ex + e-x)/2 where e is Euler's number. Returns the hyperbolic cosine of doubleAngle. The hyperbolic cosine of d is defined to be (ex + e-x)/2 where e is Euler's number. Returns Euler's number e raised to the power of the specified Decimal.Returns Euler's number e raised to the power of the specified Double.Returns the largest (closest to positive infinity) Decimal that is not greater than the argument and is equal to a mathematical integer.Returns the largest (closest to positive infinity) Double that is not greater than the argument and is equal to a mathematical integer.Returns the natural logarithm (base e) of the specified Decimal.Returns the natural logarithm (base e) of the specified Double.Returns the logarithm (base 10) of the specified Decimal.Returns the logarithm (base 10) of the specified Double.Returns the larger of the two specified Decimals.Returns the larger of the two specified Doubles.Returns the larger of the two specified Integers.Returns the larger of the two specified Longs.Returns the smaller of the two specified Decimals.Returns the smaller of the two specified Doubles.Returns the smaller of the two specified Integers.Returns the smaller of the two specified Longs.Returns the remainder of integerValue1 divided by integerValue2. Returns the remainder of longValue1 divided by longValue2. Returns the value of the first Double raised to the power of exponent. Returns a positive Double that is greater than or equal to 0.0 and less than 1.0.Returns the value that is closest in value to decimalValue and is equal to a mathematical integer.Returns the value that is closest in value to doubleValue and is equal to a mathematical integer.Do not use. This method is deprecated as of the Winter '08 release. Instead, use Math.roundToLong. Returns the closest Integer to the specified Double. If the result is less than -2,147,483,648 or greater than 2,147,483,647, Apex generates an error.Returns the rounded approximation of this Decimal. The number is rounded to zero decimal places using half-even rounding mode, that is, it rounds towards the “nearest neighbor” unless both neighbors are equidistant, in which case, this mode rounds towards the even neighbor. If the result is less than -2,147,483,648 or greater than 2,147,483,647, Apex generates an error.Returns the rounded approximation of this Decimal. The number is rounded to zero decimal places using half-even rounding mode, that is, it rounds towards the “nearest neighbor” unless both neighbors are equidistant, in which case, this mode rounds towards the even neighbor. Returns the closest Long to the specified Double.Returns the signum function of the specified Decimal, which is 0 if decimalValue is 0, 1.0 if decimalValue is greater than 0, -1.0 if decimalValue is less than 0. Returns the signum function of the specified Double, which is 0 if doubleValue is 0, 1.0 if doubleValue is greater than 0, -1.0 if doubleValue is less than 0. Returns the trigonometric sine of the angle specified by decimalAngle. Returns the trigonometric sine of the angle specified by doubleAngle. Returns the hyperbolic sine of decimalAngle. The hyperbolic sine of decimalAngle is defined to be (ex - e-x)/2 where e is Euler's number. Returns the hyperbolic sine of doubleAngle. The hyperbolic sine of doubleAngle is defined to be (ex - e-x)/2 where e is Euler's number. Returns the correctly rounded positive square root of decimalValue. Returns the correctly rounded positive square root of doubleValue. Returns the trigonometric tangent of the angle specified by decimalAngle. Returns the trigonometric tangent of the angle specified by doubleAngle. Returns the hyperbolic tangent of decimalAngle. The hyperbolic tangent of decimalAngle is defined to be (ex - e-x)/(ex + e-x) where e is Euler's number. In other words, it is equivalent to sinh(x)/cosinh(x). The absolute value of the exact tanh is always less than 1. Returns the hyperbolic tangent of doubleAngle. The hyperbolic tangent of doubleAngle is defined to be (ex - e-x)/(ex + e-x) where e is Euler's number. In other words, it is equivalent to sinh(x)/cosinh(x). The absolute value of the exact tanh is always less than 1.
• MultiStaticResourceCalloutMock Class: Utility class used to specify a fake response using multiple resources for testing HTTP callouts.Creates a new instance of the System.MultiStaticResourceCalloutMock class.Sets the specified header name and value for the fake response.Sets the specified static resource corresponding to the endpoint. The static resource contains the response body.Sets the specified HTTP status for the response.Sets the specified HTTP status code for the response.
• RestContext Class: Contains the RestRequest and RestResponse objects.Returns the RestRequest for your Apex REST method.Returns the RestResponse for your Apex REST method.
• RestRequest Class: Use the System.RestRequest class to access and pass request data in a RESTful Apex method.Creates a new instance of the System.RestRequest class.Returns the headers that are received by the request.Returns one of the supported HTTP request methods.Returns the parameters that are received by the request.Returns the IP address of the client making the request.Returns or sets the body of the request.Returns or sets everything after the host in the HTTP request string.Returns the REST resource path for the request.Adds a header to the request header map in an Apex test.Adds a parameter to the request params map in an Apex test.
• RestResponse Class: Represents an object used to pass data from an Apex RESTful Web service method to an HTTP response.Creates a new instance of the System.RestResponse class.Returns or sets the body of the response.Returns the headers to be sent to the response.Returns or sets the response status code.Adds a header to the response header map.
• Schema Class: Contains methods for obtaining schema describe information.Returns a map of all sObject names (keys) to sObject tokens (values) for the standard and custom objects defined in your organization.Returns a list of the category groups associated with the specified objects.Describes metadata (field list and object properties) for the specified sObject or array of sObjects.Describes metadata such as field list and object properties for the specified list of SObjects. The default describe option for this method is SObjectDescribeOptions.DEFERRED, which indicates lazy initialization of describe attributes on first use.Returns information about the standard and custom apps available to the running user. Returns available category groups along with their data category structure for objects specified in the request.
• Search Class: Use the methods of the Search class to perform dynamic SOSL queries.Performs a dynamic SOSL query that can include the SOSL WITH SNIPPET clause. Snippets provide more context for users in Salesforce Knowledge article search results. Performs a dynamic SOSL query that can include the SOSL WITH SNIPPET clause. Snippets provide more context for users in Salesforce Knowledge article search results. Performs a dynamic SOSL query.Performs a dynamic SOSL query.Returns a list of records or Salesforce Knowledge articles whose names or titles match the user’s search query string. Use this method to provide users with shortcuts to navigate to relevant records or articles before they perform a search.Returns a list of records or Salesforce Knowledge articles whose names or titles match the user’s search query string. Use this method to provide users with shortcuts to navigate to relevant records or articles before they perform a search.
• Set Class: Represents a collection of unique elements with no duplicate values.Creates a new instance of the Set class. A set can hold elements of any data type T.Creates a new instance of the Set class by copying the elements of the specified set. T is the data type of the elements in both sets and can be any data type.Creates a new instance of the Set class by copying the list elements. T is the data type of the elements in the set and list and can be any data type.Adds an element to the set if it is not already present.Adds all of the elements in the specified list to the set if they are not already present.Adds all of the elements in the specified set to the set that calls the method if they are not already present.Removes all of the elements from the set.Makes a duplicate copy of the set.Returns true if the set contains the specified element.Returns true if the set contains all of the elements in the specified list. The list must be of the same type as the set that calls the method. Returns true if the set contains all of the elements in the specified set. The specified set must be of the same type as the original set that calls the method.Compares this set with the specified set and returns true if both sets are equal; otherwise, returns false.Returns the hashcode corresponding to this set and its contents.Returns true if the set has zero elements.Removes the specified element from the set if it is present.Removes the elements in the specified list from the set if they are present. Removes the elements in the specified set from the original set if they are present. Retains only the elements in this set that are contained in the specified list.Retains only the elements in the original set that are contained in the specified set.Returns the number of elements in the set (its cardinality).Returns the string representation of the set.
• SObject Class: Contains methods for the sObject data type.Marks a trigger record with a custom error message and prevents any DML operation from occurring.Marks a trigger record with a custom error message, specifies if the error message should be escaped, and prevents any DML operation from occurring.Marks a trigger record with a custom error message and prevents any DML operation from occurring.Marks a trigger record with a custom exception error message, specifies whether or not the exception error message should be escaped, and prevents any DML operation from occurring.Dynamically add errors to fields of an SObject associated with the specified field name.Dynamically add errors to an SObject instance associated with the specified field.Dynamically add errors to fields of an SObject associated with the specified field name.Dynamically add errors to an SObject instance associated with the specified field.Clears all field valuesCreates a copy of the SObject record. Creates a copy of the SObject record. Creates a copy of the SObject record. Creates a copy of the SObject record. Returns the value for the field specified by fieldName, such as AccountNumber. Returns the value for the field specified by the field token Schema.sObjectField, such as, Schema.Account.AccountNumber. Returns the ID of the entity from which an object was cloned. You can use it for objects cloned through the Salesforce user interface. You can also use it for objects created using the System.SObject.clone(preserveId, isDeepClone, preserveReadonlyTimestamps, preserveAutonumber) method, provided that the preserveId parameter wasn’t used or was set to false. The getCloneSourceId() method can only be used within the transaction where the entity is cloned, as clone information doesn’t persist in subsequent transactions. Returns a list of Database.Error objects for an SObject instance. If the SObject has no errors, an empty list is returned.Returns the database.DMLOptions object for the SObject. Returns a map of populated field names and their corresponding values. The map contains only the fields that have been populated in memory for the SObject instance.Returns the value for the specified field. This method is primarily used with dynamic DML to access values for external IDs.Returns the value for the field specified by the field token Schema.sObjectField, such as, Schema.MyObj.MyExternalId. This method is primarily used with dynamic DML to access values for external IDs.Returns the values for the specified field. This method is primarily used with dynamic DML to access values for associated objects, such as child relationships.Returns the value for the field specified by the field token Schema.fieldName, such as, Schema.Account.Contact. This method is primarily used with dynamic DML to access values for associated objects, such as child relationships.Returns the token for this SObject. This method is primarily used with describe information.Retrieves the name of a quick action associated with this SObject. Typically used in triggers.Returns true if an SObject instance has associated errors. The error message can be associated to the SObject instance by using SObject.addError(), validation rules, or by other means.Returns true if an entity is cloned from something, even if the entity hasn’t been saved. The method can only be used within the transaction where the entity is cloned, as clone information doesn’t persist in subsequent transactions.Returns information about the queried sObject field. Returns true if the sObject field is populated, either by direct assignment or by inclusion in a SOQL query. Returns false if the sObject field isn’t set. If an invalid field is specified, an SObjectException is thrown.Returns information about the queried sObject field. Returns true if the sObject field is populated, either by direct assignment or by inclusion in a SOQL query. Returns false if the sObject field isn’t set. If an invalid field is specified, an SObjectException is thrown.Sets the value for the specified field and returns the previous value for the field.Sets the value for the field specified by the field token Schema.sObjectField, such as, Schema.Account.AccountNumber and returns the previous value for the field.Sets the value for the specified field. This method is primarily used with dynamic DML for setting external IDs. The method returns the previous value of the field. Sets the value for the field specified by the token Schema.SObjectType. This method is primarily used with dynamic DML for setting external IDs. The method returns the previous value of the field. Deprecated as of API version 57.0. Use the recalculateFormulas() method in the System.Formula class instead.Sets the DMLOptions object for the SObject.
• DescribeSObjectResult Class: Contains methods for describing SObjects. None of the methods take an argument.Indicates whether the current user has access to the SObject.The type of associated object. For example, History or Share.The parent object of an associated object.A list of child relationships, which is the name of the sObject that has a foreign key to the sObject being described.Indicates whether the SObject can be created by the current user.Indicates whether the SObject is a custom object.Indicates whether the SObject is a custom setting.Indicates whether data translation is enabled for the SObject. This property is available in API version 49.0 and later.Reserved for future use.Indicates whether the SObject can be deleted by the current user.Reserved for future use.Indicates whether Chatter feeds are enabled for the SObject. A list of fields associated with the SObject. Represents field sets, which is a grouping of the SObject fields.Reserved for future use.Reserved for future use.Reserved for future use.Reserved for future use.The three-character prefix code in the SObject ID.The SObject's label, which may or may not match the object name. For example, an organization representing a medical vertical might rename Account to Patient. Tabs and fields can be renamed in the Salesforce user interface. The SObject's plural label, which may or may not match the object name. For example, Accounts.The name of the SObject. If the object is part of the current namespace, the namespace portion of the name is omitted.Indicates whether the SObject can be merged with other objects of its type by the current user. This is set to true for leads, contacts, and accounts.Indicates whether Most Recently Used (MRU) list functionality is enabled for the SObject.The name field of the SObject.Indicates whether the SObject can be queried by the current user.A list of the record types supported by the SObject. A map that matches developer names to their associated record type.A map that matches record IDs to their associated record types.A map that matches record labels to their associated record type.Indicates whether the SObject can be searched by the current user.The effective describe option used by the system for the SObject.The Schema.SObjectType object for the SObject.Indicates whether the SObject can be undeleted by the current user.Indicates whether the SObject can be updated by the current user.Compares the SObject to the specified object and returns true if both are equal. Otherwise, returns false.Returns additional metadata for an associated object of a specified parent but only if it's a specific associated object type. Used in combination with the getAssociateParentEntity() method to get the parent object. For example, invoking the method on AccountHistory returns the parent object as Account and the type of associated object as History. Returns additional metadata for an associated object but only if it's associated to a specific parent object. Used in combination with the getAssociateEntityType() method to get the type of associated object. For example, invoking the method on AccountHistory returns the parent object as Account and the type of associated object as History. Returns a list of child relationships, which are the names of the sObjects that have a foreign key to the sObject being described.Returns true if data translation is enabled for the SObject. Otherwise, returns false.Reserved for future use.Returns the fields that make up the SObject being described. Returns field sets, which is a grouping of the SObject fields.Reserved for future use.Reserved for future use.Reserved for future use.Reserved for future use.Returns the three-character prefix code for the object. Record IDs are prefixed with three-character codes that specify the type of the object (for example, accounts have a prefix of 001 and opportunities have a prefix of 006). Returns the object's label, which may or may not match the object name.Returns the object's plural label, which may or may not match the object name.Returns the name of the object, similar to the getName method. However, if the object is part of the current namespace, the namespace portion of the name is omitted.Returns the name of the object.Returns a list of the record types supported by this object. The current user is not required to have access to a record type to see it in this list.Returns a map that matches developer names to their associated record type. The current user is not required to have access to a record type to see it in this map.Returns a map that matches record IDs to their associated record types. The current user is not required to have access to a record type to see it in this map.Returns a map that matches record labels to their associated record type. The current user is not required to have access to a record type to see it in this map.Returns the effective describe option used by the system for the SObject.Returns the Schema.SObjectType object for the sObject. You can use this to create a similar sObject.Reserved for future use.Returns the hash code for the SObject.Returns true if the current user can see this object, false otherwise.Returns true if the object can be created by the current user, false otherwise.Returns true if the object is a custom object, false if it is a standard object.Returns true if the object is a custom setting, false otherwise.Returns true if the object can be deleted by the current user, false otherwise.Reserved for future use. Returns true if Chatter feeds are enabled for the object, false otherwise. This method is only available for Apex classes and triggers saved using SalesforceAPI version 19.0 and later. Returns true if the object can be merged with other objects of its type by the current user, false otherwise. true is returned for leads, contacts, and accounts.Returns true if Most Recently Used (MRU) list functionality is enabled for the object, false otherwise.Returns true if the object can be queried by the current user, false otherwiseReturns true if the object can be searched by the current user, false otherwise.Returns true if the object can be undeleted by the current user, false otherwise.Returns true if the object can be updated by the current user, false otherwise.Returns a string that represents the SObject.
• StaticResourceCalloutMock Class: Utility class used to specify a fake response for testing HTTP callouts.Creates a new instance of the StaticResourceCalloutMock class.Sets the specified header name and value for the fake response.Sets the specified static resource, which contains the response body.Sets the specified HTTP status for the response.Sets the specified HTTP status for the response.
• String Class: Contains methods for the String primitive data type.Returns an abbreviated version of the String, of the specified length and with ellipses appended if the current String is longer than the specified length; otherwise, returns the original String without ellipses.Returns an abbreviated version of the String, starting at the specified character offset and of the specified length. The returned String has ellipses appended at the start and the end if characters have been removed at these locations.Returns the current String with the first letter changed to title case.Returns a version of the current String of the specified size padded with spaces on the left and right, so that it appears in the center. If the specified size is smaller than the current String size, the entire String is returned without added spaces.Returns a version of the current String of the specified size padded with the specified String on the left and right, so that it appears in the center. If the specified size is smaller than the current String size, the entire String is returned without padding.Returns the value of the character at the specified index.Returns the Unicode code point value at the specified index.Returns the Unicode code point value that occurs before the specified index.Returns the number of Unicode code points within the specified text range.Compares two strings lexicographically, based on the Unicode value of each character in the Strings.Returns true if and only if the String that called the method contains the specified sequence of characters in substring. Returns true if the current String contains any of the characters in the specified String; otherwise, returns false.Returns true if the current String contains the specified sequence of characters without regard to case; otherwise, returns false.Returns true if the current String doesn’t contain any of the characters in the specified String; otherwise, returns false.Returns true if the current String contains characters only from the specified sequence of characters and not any other characters; otherwise, returns false.Returns true if the current String contains any white space characters; otherwise, returns false.Returns the number of times the specified substring occurs in the current String.Returns a version of the current String with all white space characters removed.Returns the difference between the current String and the specified String.Returns true if the String that called the method ends with the specified suffix.Returns true if the current String ends with the specified suffix; otherwise, returns false.Deprecated. This method is replaced by equals(stringOrId). Returns true if the passed-in string is not null and represents the same binary sequence of characters as the current string. Use this method to perform case-sensitive comparisons.Returns true if the passed-in object is not null and represents the same binary sequence of characters as the current string. Use this method to compare a string to an object that represents a string or an ID.Returns true if the secondString isn’t null and represents the same sequence of characters as the String that called the method, ignoring case. Returns a String for a CSV column enclosed in double quotes, if required.Escapes the characters in the String using EcmaScript String rules.Escapes the characters in a String using HTML 3.0 entities.Escapes the characters in a String using HTML 4.0 entities.Returns a String whose characters are escaped using Java String rules. Characters escaped include quotes and control characters, such as tab, backslash, and carriage return characters.Returns a String with the escape character (\) added before any single quotation mark (') or backslash (\) in the String s. Returns a String whose Unicode characters are escaped to a Unicode escape sequence.Escapes the characters in a String using XML entities. Treat the first argument as a pattern and return a string using the second argument for substitution and formatting. The substitution and formatting are the same as apex:outputText and the Java MessageFormat class. Non-string types in the second argument’s List are implicitly converted to strings, respecting the toString() method overrides that exist on the type. Returns a String from the values of the list of integers. Returns an array of character values that represent the characters in this string.Returns the initial sequence of characters as a String that is common to all the specified Strings.Returns the Levenshtein distance between the current String and the specified String.Returns the Levenshtein distance between the current String and the specified String if it is less than or equal than the given threshold; otherwise, returns -1.Returns a hash code value for this string. Returns the index of the first occurrence of the specified substring. If the substring does not occur, this method returns -1.Returns the zero-based index of the first occurrence of the specified substring from the point of the given index. If the substring does not occur, this method returns -1.Returns the zero-based index of the first occurrence of any character specified in the substring. If none of the characters occur, returns -1. Returns the zero-based index of the first occurrence of a character that is not in the specified substring. Otherwise, returns -1. Returns the index of the first occurrence of the character that corresponds to the specified character value.Returns the index of the first occurrence of the character that corresponds to the specified character value, starting from the specified index.Returns the zero-based index of the character where the current String begins to differ from the specified String.Returns the zero-based index of the first occurrence of the specified substring without regard to case. If the substring does not occur, this method returns -1.Returns the zero-based index of the first occurrence of the specified substring from the point of index i, without regard to case. If the substring does not occur, this method returns -1. Returns true if all characters in the current String are lowercase; otherwise, returns false.Returns true if all characters in the current String are uppercase; otherwise, returns false.Returns true if all characters in the current String are Unicode letters only; otherwise, returns false.Returns true if all characters in the current String are Unicode letters or spaces only; otherwise, returns false.Returns true if all characters in the current String are Unicode letters or digits only; otherwise, returns false.Returns true if all characters in the current String are Unicode letters, digits, or spaces only; otherwise, returns false.Returns true if the current String contains only ASCII printable characters; otherwise, returns false.Returns true if the specified String is white space, empty (''), or null; otherwise, returns false.Returns true if the specified String is empty ('') or null; otherwise, returns false.Returns true if the specified String is not whitespace, not empty (''), and not null; otherwise, returns false.Returns true if the specified String is not empty ('') and not null; otherwise, returns false.Returns true if the current String contains only Unicode digits; otherwise, returns false.Returns true if the current String contains only Unicode digits or spaces; otherwise, returns false.Returns true if the current String contains only white space characters or is empty; otherwise, returns false.Joins the elements of the specified iterable object, such as a List, into a single String separated by the specified separator.Returns the index of the last occurrence of the specified substring. If the substring does not occur, this method returns -1.Returns the index of the last occurrence of the specified substring, starting from the character at index 0 and ending at the specified index. Returns the index of the last occurrence of the character that corresponds to the specified character value.Returns the index of the last occurrence of the character that corresponds to the specified character value, starting from the specified index.Returns the index of the last occurrence of the specified substring regardless of case. Returns the index of the last occurrence of the specified substring regardless of case, starting from the character at index 0 and ending at the specified index. Returns the leftmost characters of the current String of the specified length.Returns the current String padded with spaces on the left and of the specified length. Returns the current String padded with String padStr on the left and of the specified length. Returns the number of 16-bit Unicode characters contained in the String.Returns a new String that begins with the character at the specified zero-based startIndex with the number of characters specified by length. Returns the current String with leading, trailing, and repeating white space characters removed. Returns the index of the Unicode code point that is offset by the specified number of code points, starting from the given index.Removes all occurrences of the specified substring and returns the String result.Removes the specified substring only if it occurs at the end of the String.Removes the specified substring only if it occurs at the end of the String using a case-insensitive match.Removes the specified substring only if it occurs at the beginning of the String.Removes the specified substring only if it occurs at the beginning of the String using a case-insensitive match.Returns the current String repeated the specified number of times. Returns the current String repeated the specified number of times using the specified separator to separate the repeated Strings. Replaces each substring of a string that matches the literal target sequence target with the specified literal replacement sequence replacement.Replaces each substring of a string that matches the regular expression regExp with the replacement sequence replacement.Replaces the first substring of a string that matches the regular expression regExp with the replacement sequence replacement. Returns a String with all the characters reversed.Returns the rightmost characters of the current String of the specified length.Returns the current String padded with spaces on the right and of the specified length. Returns the current String padded with String padStr on the right and of the specified length. Returns a list that contains each substring of the String that is terminated by either the regular expression regExp or the end of the String. Returns a list that contains each substring of the String that is terminated by either the regular expression regExp or the end of the String.Splits the current String by character type and returns a list of contiguous character groups of the same type as complete tokens.Splits the current String by character type and returns a list of contiguous character groups of the same type as complete tokens, with the following exception: the uppercase character, if any, immediately preceding a lowercase character token belongs to the following character token rather than to the preceding.Returns true if the String that called the method begins with the specified prefix.Returns true if the current String begins with the specified prefix regardless of the prefix case.Removes HTML markup and returns plain text.Returns a new String that begins with the character at the specified zero-based startIndex and extends to the end of the String. Returns a new String that begins with the character at the specified zero-based startIndex and extends to the character at endIndex - 1.Returns the substring that occurs after the first occurrence of the specified separator.Returns the substring that occurs after the last occurrence of the specified separator.Returns the substring that occurs before the first occurrence of the specified separator.Returns the substring that occurs before the last occurrence of the specified separator.Returns the substring that occurs between two instances of the specified tag String. Returns the substring that occurs between the two specified Strings.Swaps the case of all characters and returns the resulting String by using the default (English US) locale. Converts all of the characters in the String to lowercase using the rules of the default (English US) locale.Converts all of the characters in the String to lowercase using the rules of the specified locale.Converts all of the characters in the String to uppercase using the rules of the default (English US) locale.Converts all of the characters in the String to the uppercase using the rules of the specified locale. Substitutes variables in a string for their corresponding values in the valueMap parameter, and returns the updated string.Returns a copy of the string that no longer contains any leading or trailing white space characters. Returns the current String with the first letter in lowercase.Returns a String representing an unescaped CSV column.Unescapes any EcmaScript literals found in the String.Unescapes the characters in a String using HTML 3.0 entities.Unescapes the characters in a String using HTML 4.0 entities.Returns a String whose Java literals are unescaped. Literals unescaped include escape sequences for quotes (\") and control characters, such as tab (\\t), and carriage return (\\n).Returns a String whose escaped Unicode characters are unescaped.Unescapes the characters in a String using XML entities.Returns a String that represents the specified Date in the standard “yyyy-MM-dd” format.Returns a String that represents the specified Datetime in the standard “yyyy-MM-dd HH:mm:ss” format for the local time zone.Returns a String that represents the specified Decimal.Returns a String that represents the specified Double.Returns a String that represents the specified Integer.Returns a String that represents the specified Long. Returns a string representation of the specified object argument. Returns a String that represents the specified Datetime in the standard “yyyy-MM-dd HH:mm:ss” format for the GMT time zone.
• System Class: Contains methods for system operations, such as writing debug messages and scheduling jobs.Stops the specified job. If the job is currently executing, the stopped job is still visible in the job queue in the Salesforce user interface. The specified job is stopped, but any code that is in progress will continue to execute until it completes.Asserts that the specified condition is true. If it isn’t , a fatal error is returned that causes code execution to halt.Asserts that the first two arguments are the same. If they aren’t, a fatal error is returned that causes code execution to halt.Asserts that the first two arguments are different. If they’re the same, a fatal error is returned that causes code execution to halt. Attach a finalizer for a Queueable job.Returns a reference to the current page. This is used with Visualforce pages.Returns the current time in milliseconds, which is expressed as the difference between the current time and midnight, January 1, 1970 UTC.Writes the specified message, in string format, to the execution debug log. The DEBUG log level is used. Writes the specified message, in string format, to the execution debug log with the specified log level.Adds a job to the Apex job queue that corresponds to the specified queueable class and returns the job ID. Adds a job to the Apex job queue that corresponds to the specified queueable class and returns the job ID. The job is scheduled with a specified minimum delay (0–10 minutes). The delay is ignored during Apex testing.Adds a job to the Apex job queue that corresponds to the specified queueable class and returns the job ID. Specify a unique signature for your queueable job, the maximum stack depth or the minimum queue delay in the asyncOptions parameter.Returns true if both arguments are equal. Otherwise, returns false.Returns the read write mode set for an organization during Salesforce.com upgrades and downtimes.Returns the short code for the Quiddity value of the current Request object.Returns the hash code of the specified object.Returns true if a batch Apex job invoked the executing code, or false if not. In API version 35.0 and earlier, also returns true if a queueable Apex job invoked the code.Returns true if an asynchronous Salesforce Function callback invoked the executing code, or false if not. Available in API version 51.0 and later.Returns true if the currently executing code is invoked by code contained in a method annotated with future; false otherwise.Returns true if a queueable Apex job invoked the executing code. Returns false if not, including if a batch Apex job or a future method invoked the code.Reserved for future use.Returns true if the currently executing code is invoked by a scheduled Apex job; false otherwise.Moves the specified user’s password to a different user.Returns the current date and time in the GMT time zone.Pause a scheduled Apex job specified by its CronTrigger ID.Pause a scheduled Apex job specified by its name.Processes the list of work item IDs.Deletes asynchronous Apex job records for jobs that have finished execution before the specified date with a Completed, Aborted, or Failed status, and returns the number of records deleted.Deletes asynchronous Apex job records for the specified number of jobs that finished before the specified date and have a Completed, Aborted, or Failed status. Returns the number of records deleted.Returns a two-part version that contains the major and minor version numbers of a package. Applies to first-generation managed packages.Resets the password for the specified user.Resets the user's password and sends an email to the user with their new password. You specify the email template that is sent to the specified user. Use this method for external users of Experience Cloud sites.Resume a paused scheduled Apex job specified by its CronTrigger ID.Resumes a paused scheduled Apex job specified by its name.Changes the current package version to the package version specified in the argument.Changes the current user to the specified user.Use schedule with an Apex class that implements the Schedulable interface to schedule the class to run at the time specified by a Cron expression.Schedules a batch job to run once in the future after the specified time interval and with the specified job name.Schedules a batch job to run once in the future after the specified the time interval, with the specified job name and scope size. Returns the scheduled job ID (CronTrigger ID).Sets the password for the specified user.Submits the processed approvals. The current user is the submitter and the entry criteria is evaluated for all processes applicable to the current user. Returns the current date in the current user's time zone.
• Test Class: Contains methods related to Apex tests.Calculates aggregate permissions in specified permission set groups for testing.Calculates aggregate permissions in a specified permission set group for testing.Clear the messages on a Visualforce page while executing Apex test methods.Creates a stub that will respond to SOQL queries against the specified SObject type you can use during testing.Creates a stubbed version of an Apex class that you can use for testing. This method is part of the Apex stub API. You can use it with the System.StubProvider interface to create a mocking framework.Creates an instance of a stubbed SObject type that you can use to provide testing results in the extended System.SoqlStubProvider class.Creates instances of stubbed SObject types that you can use to provide testing results in the extended System.SoqlStubProvider class.Use this method in an Apex test so that change event notifications are generated for all supported Change Data Capture entities. Call this method at the beginning of your test before performing DML operations and calling Test.getEventBus().deliver();.Adds the specified number of jobs with no-operation contents to the test-context queue. It first fills the test batch queue, up to the maximum 5 jobs, and then places jobs in the test flex queue. It throws a limit exception when the number of jobs in the test flex queue exceeds the allowed limit of 100 jobs.Returns an instance of the test event bus broker, which lets you operate on platform event or change event messages in an Apex test. For example, you can call Test.getEventBus().deliver() to deliver event messages.Returns an ordered list of job IDs for jobs in the test-context flex queue. The job at index 0 is the next job slated to run. This method returns only test-context results, even if it’s annotated with @IsTest(SeeAllData=true).Returns the ID of the standard price book in the organization.Invokes the callback method for the specified controller and continuation in a test method.Returns true if the currently executing code was called by code contained in a test method, false otherwise. Use this method if you need to run different code depending on whether it was being called from a test.Returns true if a SOQL stub is defined for an SObject type; otherwise returns false.Inserts test records from the specified static resource .csv file and for the specified sObject type, and returns a list of the inserted sObjects.Tests a notification action handler implementation by simulating the execution of an action for a specific notification.Creates a new QuickAction.SendEmailQuickActionDefaults instance for testing a class implementing the QuickAction.QuickActionDefaultsHandler interface.Sets a mock response for a continuation HTTP request in a test method.Sets CreatedDate for a test-context sObject.A Visualforce test method that sets the current PageReference for the controller.A Visualforce test method that sets the current PageReference for the controller.Defines a list of fixed search results to be returned by all subsequent SOSL statements in a test method.Sets the response mock mode and instructs the Apex runtime to send a mock response whenever a callout is made through the HTTP classes or the auto-generated code from WSDLs.Sets the application mode for an organization to read-only in an Apex test to simulate read-only mode during Salesforce upgrades and downtimes. The application mode is reset to the default mode at the end of each Apex test run.Marks the point in your test code when your test actually begins. Use this method when you are testing governor limits.Marks the point in your test code when your test ends. Use this method in conjunction with the startTest method. Tests the implementation of the InstallHandler interface, which is used for specifying a post install script in packages. Tests run as the test initiator in the development environment.Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. Tests run as the test initiator in the development environment.Tests the implementation of the SandboxPostCopy Interface, which is used for specifying a script to run at the completion of a Sandbox copy. When RunAsAutoProcUser is true, tests run as Automated Process user in the development environment.Tests the implementation of the UninstallHandler interface, which is used for specifying an uninstall script in packages. Tests run as the test initiator in the development environment.
• Time Class: Contains methods for the Time primitive data type.Adds the specified number of hours to a Time.Adds the specified number of milliseconds to a Time.Adds the specified number of minutes to a Time.Adds the specified number of seconds to a Time.Returns the hour component of a Time.Returns the millisecond component of a Time.Returns the minute component of a Time.Constructs a Time from Integer representations of the specified hour, minutes, seconds, and milliseconds. (UTC is assumed.)Returns the second component of a Time.
• TimeZone Class: Represents a time zone. Contains methods for creating a new time zone and obtaining time zone properties, such as the time zone ID, offset, and display name.Returns this time zone’s display name.Returns this time zone’s ID.Returns the time zone offset, in milliseconds, of the specified date to the GMT time zone.Returns the time zone corresponding to the specified time zone ID.Returns the string representation of this time zone.
• Type Class: Contains methods for getting the Apex type that corresponds to an Apex class and for instantiating new types.Returns true if the specified type is equal to the current type; otherwise, returns false.Returns the type that corresponds to the specified fully qualified class name.Returns the type that corresponds to the specified namespace and class name.Returns the name of the current type.Returns a hash code value for the current type.Returns true if an object reference of the specified type can be assigned from the child type; otherwise, returns false. Creates an instance of the current type and returns this new instance.Returns a string representation of the current type, which is the type name.
• URL Class: Represents a uniform resource locator (URL) and provides access to parts of the URL. Enables access to the base URL used to access your Salesforce org.Creates a new instance of the URL class using the specified string representation of the URL.Creates a new instance of the URL class by parsing the specified spec within the specified context.Creates a new instance of the URL class using the specified protocol, host, and file on the host. The default port for the specified protocol is used. Creates a new instance of the URL class using the specified protocol, host, port, and file on the host.Returns the authority portion of the current URL.Returns the URL of an entire request on a Salesforce instance.Returns the default port number of the protocol associated with the current URL.Returns the file name of the current URL.Returns the download URL for a file attachment.Returns the host name of the current URL.Returns the canonical URL for your org. For example, https://MyDomainName.my.salesforce.com.Returns the path portion of the current URL.Returns the port of the current URL.Returns the protocol name of the current URL, such as, https.Returns the query portion of the current URL.Returns the anchor of the current URL. In API version 59.0 and later, this method is deprecated and versioned out. Use getOrgDomainUrl() to get the canonical URL for your org or use getCurrentRequestUrl() to get the URL of an entire request on a Salesforce instance. Returns the URL of the current connection to the Salesforce org.Gets the UserInfo portion of the current URL.Compares the current URL with the specified URL object, excluding the fragment component.Returns a string representation of the current URL.
• UserInfo Class: Contains methods for obtaining information about the context user.Returns the context guest user’s unique visitor ID (UVID).Returns the context user's default currency code for multiple currency organizations or the organization's currency code for single currency organizations.Returns the context user's first nameReturns the context user's languageReturns the context user's last nameReturns the context user's locale.Returns the context user's full name. The format of the name depends on the language preferences specified for the organization.Returns the context organization's ID.Returns the context organization's company name.Returns the context user's profile ID.Returns the session ID for the current session.Returns the current user’s local time zone. Returns the preferred theme for the current user. Use getUiThemeDisplayed to determine the theme actually displayed to the current user. Returns the theme being displayed for the current user.Returns the current user’s email address.Returns the context user's IDReturns the context user's login name.Returns the context user's role ID.Returns the context user's type. Returns true if the context user has a license to the managed package via a package license only. Otherwise, returns false. Returns true if the context user has a license to any managed package denoted by the namespace. Otherwise, returns false.Returns true if the context user has a license to the managed package denoted by the package ID. Otherwise, returns false. If the context user has access, it’s determined either via the package license or a namespace permission set license for the package namespace.Specifies whether the organization uses multiple currencies.
• Version Class: Use the Version methods to get the version of a first-generation managed package (1GP) or a migrated second-generation managed package (2GP), and to compare package versions.Creates a new instance of the Version class as a two-part package version using the specified major and minor version numbers.Creates a new instance of the Version class as a three-part package version using the specified major, minor, and patch version numbers.Compares the current version with the specified version.Returns the major package version of the of the calling code.Returns the minor package version of the calling code.Returns the patch package version of the calling code or null if there is no patch version.
• ApexPages Namespace: The ApexPages namespace provides classes used in Visualforce controllers.
• Approval Namespace: The Approval namespace provides classes and methods for approval processes.
• Auth Namespace: The Auth namespace provides an interface and classes for single sign-on into Salesforce and session security management.
• Canvas Namespace: The Canvas namespace provides an interface and classes for canvas apps in Salesforce.
• ChatterAnswers Namespace: The ChatterAnswers namespace provides an interface for creating Account records.
• CommerceBuyGrp Namespace: The CommerceBuyGrp namespace provides classes and methods for retrieving information about the buyer groups associated with a user.
• CommerceExtension Namespace: Use the CommerceExtension namespace to define resolution strategies for registered Commerce extensions.
• DataRetrieval Namespace: The DataRetrieval namespace provides classes and methods to record details of customer-agent engagements, as well as transcripts of their conversations.
• DataSource Namespace: The DataSource namespace provides the classes for the Apex Connector Framework. Use the Apex Connector Framework to develop a custom adapter for Salesforce Connect. Then connect your Salesforce organization to any data anywhere via the Salesforce Connect custom adapter.
• Database Namespace: The Database namespace provides classes used with DML operations.
• Dom Namespace: The Dom namespace provides classes and methods for parsing and creating XML content.
• ExternalService Namespace: The ExternalService namespace provides dynamically generated Apex service interfaces and Apex classes for complex object data types.
• Flow Namespace: The Flow namespace provides a class for advanced access to flows from Apex such as from Visualforce controllers and asynchronous Apex.
• Invocable Namespace: The Invocable namespace provides classes for calling invocable actions from Apex.
• IsvPartners Namespace: The IsvPartners namespace provides a class associated with Salesforce ISV partner use cases, such as optimizing code, providing great customer trial experiences, and driving feature adoption.
• KbManagement Namespace: The KbManagement namespace provides a class for managing knowledge articles.
• Messaging Namespace: The Messaging namespace provides classes and methods for Salesforce notifications and email functionality.
• Metadata Namespace: The Metadata namespace provides classes and methods for working with custom metadata in Salesforce
• QuickAction Namespace: The QuickAction namespace provides classes and methods for quick actions.
• Reports Namespace: The Reports namespace provides classes for accessing the same data as is available in the Salesforce Reports and Dashboards REST API.
• RevSignaling Namespace: The RevSignaling namespace provides classes to extend the standard procedure plan implementation through custom logic. A procedure plan helps you set up your procedures, configure the procedure execution settings, and relate them to a context definition in one centralized location based on your requirements.
• RichMessaging Namespace: Provides objects and methods for handling content in enhanced Messaging channels.
• SF_Archive Namespace: The SF_Archive namespace provides classes for testing Apex code that calls Archive Apex.
• Schema Namespace: The Schema namespace provides classes and methods for schema metadata information.
• Search Namespace: The Search namespace provides classes for getting search results and suggestion results.
• Sfc Namespace: The Sfc namespace contains classes used in Salesforce Files.
• Site Namespace: The Site namespace provides an interface for rewriting Sites URLs.
• Slack Namespace: The Slack Namespace provides tools designed to accelerate and ease the process of developing Slack apps on the Salesforce platform.
• Support Namespace: The Support namespace provides an interface used for Case Feed.
• System Namespace: The System namespace provides classes and methods for core Apex functionality.
• TerritoryMgmt Namespace: The TerritoryMgmt namespace provides an interface used for territory management.
• TxnSecurity Namespace: The TxnSecurity namespace provides an interface used for transaction security.
• UserProvisioning Namespace: The UserProvisioning namespace provides methods for monitoring outbound user provisioning requests.
• VisualEditor Namespace: The VisualEditor namespace provides classes and methods for interacting with the Lightning App Builder. The classes and methods in this namespace operate on Lightning components, which include Lightning web components and Aura components.
• AppLauncher Namespace: The AppLauncher namespace provides methods for managing the appearance of apps in the App Launcher, including their visibility and sort order.
• Cache Namespace: The Cache namespace contains methods for managing the platform cache.
• CommerceOrders Namespace: The CommerceOrders namespace provides classes and methods to place orders with integrated pricing, configuration, and validation.
• CommercePayments Namespace: Use the CommercePayments namespace to provide a safe and customizable platform for managing customer payments and refunds.
• CommerceTax Namespace: Manage the communication between Salesforce and an external tax engine.
• commonserviceexcellence Namespace: The commonserviceexcellence namespace provides classes used in financial account FlexCards. These classes are documented in the Agentforce Financial Services Developer Guide.
• ComplianceMgmt Namespace: The ComplianceMgmt namespace provides classes and methods to implement rule processors for compliance control.
• Compression Namespace: The Compression namespace provides classes and methods to create and extract zip files.
• Context Namespace: The Context namespace provides classes and methods to manage the sharing and consumption of business application data by using Context Service.
• Datacloud Namespace: The Datacloud namespace provides classes and methods for retrieving information about duplicate rules. Duplicate rules let you control whether and when users can save duplicate records within Salesforce.
• DataWeave Namespace: The DataWeave namespace provides classes and methods to support the invocation of DataWeave scripts from Apex.
• disputemanagement Namespace: The disputemanagement namespace classes provide services for Integration Procedures used by the Transaction Dispute Management OmniScript. These classes are documented in the Agentforce Financial Services Developer Guide.
• embeddedai Namespace: The embeddedai namespace provides classes and methods to manage and represent records and data in Apex to support embedded AI features.
• EventBus Namespace: The EventBus namespace provides classes and methods for platform events and Change Data Capture events.
• Flowtesting Namespace: The flowtesting namespace provides dynamically generated Apex classes for flow tests that are created in Flow Builder.
• flowuiruntime Namespace: The classes and methods in this namespace are reserved for internal use only or future use.
• FormulaEval Namespace: The FormulaEval namespace provides classes and methods to evaluate dynamic formulas for SObjects and Apex objects. Use the methods to avoid unnecessary DML statements to recalculate formula field values or evaluate dynamic formula expressions.
• fsccashflow Namespace: The fsccashflow namespace provides classes used in the FSCCashFlow FlexCards and their child FlexCards. These classes are documented in the Agentforce Financial Services developer guide.
• fsccomplaintmanagement Namespace: The fsccomplaintmanagement namespace classes provide data helper functions for use in complaint management. These classes are documented in the Agentforce Financial Services Developer Guide.
• fschousehold Namespace: The fschousehold namespace provides classes used for households, financial accounts, goals, and plans. These classes are documented in the Agentforce Financial Services Developer Guide.
• fscserviceprocesses Namespace: The fscserviceprocesses namespace provides classes used in service process OmniScripts, such as change address and fee reversal. These classes are documented in the Agentforce Financial Services Developer Guide.
• fscwmgen Namespace: The fscwmgen namespace provides an interface and classes used for record alerts. These are documented in the Agentforce Financial Services Developer Guide.
• Functions Namespace: The Functions namespace provides classes and methods used to invoke and manage Salesforce Functions.
• ind_mfg_sample_mgmt_apex Namespace: The ind_mfg_sample_mgmt_apex namespace provides classes and properties to manage the lifecycle and documentation of product requirements in manufacturing. Create, update, or version Product Requirement Specification records to ensure sample data remains consistent and compliant with production standards.
• IndustriesDigitalLending Namespace: The industriesDigitalLending namespace provides classes used in the Digital Lending OmniScripts and Integration Procedures.
• industriesNlpSvc: Stores the objects used in Industries Einstein Natural Language Processing (NLP) services.
• industriespersonalizedfinance Namespace: The industriespersonalizedfinance namespace classes provide data helper functions for use in personalized finance. These classes are documented in the Agentforce Financial Services Developer Guide.
• InvoiceWriteOff Namespace: The InvoiceWriteOff namespace provides classes to create credit memos with the total charge amount on the invoice as the write-off amount.
• ise_bots_apex Namespace: The ise_bots_apex namespace provides classes and properties to facilitate dynamic content generation and data handling for menu-driven bot interactions. Create and manage dynamic menu items that adapt to user inputs, context, and underlying object data.
• IssueCreditMemo Namespace: The IssueCreditMemo namespace provides classes to create and apply credit memos against invoices or invoice lines based on dispute adjustments.
• LxScheduler Namespace: The LxScheduler namespace provides an interface and classes for integrating Salesforce Scheduler with external calendars.
• PlaceQuote Namespace: The PlaceQuote namespace provides classes and methods to create or update quotes with pricing preferences and configuration options.
• Pref_center Namespace: The Pref_center namespace provides an interface, classes, and methods to create and retrieve data in forms in Preference Manager. Preference Manager, previously called Preference Center, is a feature within the Privacy Center app.
• Process Namespace: The Process namespace provides an interface and classes for passing data between your organization and a flow.
• renew_assets_summary Namespace: The renew_assets_summary namespace provides classes that retrieve details about renewable assets to create renewal opportunities.
• RevSalesTrxn Namespace: The RevSalesTrxn namespace provides classes and methods to create a sales transaction, such as a quote or an order, with integrated pricing and configuration.
• RulesAppln Namespace: The RulesAppln namespace contains output classes that store details about a rules-based application of payments and credits.
• runtime_industries_cpq Namespace: The runtime_industries_cpq namespace provides classes and methods to search products or to manage products, catalogs, and categories.
• runtime_industries_insurance Namespace: The runtime_industries_insurance namespace provides options classes for insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance rating.
• setup_flow_performance Namespace: The class and methods in this namespace are for internal use only.
• Sfdc_Checkout Namespace: The Sfdc_Checkout namespace provides an interface and classes for B2B Commerce apps in Salesforce.
• Sfdc_Enablement Namespace: The sfdc_enablement namespace provides classes for creating custom learning items to implement custom exercise types in Enablement programs. Lightning web components are used to render the custom exercises on Program Builder.
• sfdc_surveys Namespace: The sfdc_surveys namespace provides an interface for shortening survey invitations.
• sfdw Namespace: Contains classes that describe Digital Wallet consumption card status and the alerts triggered when consumption crosses a threshold.
• sfsqlquery Namespace: Contains classes for executing SQL queries against Data 360 data spaces from Apex.
• Wave Namespace: The classes in the Wave namespace are part of the CRM Analytics Analytics SDK, designed to facilitate querying CRM Analytics data from Apex code.
• Action Class: You can use ApexPages.Action to create an action method that you can use in a Visualforce custom controller or controller extension.Creates a new instance of the ApexPages.Action class using the specified action.Returns the expression that is evaluated when the action is invoked.Invokes the action.
• Component Class: Represents a dynamic Visualforce component in Apex.Returns a reference to the child components for the component.Sets the content of an attribute using the expression language notation. The notation for this is expressions.name_of_attribute.Sets the content of a facet to a dynamic component. The notation is facet.name_of_facet.
• IdeaStandardController Class: IdeaStandardController objects offer Ideas-specific functionality in addition to what is provided by the StandardController. Returns the list of read-only comments from the current page.
• IdeaStandardSetController Class: IdeaStandardSetController objects offer Ideas-specific functionality in addition to what is provided by the StandardSetController. Returns the list of read-only ideas in the current page set.
• KnowledgeArticleVersionStandardController Class: KnowledgeArticleVersionStandardController objects offer article-specific functionality in addition to what is provided by the StandardController. Creates a new instance of the ApexPages.KnowledgeArticleVersionStandardController class using the specified knowledge article.Returns the ID for the source object record when creating a new article from another object.Specifies a default data category for the specified data category group when creating a new article.
• Message Class: Contains validation errors that occur when the user saves the page that uses a standard controller.Creates a new instance of the ApexPages.Message class using the specified message severity and summary.Creates a new instance of the ApexPages.Message class using the specified message severity, summary, and message detail.Creates a new instance of the ApexPages.Message class using the specified severity, summary, detail, and component ID.Returns the label of the associated inputField component. If no label is defined, this method returns null.Returns the value of the detail parameter used to create the message. If no detail String was specified, this method returns null.Returns the severity enum used to create the message. Returns the summary String used to create the message.
• SelectOption Class: A SelectOption object specifies one of the possible values for a Visualforce selectCheckboxes, selectList, or selectRadio component.Creates a new instance of the SelectOption class using the specified value and label.Creates a new instance of the SelectOption class using the specified value, label, and disabled setting.Returns the current value of the SelectOption object's isDisabled attribute.Returns the current value of the SelectOption object's itemEscaped attribute.Returns the option label that is displayed to the user.Returns the option value that is returned to the controller if a user selects the option.Sets the value of the SelectOption object's isDisabled attribute.Sets the value of the SelectOption object's itemEscaped attribute.Sets the value of the option label that is displayed to the user.Sets the value of the option value that is returned to the controller if a user selects the option.
• StandardController Class: Use a StandardController when defining an extension for a standard controller.Creates a new instance of the ApexPages.StandardController class for the specified standard or custom object.When a Visualforce page is loaded, the fields accessible to the page are based on the fields referenced in the Visualforce markup. This method adds a reference to each field specified in fieldNames so that the controller can explicitly access those fields as well.Returns the PageReference of the cancel page.Deletes record and returns the PageReference of the delete page.Returns the PageReference of the standard edit page.Returns the ID of the record that is currently in context, based on the value of the id query string parameter in the Visualforce page URL.Returns the record that is currently in context, based on the value of the id query string parameter in the Visualforce page URL. Forces the controller to reacquire access to newly referenced fields. Any changes made to the record prior to this method call are discarded. Saves changes and returns the updated PageReference.Returns the PageReference object of the standard detail page.
• StandardSetController Class: StandardSetController objects allow you to create list controllers similar to, or as extensions of, the pre-built Visualforce list controllers provided by Salesforce. Creates an instance of the ApexPages.StandardSetController class for the list of objects returned by the query locator.Creates an instance of the ApexPages.StandardSetController class for the specified list of standard or custom objects.Returns the PageReference of the original page, if known, or the home page.Changes the set of records that the controller returns to the first page of records.Indicates whether there are more records in the set than the maximum record limit. If this is false, there are more records than you can process using the list controller. The maximum record limit is 10,000 records.Returns the ID of the filter that is currently in context.Indicates whether there are more records after the current page set.Indicates whether there are more records before the current page set.Returns a list of the listviews available to the current user.Returns the page number of the current page set. Note that the first page returns 1.Returns the number of records included in each page set.Returns the sObject that represents the changes to the selected records. This retrieves the prototype object contained within the class, and is used for performing mass updates.Returns the list of sObjects in the current page set. This list is immutable, i.e. you can't call clear() on it.Returns the number of records in the set.Returns the list of sObjects that have been selected.Changes the set of records that the controller returns to the last page of records.Changes the set of records that the controller returns to the next page of records.Changes the set of records that the controller returns to the previous page of records.Inserts new records or updates existing records that have been changed. After this operation is finished, it returns a PageReference to the original page, if known, or the home page.Sets the filter ID of the controller.Sets the page number.Sets the number of records in each page set.Set the selected records to the records specified in the selectedRecords argument.
• Documentation Typographical Conventions: Apex and Visualforce documentation uses these typographical conventions.
• Apex Reference Guide: Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. This reference guide includes built-in Apex classes, interfaces, enums, and exceptions, grouped by namespace. It also includes Apex DML statements to insert, update, merge, delete, and restore data in Salesforce.
• Apex Release Notes: Use the Salesforce Release Notes to learn about the most recent updates and changes to Apex.
• Reserved Keywords: These words can be used only as keywords.
• Shipping Invoice Example
• Shipping Invoice Example Code
• Shipping Invoice Example Walk-Through
• UrlRewriter Interface: Enables rewriting Sites URLs.Maps a list of Salesforce URLs to a list of user-friendly URLs.Maps a user-friendly URL to a Salesforce URL.
• PageReference Class: A PageReference is a reference to an instantiation of a page. Among other attributes, PageReferences consist of a URL and a set of query parameter names and values.
• UninstallHandler Interface: Enables custom code to run after a managed package is uninstalled.Specifies the actions to be performed on uninstall.
• ConnectApi Enums: Enums specific to the ConnectApi namespace.
• ConnectApi Exceptions: The ConnectApi namespace contains exception classes.
• ConnectApi Utilities: The ConnectApi namespace contains a utility class.
• Interview Class: The Flow.Interview class provides advanced controller access to flows and the ability to start a flow.The following are instance methods for Interview.Creates an interview for a namespaced flow.Creates an interview for a flow.Returns the value of the specified flow variable. The flow variable can be in the flow embedded in the Visualforce page, or in a separate flow that is called by a subflow element.Starts an instance (interview) for an autolaunched or user provisioning flow.
• Apex Versioned Behavior Changes: This document includes major Apex behavior changes across API versions, organized by version number for easy lookup. It isn’t an exhaustive list of all versioned Apex behavior. For example, this compilation excludes versioned changes to Connect in Apex and classes in the ConnectApi namespace.