Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
Action Class
Action Methods
Action.Error Class
Action.Result Class
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Action Class

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

Namespace

Invocable

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

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