DescribeQuickActionResult

The describeQuickActions() call returns an array of DescribeQuickActionResult objects. Each DescribeQuickActionResult object represents a publisher quick action for a specified object.

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

Note

Name	Type	Description
canvasApplicationName	string	The name of your Force.com Canvas application, if you use it.
colors	DescribeColor[]	Array of color information. Each color is associated with a theme. This field is available in API version 29.0 and later.
defaultValues	DescribeQuickActionDefaultValue[]	The action’s default values.
height	int	The height in pixels of the action pane.
iconName	string	Name of icon used for the action. If a custom icon is not used, this value will not be set.
iconUrl	string	URL of 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.
icons	DescribeIcon[]	Array of icons. Each icon is associated with a theme. 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. This field is available in API version 29.0 and later.
label	string	Label of the action.
layout	DescribeLayoutSection	All the sections that comprise a layout.
miniIconUrl	string	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.
name	string	Name of the action.
contextSobjectType	string	The object used for the action. Named sourceSobjectType in version 29.0 and earlier.
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.
targetRecordTypeId	ID	The record type of the target record.
targetSobjectType	string	The action’s target object type.
type	string	`LogACall` `SocialPost` `Canvas` `Create` `VisualforcePage` `Update`
visualforcePageName	string	If Visualforce is used, the page name of the associated page for the action.
width	int	If a custom action is created, this is the width in pixels of the action pane.

DescribeQuickActionDefaultValue

Represents the default values of fields to use in default layouts.

Name	Type	Description
defaultValue	string	The value of the auto-populated default action.
field	string	The field name of the action.

DescribeLayoutSection

Represents a section of a DescribeLayout and consists of one or more columns and one or more rows (an array of DescribeLayoutRow).

Name	Type	Description
columns	int	Number of columns in this DescribeLayoutSection.
heading	string	Heading text (label) for this DescribeLayoutSection.
layoutRows	DescribeLayoutRow[]	Array of one or more DescribeLayoutRow objects.
rows	int	Number of rows in this DescribeLayoutSection.
useCollapsibleSection	boolean	Indicates whether this DescribeLayoutSection is a collapsible section, also known as a “twistie” (`true`), or not (`false`).
useHeading	boolean	Indicates whether to use the heading (`true`) or not (`false`).

DescribeLayoutRow

Represents a row in a DescribeLayoutSection. A DescribeLayoutRow consists of one or more DescribeLayoutItem objects. For each DescribeLayoutRow, a DescribeLayoutItem refers either to a specific field or to an “empty” DescribeLayoutItem (a DescribeLayoutItem that contains no DescribeLayoutComponent objects). An empty DescribeLayoutItem can be returned when a given DescribeLayoutRow is sparse (for example, containing more fields on the right column than on the left column). Where there are gaps in the layout, an empty DescribeLayoutItem is returned as a placeholder.

Name	Type	Description
layoutItems	DescribeLayoutItem[]	Refers to either a specific field or to an empty LayoutItem (a LayoutItem that contains no DescribeLayoutComponent objects).
numItems	int	Number of layoutItems. This information is redundant but, due to a bug in a popular SOAP toolkit, was required to avoid serialization problems.

DescribeLayoutItem

Represents an individual item in a DescribeLayoutRow. A DescribeLayoutItem consists of a set of components (DescribeLayoutComponent), each of which is either a field or a separator. For most fields on a layout, there is only one component per layout item. However, in a display-only view, the DescribeLayoutItem might be a composite of the individual fields (for example, an address can consist of street, city, state, country, and postal code data). On the corresponding edit view, each component of the address field would be split up into separate DescribeLayoutItems.

Name	Type	Description
editable	boolean	Indicates whether this DescribeLayoutItem can be edited (`true`) or not (`false`).
label	string	Label text for this DescribeLayoutItem.
layoutComponents	DescribeLayoutComponent[]	DescribeLayoutComponent for this DescribeLayoutItem.
placeholder	boolean	Indicates whether this DescribeLayoutItem is a placeholder (`true`) or not (`false`). If `true`, then this DescribeLayoutItem is blank.
required	boolean	Indicates whether this DescribeLayoutItem is required (`true`) or not (`false`). This is useful to know if, for example, you wanted to render required fields in a contrasting color (such as red).

DescribeLayoutComponent

Represents the smallest unit in a layout—a field or a separator. To reference a field for display, a client application uses the following notation to reference a field in the describeSObjects() call: LayoutComponent.fieldName.

Name	Type	Description
displayLines	int	The number of vertical lines displayed for a field. Applies to `textarea` and multi-select picklist fields.
tabOrder	int	Indicates the tab order for the item in the row.
type	LayoutComponentType	The LayoutComponentType for this LayoutComponent.
value	string	Value of this LayoutComponent. The name of the field if the LayoutComponentType value is `Field`.

LayoutComponentType

Represents the type for a DescribeLayoutComponent.Contains one of these values:

EmptySpace—A blank space on the page layout.
ExpandedLookup—An Expanded Lookup component in the Mobile Cards section of the page layout.
Field—Field name. A mapping to the name field on the describeSObjectResult.
ReportChart
SControl—Reserved for future use.
Separator—Separator character, such as a semicolon (:) or slash (/).
VisualforcePage—A Visualforce component on the page layout.

SOAP API Developer's Guide

No Results