Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

QuickAction

Represents a specified create or update action for an object that then becomes available in the Chatter publisher. For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. QuickAction can be created on objects that allow custom fields. The parent objects supported include:
  • Account
  • Campaign
  • Case
  • Contact
  • Custom objects
  • Group
  • Lead
  • Opportunity

In the application, QuickActions are referred to as actions or publisher actions.

Note

File Suffix and Directory Location

QuickAction components have the suffix quickAction and are stored in the quickActions folder.

Version

QuickAction components are available in API version 28.0 and later.

Fields

Field Name Field Type Description
canvas string If a custom action is created using a canvas app, this identifies the app. Returns the fully-qualified name of the canvas app in the format <namespace>__<dev_name>, if the quick action type is Canvas; otherwise, returns null. This field is available in API version 29.0 and later.
description string The description of the action.
fieldOverrides FieldOverride The specific field that may be overridden within a QuickAction.
height int If a custom action is created, this is the height in pixels of the action pane.
icon string The icon used to identify the action.

API version 32.0 and later returns different icons than in earlier API versions.
isProtected boolean Indicates whether this component is protected (true) or not (false). Protected components cannot be linked to or referenced by components created in the installing organization.
label string Identifies the action and displays to users. This is also the default identifier used for the API and managed packages.
page string If a custom action is created using a Visualforce page, this identifies the page.
quickActionLayout QuickActionLayout The layout of fields on the action.
standardLabel QuickActionLabel (enumeration of type string) Specifies the standard label to use for the action. The valid values are:
  • LogACall
  • LogANote
  • New (A new record)
  • NewRecordType (For example, a label with something like “New Idea”)
  • Update
  • UpdateRecordType
  • NewChild (A new child record)
  • NewChildRecordType
  • CreateNew
  • CreateNewRecordType (For example, a label with something like “Create New Idea”)
  • SendEmail (This value is available in API version 31.0 and later.)
  • QuickRecordType
  • Quick (A quick record)
targetObject string The object for which the action is created and performed.

For example, you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter feed on that page. In this case, Contact is the targetObject.

targetParentField string The parent object type of the action. Links the target object to the parent object. For example, use Account if the target object is Contact and the parent object is Account.
targetRecordType string Specifies which record type to create. Valid values are:
  • Business Account
  • Person Account
  • Master
type QuickActionType (enumeration of type string) The type of quick action. Valid values are:
  • Create
  • VisualforcePage
  • Post
  • SendEmail (This value is available in API version 31.0 and later.)
  • LogACall
  • SocialPost
  • Canvas
  • Update
width int If a custom action is created, this is the width in pixels of the action pane.

FieldOverride

Represents the field names and their respective formulas and literal values that comprise overrides in a QuickAction.

Field Name Field Type Description
field string The name of the specific field to allow overrides on.
formula string Specifies the formula to use when overriding a field.
literalValue string The value of the field without overrides.

QuickActionLayout

The layout of fields on the action. There is no hard limit to the number of fields you can add to an action layout. However, for optimum usability, we recommend a maximum of eight fields. Adding more than 20 fields can severely impact user efficiency.

Field Name Field Type Description
layoutSectionStyle LayoutSectionStyle (enumeration of type string) The type of layout structure used. The valid values are:
  • TwoColumnsTopToBottom
  • TwoColumnsLeftToRight
  • OneColumn
  • CustomLinks
quickActionLayoutColumns QuickActionLayoutColumn[] Specifies columns in a QuickActionLayout.

QuickActionLayoutColumn

A column defined for a QuickActionLayout.

Field Name Field Type Description
quickActionLayoutItems QuickActionLayoutItem [] Specifies row items in a QuickActionLayoutColumn.

QuickActionLayoutItem

A row item comprised of fields and defined for a QuickActionLayoutColumn.

Field Name Field Type Description
emptySpace boolean Controls if this layout item is a blank space (true) or not (false).
field string Represents a specific field in QuickActionLayoutItem. There is no hard limit to the number of fields you can add to an action layout. However, for optimum usability, we recommend a maximum of eight fields. Adding more than 20 fields can severely impact user efficiency.
uiBehavior UiBehavior (enumeration of type string) Specifies user input behavior for specific fields in QuickActionLayoutItem. The valid values are:
  • Edit
  • Required
  • Readonly

Declarative Metadata Sample Definition

The following is an example of a QuickAction component:

1<?xml version="1.0" encoding="UTF-8"?>
2<QuickAction xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>testActionDefinitionTypesCreate</description>
4    <fieldOverrides>
5        <field>DoNotCall</field>
6        <formula>TRUE</formula>
7    </fieldOverrides>
8    <fieldOverrides>
9        <field>LeadSource</field>
10        <literalValue>Partner</literalValue>
11    </fieldOverrides>
12    <label>testActionDefinitionTypesCreate</label>
13    <quickActionLayout>
14        <layoutSectionStyle>TwoColumnsLeftToRight</layoutSectionStyle>
15        <quickActionLayoutColumns>
16            <quickActionLayoutItems>
17                <emptySpace>false</emptySpace>
18                <field>HomePhone</field>
19                <uiBehavior>Required</uiBehavior>
20            </quickActionLayoutItems>
21            <quickActionLayoutItems>
22                <emptySpace>true</emptySpace>
23                <uiBehavior>Edit</uiBehavior>
24            </quickActionLayoutItems>
25            <quickActionLayoutItems>
26                <emptySpace>false</emptySpace>
27                <field>Name</field>
28                <uiBehavior>Required</uiBehavior>
29            </quickActionLayoutItems>
30            <quickActionLayoutItems>
31                <emptySpace>false</emptySpace>
32                <field>AccountId</field>
33                <uiBehavior>Edit</uiBehavior>
34            </quickActionLayoutItems>
35        </quickActionLayoutColumns>
36        <quickActionLayoutColumns>
37            <quickActionLayoutItems>
38                <emptySpace>false</emptySpace>
39                <field>Description</field>
40                <uiBehavior>Edit</uiBehavior>
41            </quickActionLayoutItems>
42        </quickActionLayoutColumns>
43    </quickActionLayout>
44    <targetObject>Contact</targetObject>
45    <targetParentField>Account</targetParentField>
46    <type>Create</type>
47</QuickAction>