Publisher and Quick Action Developer Guide

Get Started
How are the APIs Different?
Work with the APIs
Quick Action API
Considerations
getAvailableActions
getAvailableActionFields
getCustomAction
getSelectedActions
invokeAction
refresh
selectAction
setActionFieldValues
Publisher API
Customize with Visualforce
Other Resources
PDF

Newer Version Available

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

Quick Action APIs in Lightning Experience

A lightning:quickActionAPI component allows you to access methods for programmatically controlling quick actions on record pages. This component is supported in Lightning Experience and supports utility pop-out. This component requires API version 43.0 and later.
Available in: Lightning Experience
Available in: Group, Professional, Enterprise, Performance, Unlimited, and Developer Editions

For example, if you have a custom Aura component that displays Knowledge articles, you can use the lightning:quickActionAPI component to attach and send a Knowledge article from your custom component using the Email quick action on the case record page.

To access these methods, create an instance of the lightning:quickActionAPI component inside your Aura component or page and assign an aura:id attribute to it.

This component provides similar functionality to the Publisher APIs in Salesforce Classic.

Sample Code

This example creates two buttons that interact with the Update Case quick action on a case record page in Lightning Experience. The controller code uses the following Quick Action API methods: selectAction, setActionFieldValues, and invokeAction.

Component code:

Controller code: