Salesforce Docs Portal

Action.DescribeResult Class

Contains methods to get metadata about invocable actions.

Namespace

Invocable

Example

Invocable.Action action = Invocable.Action.createStandardAction('otherActionName');
List<Invocable.Action.DescribeResult> results = action.getDescribe();

for (Invocable.Action.DescribeResult result : results) {
    for (Invocable.Action.InputParameter input : result.getInputs()) {
        List<Invocable.Action.AdditionalAttribute> attrs = input.getAdditionalAttributes();
        if (attrs != null) {
            for (Invocable.Action.AdditionalAttribute attr : attrs) {
                System.debug('Attribute: ' + attr.getName());
                System.debug('Data Type: ' + attr.getDataType());

                // Handle collection vs single value
                if (attr.getIsCollection()) {
                    if (attr.getDataType() == 'STRING') {
                        List<String> stringValues = attr.getValueAsStringList();
                        System.debug('String Values: ' + stringValues);
                    }
                } else {
                    System.debug('Value: ' + attr.getValue());
                }
            }
        }
    }
}

Action.DescribeResult Methods

The following are methods for Action.DescribeResult.

getAction()

Gets the invocable action that was invoked and caused a result to be returned.

Signature

public Invocable.Action getAction()

Return Value

Type: Invocable.Action

getAllowsTransactionControl()

Indicates whether the invocable action allows transaction control.

Signature

public Boolean getAllowsTransactionControl()

Return Value

Type: Boolean

This method returns true if the invocable action allows transaction control.

getCapabilityTypes()

Gets the capability types supported by an invocable action.

Signature

public List<String> getCapabilityTypes()

Return Value

Type: List<String>

List of capability type identifiers of the invocable action.

getCategory()

Gets the category of an invocable action.

Signature

public String getCategory()

Return Value

Type: String

Category of the invocable action.

getConfigurationEditor()

Gets the type of an invocable action.

Signature

public String getConfigurationEditor()

Return Value

Type: String

Configuration editor identifier of the invocable action.

getDescription()

Gets the description of an invocable action.

Signature

public String getDescription()

Return Value

Type: String

Description of the invocable action.

getGenericTypes()

Gets a list of the generic types defined for an invocable action.

Signature

public List<Invocable.Action.GenericType> getGenericTypes()

Return Value

Type: List<Invocable.Action.GenericType>

getHasCallout()

Indicates whether an invocable action makes external callouts.

Signature

public Boolean getHasCallout()

Return Value

Type: Boolean

This method returns true if the invocable action makes external callouts.

getHasSystemGeneratedOutput()

Indicates whether an invocable action is a standard invocable action.

Signature

public Boolean getHasSystemGeneratedOutput()

Return Value

Type: Boolean

This method returns true if the invocable action has system-generated output.

getIconId()

Gets the icon ID for an invocable action.

Signature

public String getIconId()

Return Value

Type: String

Icon ID of the invocable action.

getIconName()

Gets the icon name for an invocable action.

Signature

public String getIconName()

Return Value

Type: String

Icon name for the invocable action.

getInputs()

Gets a list of input parameters for an invocable action.

Signature

public List<Invocable.Action.InputParameter> getInputs()

Return Value

Type: List<Invocable.Action.InputParameter>

getLabel()

Gets the type of an invocable action.

Signature

public String getLabel()

Return Value

Type: String

Label of the invocable action.

getMethodDescription()

Gets the description of an invocable action method.

Signature

public String getMethodDescription()

Return Value

Type: String

Describe of the invocable action method.

getMethodLabel()

Gets the label of an invocable action method.

Signature

public String getMethodLabel()

Return Value

Type: String

Label of the invocable action method.

getMethodName()

Gets the name of an invocable action method.

Signature

public String getMethodName()

Return Value

Type: String

Name of the invocable action method.

getName()

Gets the name of an invocable action.

Signature

public String getName()

Return Value

Type: String

Name of the invocable action.

getOutputs()

Gets a list of output parameters for an invocable action.

Signature

public List<Invocable.Action.OutputParameter> getOutputs()

Return Value

Type: List<Invocable.Action.OutputParameter>

getTargetEntityName()

Gets the target entity name for an invocable action.

Signature

public String getTargetEntityName()

Return Value

Type: String

Target entity name of the invocable action.

getType()

Gets the type of an invocable action.

Signature

public String getType()

Return Value

Type: String

Type of the invocable action.