Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace (Developer Preview)
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace (Beta)
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
DescribeAvailableQuickActionResult Class
DescribeLayoutComponent Class
DescribeLayoutItem Class
DescribeLayoutRow Class
DescribeLayoutSection Class
DescribeQuickActionDefaultValue Class
DescribeQuickActionResult Class
DescribeQuickActionResult Properties
DescribeQuickActionResult Methods
QuickActionDefaults Class
QuickActionDefaultsHandler Interface
QuickActionRequest Class
QuickActionResult Class
SendEmailQuickActionDefaults Class
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
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

DescribeQuickActionResult Class

Contains describe metadata information for a quick action.

Namespace

QuickAction

Usage

The QuickAction describeQuickActions method returns an array of quick action describe result objects (QuickAction.DescribeQuickActionResult).

DescribeQuickActionResult Properties

The following are properties for DescribeQuickActionResult.

canvasapplicationname

The name of the Canvas application invoked by the custom action.

Signature

public String canvasapplicationname {get; set;}

Property Value

Type: String

colors

Array of color information. Each color is associated with a theme.

Signature

public List<Schema.DescribeColorResult> colors {get; set;}

Property Value

Type: List<Schema.DescribeColorResult>

contextsobjecttype

The object used for the action. Was getsourceSobjectType() in API version 29.0 and earlier.

Signature

public String contextsobjecttype {get; set;}

Property Value

Type: String

defaultvalues

The action’s default values.

Signature

public List<QuickAction.DescribeQuickActionDefaultValue> defaultvalues {get; set;}

Property Value

Type: List<QuickAction.DescribeQuickActionDefaultValue>

flowdevname

If the custom action invokes a flow, the fully qualified name of the flow.

Signature

public String flowdevname {get; set;}

Property Value

Type: String

flowrecordidvar

If the custom action invokes a flow, the input variable that the custom action passes the record’s ID to.

Signature

public String flowrecordidvar {get; set;}

Property Value

Type: String

Valid values are null or recordId.

height

The height in pixels of the action pane.

Signature

public Integer height {get; set;}

Property Value

Type: Integer

iconname

The name of the icon used for the action. If a custom icon is not used, this value isn’t set.

Signature

public String iconname {get; set;}

Property Value

Type: String

icons

Array of icons. Each icon is associated with a theme.

Signature

public List<Schema.DescribeIconResult> icons {get; set;}

Property Value

Type: List<Schema.DescribeIconResult>

If no custom icon was associated with the quick action and the quick action creates a specific object, the icons will correspond to the icons used for the created object. For example, if the quick action creates an Account, the icon array will contain the icons used for Account.

If a custom icon was associated with the quick action, the array will contain that custom icon.

iconurl

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.

Signature

public String iconurl {get; set;}

Property Value

Type: String

layout

The section of the layout where the action resides.

Signature

public QuickAction.DescribeLayoutSection layout {get; set;}

Property Value

Type: QuickAction.DescribeLayoutSection

lightningcomponentbundleid

If the custom action invokes an Aura component, the ID of the Aura component bundle to which the component belongs.

Signature

public String lightningcomponentbundleid {get; set;}

Property Value

Type: String

lightningcomponentbundlename

If the custom action invokes an Aura component, the name of the Aura component bundle to which the component belongs.

Signature

public String lightningcomponentbundlename {get; set;}

Property Value

Type: String

lightningcomponentqualifiedname

The fully qualified name of the Aura component invoked by the custom action.

Signature

public String lightningcomponentqualifiedname {get; set;}

Property Value

Type: String

lightningwebcomponentbundleid

If the custom action invokes a Lightning web component, the ID of the Lightning web component bundle to which the component belongs.

Signature

public String lightningwebcomponentbundleid {get; set;}

Property Value

Type: String

lightningwebcomponentbundlename

If the custom action invokes a Lightning web component, the name of the Lightning web component bundle to which the component belongs.

Signature

public String lightningwebcomponentbundlename {get; set;}

Property Value

Type: String

lightningwebcomponentqualifiedname

The fully qualified name of the Lightning web component invoked by the custom action.

Signature

public String lightningwebcomponentqualifiedname {get; set;}

Property Value

Type: String

miniiconurl

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.

Signature

public String miniiconurl {get; set;}

Property Value

Type: String

showquickactionlcheader

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.

Signature

public Boolean showquickactionlcheader {get; set;}

Property Value

Type: Boolean

showquickactionvfheader

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.

Signature

public Boolean showquickactionvfheader {get; set;}

Property Value

Type: Boolean

targetparentfield

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.

Signature

public String targetparentfield {get; set;}

Property Value

Type: String

targetrecordtypeid

The record type of the target record.

Signature

public String targetrecordtypeid {get; set;}

Property Value

Type: String

targetsobjecttype

The action’s target object type.

Signature

public String targetsobjecttype {get; set;}

Property Value

Type: String

visualforcepagename

The name of the Visualforce page associated with the custom action.

Signature

public String visualforcepagename {get; set;}

Property Value

Type: String

visualforcepageurl

The URL of the Visualforce page associated with the action.

Signature

public String visualforcepageurl {get; set;}

Property Value

Type: String

width

The width in pixels of the action pane, for custom actions that call Visualforce pages, Canvas apps, or Lightning components.

Signature

public Integer width {get; set;}

Property Value

Type: Integer

DescribeQuickActionResult Methods

The following are methods for DescribeQuickActionResult. All are instance methods.

getActionEnumOrId()

Returns the unique ID for the action. If the action doesn’t have an ID, its API name is used.

Signature

public String getActionEnumOrId()

Return Value

Type: String

getCanvasApplicationName()

Returns the name of the Canvas application, if used.

Syntax

public String getCanvasApplicationName()

Return Value

Type: String

getColors()

Returns an array of color information. Each color is associated with a theme.

Signature

public List<Schema.DescribeColorResult> getColors()

Return Value

Type: List <Schema.DescribeColorResult>

getContextSobjectType()

Returns the object used for the action. Replaces getsourceSobjectType() in API version 30.0 and later.

Signature

public String getContextSobjectType()

Return Value

Type: String

getDefaultValues()

Returns the default values for a action.

Signature

public List<QuickAction.DescribeQuickActionDefaultValue> getDefaultValues()

Return Value

Type: List<QuickAction.DescribeQuickActionDefaultValue>

getFlowDevName()

If the custom action invokes a flow, returns the fully qualified name of the flow invoked by the custom action.

Signature

public String getFlowDevName()

Return Value

Type: String

getFlowRecordIdVar()

If the custom action invokes a flow, returns the input variable that the custom action passes the record’s ID to.

Signature

public String getFlowRecordIdVar()

Return Value

Type: String

getHeight()

Returns the height in pixels of the action pane.

Signature

public Integer getHeight()

Return Value

Type: Integer

getIconName()

Returns the actions’ icon name.

Signature

public String getIconName()

Return Value

Type: String

getIconUrl()

Returns the URL of the 32x32 icon used for the action.

Signature

public String getIconUrl()

Return Value

Type: String

getIcons()

Returns a list of Schema.DescribeIconResult objects that describe colors used in a tab.

Signature

public List<Schema.DescribeIconResult> getIcons()

Return Value

Type: List<Schema.DescribeIconResult>

getLabel()

Returns the action label.

Signature

public String getLabel()

Return Value

Type: String

getLayout()

Returns the layout sections that comprise an action.

Signature

public QuickAction.DescribeLayoutSection getLayout()

Return Value

Type: QuickAction.DescribeLayoutSection

getLightningComponentBundleId()

If the custom action invokes an Aura component, returns the ID of the Aura component bundle to which the component belongs.

Signature

public String getLightningComponentBundleId()

Return Value

Type: String

getLightningComponentBundleName()

If the custom action invokes an Aura component, returns the name of the Aura component bundle to which the component belongs.

Signature

public String getLightningComponentBundleName()

Return Value

Type: String

getLightningComponentQualifiedName()

If the custom action invokes an Aura component, returns the fully qualified name of the Aura component invoked by the custom action.

Signature

public String getLightningComponentQualifiedName()

Return Value

Type: String

getLightningWebComponentBundleId()

If the custom action invokes a Lightning web component, returns the ID of the Lightning web component bundle to which the component belongs.

Signature

public String getLightningWebComponentBundleId()

Return Value

Type: String

getLightningWebComponentBundleName()

If the custom action invokes a Lightning web component, returns the name of the Lightning web component bundle to which the component belongs.

Signature

public String getLightningWebComponentBundleName()

Return Value

Type: String

getLightningWebComponentQualifiedName()

If the custom action invokes a Lightning web component, returns the fully qualified name of the Lightning web component invoked by the custom action.

Signature

public String getLightningWebComponentQualifiedName()

Return Value

Type: String

getMiniIconUrl()

Returns the 16x16 icon URL.

Signature

public String getMiniIconUrl()

Return Value

Type: String

getName()

Returns the action name.

Signature

public String getName()

Return Value

Type: String

getShowQuickActionLcHeader()

Returns an indication of whether the Lightning component quick action header and footer are shown.

Signature

public Boolean getShowQuickActionLcHeader()

Return Value

Type: Boolean

If false, then both the header containing the quick action title and the footer containing the Save and Cancel buttons aren’t displayed.

getShowQuickActionVfHeader()

Returns an indication of whether the Visualforce quick action header and footer should be shown.

Signature

public Boolean getShowQuickActionVfHeader()

Return Value

Type: Boolean

If false, then both the header containing the quick action title and the footer containing the Save and Cancel buttons aren’t displayed.

getSourceSobjectType()

Returns the object type used for the action.

Signature

public String getSourceSobjectType()

Return Value

Type: String

getTargetParentField()

Returns the parent object’s type for the action.

Signature

public String getTargetParentField()

Return Value

Type: String

getTargetRecordTypeId()

Returns the record type of the targeted record.

Signature

public String getTargetRecordTypeId()

Return Value

Type: String

getTargetSobjectType()

Returns the action’s target object type.

Signature

public String getTargetSobjectType()

Return Value

Type: String

getType()

Returns a create or custom Visualforce action.

Signature

public String getType()

Return Value

Type: String

getVisualforcePageName()

If Visualforce is used, returns the name of the associated page for the action.

Signature

public String getVisualforcePageName()

Return Value

Type: String

getVisualforcePageUrl()

Returns the URL of the Visualforce page associated with the action.

Signature

public String getVisualforcePageUrl()

Return Value

Type: String

getWidth()

If a custom action is created, returns the width in pixels of the action pane.

Signature

public Integer getWidth()

Return Value

Type: Integer