Actions Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introducing Actions
Action Objects
Apex Actions
Assign Enablement Program
Apply Case Classification Recommendations
B2B and D2C Commerce Actions
Commerce Checkout Flow Actions
Create Service Document Actions
Create Service Report Actions
Custom Notification Actions
Deploy Data Kit Components Action
Email Alert Actions
Einstein Bots Actions
Explore Conversation Actions
Flow Actions
Generate Order Summary Action
Generate Work Orders Actions
Get Assessment Response Summary
Get Data Graph Data By Lookup
Knowledge Actions
Lead Action
Live Message Notification Actions
Omni-Channel Action
Apply Payment Action
Payment Sale Action
Perform Survey Sentiment Analysis
PlatformAction
Post to Chatter Actions
Preview Cart to Exchange Order
Prompt Template Actions
Quick Actions
Refresh Metric Actions
Sales Engagement Actions
Salesforce Omnichannel Inventory Actions
Salesforce Order Management Actions
Send Conversation Messages Actions
Send Notification Actions
Session-Based Permission Set Actions
Simple Email Actions
Submit Exchange Order
Submit for Approval Actions
Survey Invitation Actions
Work Plan and Work Step Actions
PDF

PlatformAction

PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions.

Supported Calls

describeSObjects(), query()

Fields

Field Details
ActionListContext
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Required. The list context this action applies to. Valid values are:
  • Assistant
  • BannerPhoto
  • Chatter
  • Dockable
  • FeedElement
  • Flexipage
  • Global
  • ListView
  • ListViewDefinition
  • ListViewRecord
  • Lookup
  • MruList
  • MruRow
  • ObjectHomeChart
  • Photo
  • Record
  • RecordEdit
  • RelatedList
  • RelatedListRecord
ActionTarget
Type
textarea
Properties
Nillable
Description
The URL to invoke or describe the action when the action is invoked. If the action is a standard button overridden by a Visualforce page, the ActionTarget returns the URL of the Visualforce page, such as /apex/pagename.
This field is available in API version 35.0 and later.
ActionTargetType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The type of the target when this action is triggered. Valid values are:
  • Describe—applies to actions with a user interface, such as quick actions
  • Invoke—applies to actions with no user interface, such as action links or invocable actions
  • Visualforce—applies to standard buttons overridden by a Visualforce page
ActionTargetUrl
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL to invoke or describe the action when the action is invoked. This field is deprecated in API version 35.0 and later. Use ActionTarget instead.
Category
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Applies only to action links. Denotes whether the action link shows up in the feed item list of actions or the overflow list of actions. Valid values are:
  • Primary
  • Overflow
ConfirmationMessage
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Applies only to action links. The message to display before the action is invoked. Field is null if no confirmation is required before invoking the action.
DeviceFormat
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies which action icon the PlatformAction query returns. If this field isn’t specified, it defaults to Phone. Valid values are:
  • Aloha
  • Desktop
  • Phone
  • Tablet
ExternalId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The unique ID for the PlatformAction. If the action doesn’t have an ID, its API name is used.
GroupId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The unique ID of a group of action links.
IconContentType
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The content type—such as .jpg, .gif, or .png—of the icon for this action. Applies to both custom and standard icons assigned to actions.
IconHeight
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The height of the icon for this action. Applies only to standard icons.
IconUrl
Type
url
Properties
Filter, Group, Nillable, Sort
Description
The URL of the icon for this action.
IconWidth
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The width of the icon for this action. Applies only to standard icons.
InvocationStatus
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The status of the action within the feed item. Applies to action links only. Valid values are:
  • Failed
  • New
  • Pending
  • Successful
InvokedByUserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user who most recently invoked this action within the current feed item. Applies to action links only.
This is a relationship field.
Relationship Name
InvokedByUser
Relationship Type
Lookup
Refers To
User
IsGroupDefault
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Denotes whether this action is the default in an action link group. False for other action types. Applies to action links only.
IsMassAction
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the action can be performed on multiple records.

This field is available in API version 38.0 and later.
Label
Type
string
Properties
Filter, Group, Sort
Description
The label to display for this action.
PrimaryColor
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The primary color of the icon for this action.
RelatedListRecordId
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Represents the ID of a record in an object’s related list.

This field is available in API version 38.0 and later.
RelatedSourceEntity
Type
string
Properties
Filter, Group, Nillable, Sort
Description
When the ActionListContext is RelatedList or RelatedListRecord, this field represents the API name of the related list to which the action belongs.
Section
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The section of the user interface the action resides in. Applicable only to Lightning Experience. Valid values are:
  • ActivityComposer
  • CollaborateComposer
  • NotesComposer
  • Page
  • SingleActionLinks
This field is available in API version 35.0 and later.
SourceEntity
Type
string
Properties
Filter, Group, Sort
Description
Required. The object or record with which this action is associated.
Subtype
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The subtype of the action. For quick actions, the subtype is QuickActionType. For custom buttons, the subtype is WebLinkTypeEnum. For action links, subtypes are Api, ApiAsync, Download, and Ui. Standard buttons and productivity actions have no subtype.
TargetObject
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The type of object record the action creates, such as a contact or opportunity.

This field is available in API version 41.0 and later.
TargetUrl
Type
string
Properties
Filter, Nillable, Sort
Description
The URL that a custom button or link points to.

This field is available in API version 41.0 and later.
Type
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The type of the action. Valid values are:
  • ActionLink—An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce Chatter feed UI.
  • CustomButton—When clicked, opens a URL or a Visualforce page in a window or executes JavaScript.
  • InvocableAction
  • ProductivityAction—Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions.
  • QuickAction—A global or object-specific action.
  • StandardButton—A predefined Salesforce button such as New, Edit, and Delete.

Usage

PlatformAction can be described using describeSObject().

You can directly query for PlatformAction. For example, this query returns all fields for actions associated with each of the records of the listed objects:
SELECT ExternalId, ActionTargetType, ActionTargetUrl, ApiName, Category,
      ConfirmationMessage, ExternalId, GroupId, UiTheme, IconUrl, IconContentType, 
      IconHeight, IconWidth, PrimaryColor, InvocationStatus, InvokedByUserId, 
      IsGroupDefault, Label, LastModifiedDate, Subtype, SourceEntity, Type 
FROM PlatformAction 
WHERE SourceEntity IN ('001xx000003DGsH', '001xx000003DHBq', ‘Task’) AND 
      ActionListContext = ‘Record’;

To query PlatformAction, provide the ActionListContext and SourceEntity. If you query for ActionListContext with a value of RelatedList, and don't specify a RelatedSourceEntity, the query returns the API name of the related list. In API v43.0 and before, SourceEntity = 'Object API Name' and ActionListContext = 'ListView' is an invalid combination to fetch quick actions in a SOQL query. Use SourceEntity = 'Object ID' and ActionListContext = 'ListView' instead.

Note

This query uses multiple ActionListContext values in its WHERE clause to return all actions in the Lightning Experience user interface (DeviceFormat = 'Desktop') for the specified object:
SELECT ActionListContext, Label, Type, Subtype, Section, SourceEntity,
     RelatedSourceEntity, ActionTarget, ActionTargetType, ApiName, Category, 
     ConfirmationMessage, DeviceFormat, ExternalId, GroupId, IconContentType, 
     IconHeight, IconUrl, IconWidth, Id, InvocationStatus, InvokedByUserId, 
     IsGroupDefault, LastModifiedDate, PrimaryColor 
FROM PlatformAction 
WHERE ActionListContext IN ('Record','Chatter','RelatedList') AND 
      SourceEntity = '001xx000003DlvX' AND 
      DeviceFormat = 'Desktop'