Action Class

Contains methods to create, update, and retrieve information about invocable actions.

Namespace

Usage

The getDescribe() method returns detailed metadata about an invocable action, including its inputs, outputs, and configuration. Because this method retrieves comprehensive describe information, it can have performance implications. Use getDescribe() judiciously, especially in performance-sensitive contexts such as loops or frequently executed code paths.

When calling createStandardAction() or createCustomAction(), the version parameter is optional. If you don't specify a version, the base version of the action is used.

Example

1// Create an action and get its metadata
2Invocable.Action action = Invocable.Action.createStandardAction('someActionName');
3List<Invocable.Action.DescribeResult> describeResults = action.getDescribe();
4
5for (Invocable.Action.DescribeResult dr : describeResults) {
6    System.debug('Action Name: ' + dr.getName());
7    System.debug('Action Label: ' + dr.getLabel());
8    System.debug('Description: ' + dr.getDescription());
9    System.debug('Has Callout: ' + dr.getHasCallout());
10
11    // Access input parameters
12    if (dr.getInputs() != null) {
13        for (Invocable.Action.InputParameter input : dr.getInputs()) {
14            System.debug('Input: ' + input.getName() + ' (' + input.getType() + ')');
15            System.debug('Required: ' + input.getRequired());
16            System.debug('Description: ' + input.getDescription());
17        }
18    }
19
20    // Access output parameters
21    if (dr.getOutputs() != null) {
22        for (Invocable.Action.OutputParameter output : dr.getOutputs()) {
23            System.debug('Output: ' + output.getName() + ' (' + output.getType() + ')');
24        }
25    }
26}
27

Action Methods

These methods are for Action.

addInvocation()

Creates an empty invocation in preparation for calling an invocable action. After you create the invocation, you can add parameters to the invocation.

Signature

public Invocable.Action addInvocation()

Return Value

Type: Invocable.Action

clearInvocations()

Clears the existing invocations from the action.

Signature

public Invocable.Action clearInvocations()

Return Value

Type: Invocable.Action

clone()

Creates a copy of the Invocable.Action.

Signature

public Object clone()

Return Value

Type: Object

createCustomAction(type, namespace, name, version)

Creates a wrapper for the specified version of a custom invocable action in a specified package namespace.

Signature

public static Invocable.Action createCustomAction(String type, String namespace, String name)

Parameters

type: Type: String; Type of invocable action.
namespace: Type: String; Namespace where the invocable action is located.
name: Type: String; Name for the custom invocable action.
version: Type: String; Version of the invocable action.

Return Value

Type: Invocable.Action

createCustomAction(type, namespace, name)

Creates a wrapper for a custom invocable action in a specified package namespace.

Signature

public static Invocable.Action createCustomAction(String type, String namespace, String name)

Parameters

type: Type: String; Type of invocable action.
namespace: Type: String; Namespace where the invocable action is located.
name: Type: String; Name for the custom invocable action.

Return Value

Type: Invocable.Action

createCustomAction(type, name)

Creates a wrapper for a custom invocable action.

Signature

public static Invocable.Action createCustomAction(String type, String name)

Parameters

type: Type: String; Type of invocable action.
name: Type: String; Name for the custom invocable action.

Return Value

Type: Invocable.Action

createStandardAction(type, version)

Creates a wrapper for a standard invocable action.

Signature

public static Invocable.Action createStandardAction(String type)

Parameters

type: Type: String; Type of invocable action.
version: Type: String; Version of the invocable action.

Return Value

Type: Invocable.Action

createStandardAction(type)

Creates a wrapper for a standard invocable action.

Signature

public static Invocable.Action createStandardAction(String type)

Parameters

type: Type: String; Type of invocable action.

Return Value

Type: Invocable.Action

getDescribe()

Gets metadata related to an invocable action.

Signature

public List<Invocable.Action.DescribeResult> getDescribe()

Return Value

Type: List<Invocable.Action.DescribeResult>

getName()

Gets the name of an invocable action.

Signature

public String getName()

Return Value

Type: String

Name of the invocable action.

getNamespace()

Gets the namespace of a custom invocable action.

Signature

public String getNamespace()

Return Value

Type: String

Namespace of the custom invocable action.

getType()

Gets the type of an invocable action.

Signature

public String getType()

Return Value

Type: String

Type of invocable action.

getVersion()

Gets the version of an invocable action.

Signature

public String getVersion()

Return Value

Type: String

Version of the invocable action.

invoke()

Invokes an invocable action from Apex code.

Signature

public List<Invocable.Action.Result> invoke()

Return Value

Type: List<Invocable.Action.Result>

isStandard()

Determines whether an invocable action is a standard invocable action.

Signature

public Boolean isStandard()

Return Value

Type: Boolean

This method returns true if the invocable action is a standard invocable action.

setInvocationParameter(parameterName, parameterValue)

Sets a value for an invocable action parameter.

Signature

public Invocable.Action setInvocationParameter(String parameterName, Object parameterValue)

Parameters

parameterName: Type: String; Name of the invocable action parameter to set.
parameterValue: Type: Object; Value to set the invocable action parameter to.

Return Value

Type: Invocable.Action

setInvocations(invocations)

Initializes the invocations for an action from a pre-existing list of invocations.

Signature

public Invocable.Action setInvocations(List<Map<String,ANY>> invocations)

Parameters

invocations: Type: List<Map<String,ANY>>; List of invocations for the invocable action.

Return Value

Type: Invocable.Action

Apex Reference Guide

Action Class

Namespace

Usage

Example

See Also

Action Methods

addInvocation()

Signature

Return Value

clearInvocations()

Signature

Return Value

clone()

Signature

Return Value

createCustomAction(type, namespace, name, version)

Signature

Parameters

Return Value

createCustomAction(type, namespace, name)

Signature

Parameters

Return Value

createCustomAction(type, name)

Signature

Parameters

Return Value

createStandardAction(type, version)

Signature

Parameters

Return Value

createStandardAction(type)

Signature

Parameters

Return Value

getDescribe()

Signature

Return Value

getName()

Signature

Return Value

getNamespace()

Signature

Return Value

getType()

Signature

Return Value

getVersion()

Signature

Return Value

invoke()

Signature

Return Value

isStandard()

Signature

Return Value

setInvocationParameter(parameterName, parameterValue)

Signature

Parameters

Return Value

setInvocations(invocations)

Signature

Parameters

Return Value