describeAvailableQuickActions()

In API version 28.0, describes details about actions available for a specified parent. In API version 29.0 and greater, describes details about actions available for a specified context.

Syntax

DescribeAvailableQuickActionResult [] = connection.describeAvailableQuickActions(string parentOrContextType );

Usage

Use describeAvailableQuickActions() to get the list of actions whose parent (API version 28.0) or context (API version 29.0 and greater) entity name is supplied as well as standard and global actions. The describeAvailableQuickActions() call uses the parent entity name, such as “Account”, or “null” for global actions, or in API version 29.0 and greater, the context, to return an array of DescribeAvailableQuickActionResult.

Sample—Java

This sample retrieves and displays the available action information for the Account object.

public void example() throws Exception {
    DescribeAvailableQuickActionResult[] aResult = 
        conn.describeAvailableQuickActions("Account");
    for(DescribeAvailableQuickActionResult ar : aResult) { 
        System.out.println("Action label: " + ar.getLabel());
        System.out.println("Action name: " + ar.getName());
        System.out.println("Action type: " + ar.getType());
    }
}

Arguments

Response

An array of DescribeAvailableQuickActionResult objects.

Faults

connection.exception errors