Force.com Apex Code 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

DescribeQuickActionResult Class

Contains describe metadata information for a publisher quick action.

Namespace

QuickAction

Usage

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

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

Note

DescribeQuickActionResult Methods

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

getCanvasApplicationName()

Returns the name of the Canvas application, if used.

Syntax

public String getCanvasApplicationName()

Return Value

Type: String

getDefaultValues()

Returns the default values for a action.

Signature

public List<QuickAction.DescribeQuickActionDefaultValue> getDefaultValues()

Return Value

Type: List<QuickAction.DescribeQuickActionDefaultValue>

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

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

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

getWidth()

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

Signature

public Integer getWidth()

Return Value

Type: Integer