Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace (Developer Preview)
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Functions Namespace
Invocable Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Support Namespace
System Namespace
AccessLevel Class (Beta)
AccessType Enum
Address Class
Answers Class
ApexPages Class
Approval Class
Assert Class
Blob Class
Boolean Class
BusinessHours Class
Callable Interface
Cases Class
Comparable Interface
Continuation Class
Cookie Class
Crypto Class
Custom Metadata Type Methods
Custom Settings Methods
Database Class
Date Class
Datetime Class
Decimal Class
Domain Class
DomainCreator Class
DomainParser Class
DomainType Enum
Double Class
EncodingUtil Class
Enum Methods
EventBus Class
Exception Class and Built-In Exceptions
FlexQueue Class
FeatureManagement Class
Formula Class
FormulaRecalcFieldError Class
FormulaRecalcResult Class
Http Class
HttpCalloutMock Interface
HttpRequest Class
HttpResponse Class
Id Class
Ideas Class
InstallHandler Interface
Integer Class
JSON Class
JSONGenerator Class
JSONParser Class
JSONToken Enum
Limits Class
List Class
Location Class
LoggingLevel Enum
Long Class
Map Class
Matcher Class
Math Class
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
OrgLimit Class
OrgLimits Class
PageReference Class
Packaging Class
Pattern Class
Queueable Interface
QueueableContext Interface
QuickAction Class
QuickAction Methods
Quiddity Enum
RemoteObjectController
Request Class
ResetPasswordResult Class
RestContext Class
RestRequest Class
RestResponse Class
SandboxPostCopy Interface
Schedulable Interface
SchedulableContext Interface
Schema Class
Search Class
Security Class
SelectOption Class
Set Class
Site Class
SObject Class
SObjectAccessDecision Class
StaticResourceCalloutMock Class
String Class
StubProvider Interface
System Class
Test Class
Time Class
TimeZone Class
Trigger Class
TriggerOperation Enum
Type Class
UninstallHandler Interface
URL Class
UserInfo Class
UserManagement Class
Version Class
WebServiceCallout Class
WebServiceMock Interface
XmlStreamReader Class
XmlStreamWriter Class
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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.

Namespace

System

Example

In this sample, the trigger determines if the new contacts to be inserted are created by a quick action. If so, it sets the WhereFrom__c custom field to a value that depends on whether the quick action is global or local to the contact. Otherwise, if the inserted contacts don’t originate from a quick action, the WhereFrom__c field is set to 'NoAction'.
1trigger accTrig2 on Contact (before insert) {
2    for (Contact c : Trigger.new) {
3        if (c.getQuickActionName() == QuickAction.CreateContact) {
4            c.WhereFrom__c = 'GlobaActionl';
5        } else if (c.getQuickActionName() == Schema.Account.QuickAction.CreateContact) {
6            c.WhereFrom__c = 'AccountAction';
7        } else if (c.getQuickActionName() == null) {
8            c.WhereFrom__c = 'NoAction';
9        } else {
10            System.assert(false);
11        }
12    }
13}
This sample performs a global action—QuickAction.CreateContact–on the passed-in contact object.
1public Id globalCreate(Contact c) { 
2    QuickAction.QuickActionRequest req = new QuickAction.QuickActionRequest();
3    req.quickActionName = QuickAction.CreateContact;
4    req.record = c;
5    QuickAction.QuickActionResult res = QuickAction.performQuickAction(req);
6    return c.id;
7}

QuickAction Methods

The following are methods for QuickAction. All methods are static.

describeAvailableQuickActions(parentType)

Returns metadata information for the available quick actions of the provided parent object.

Signature

public static List<QuickAction.DescribeAvailableQuickActionResult> describeAvailableQuickActions(String parentType)

Parameters

parentType
Type: String
The parent object type. This can be an object type name ('Account') or 'Global' (meaning that this method is called at a global level and not an entity level).

Return Value

Type: List<QuickAction.DescribeAvailableQuickActionResult>

The metadata information for the available quick actions of the parent object.

Example

1// Called for Account entity.
2List<QuickAction.DescribeAvailableQuickActionResult> result1 = 
3    QuickAction.DescribeAvailableQuickActions('Account');  
4
5// Called at global level, not entity level.
6List<QuickAction.DescribeAvailableQuickActionResult> result2 = 
7    QuickAction.DescribeAvailableQuickActions('Global');

describeAvailableQuickActions(sObjectNames)

Returns the metadata information for the provided quick actions.

Signature

public static List<QuickAction.DescribeQuickActionResult> describeAvailableQuickActions(List<String> sObjectNames)

Parameters

sObjectNames
Type: List<String>
The names of the quick actions. The quick action name can contain the entity name if it is at the entity level ('Account.QuickCreateContact'), or 'Global' if used for the action at the global level ('Global.CreateNewContact').

Return Value

Type: List<QuickAction.DescribeQuickActionResult>

The metadata information for the provided quick actions.

Example

1// First 3 parameter values are for actions at the entity level. 
2// Last parameter is for an action at the global level.
3List<QuickAction.DescribeQuickActionResult> result = 
4    QuickAction.DescribeQuickActions(new List<String> {
5        'Account.QuickCreateContact', 'Opportunity.Update1', 
6        'Contact.Create1', 'Global.CreateNewContact' });

performQuickAction(quickActionRequest)

Performs the quick action specified in the quick action request and returns the action result.

Signature

public static QuickAction.QuickActionResult performQuickAction(QuickAction.QuickActionRequest quickActionRequest)

Parameters

quickActionRequest
Type: QuickAction.QuickActionRequest

Return Value

Type: QuickAction.QuickActionResult

performQuickAction(quickActionRequest, allOrNothing)

Performs the quick action specified in the quick action request with the option for partial success, and returns the result.

Signature

public static QuickAction.QuickActionResult performQuickAction(QuickAction.QuickActionRequest quickActionRequest, Boolean allOrNothing)

Parameters

quickActionRequest
Type: QuickAction.QuickActionRequest
allOrNothing
Type: Boolean
Specifies whether this operation allows partial success. If you specify false for this argument and a record fails, the remainder of the DML operation can still succeed. This method returns a result object that can be used to verify which records succeeded, which failed, and why.

Return Value

Type: QuickAction.QuickActionResult

performQuickActions(quickActionRequests)

Performs the quick actions specified in the quick action request list and returns action results.

Signature

public static List<QuickAction.QuickActionResult> performQuickActions(List<QuickAction.QuickActionRequest> quickActionRequests)

Parameters

quickActionRequests
Type: List<QuickAction.QuickActionRequest>

Return Value

Type: List<QuickAction.QuickActionResult>

performQuickActions(quickActionRequests, allOrNothing)

Performs the quick actions specified in the quick action request list with the option for partial success, and returns action results.

Signature

public static List<QuickAction.QuickActionResult> performQuickActions(List<QuickAction.QuickActionRequest> quickActionRequests, Boolean allOrNothing)

Parameters

quickActionRequests
Type: List<QuickAction.QuickActionRequest>
allOrNothing
Type: Boolean
Specifies whether this operation allows partial success. If you specify false for this argument and a record fails, the remainder of the DML operation can still succeed. This method returns a result object that can be used to verify which records succeeded, which failed, and why.

Return Value

Type: List<QuickAction.QuickActionResult>