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.AdditionalAttribute Class
Action.DescribeResult Class
Action.Error Class
Action.GenericType Class
Action.InputParameter Class
Action.InputParameter Methods
Action.OutputParameter Class
Action.PicklistValue 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

Action.InputParameter Class

Contains methods to get metadata about input parameters for invocable actions.

Namespace

Invocable

Example

1Invocable.Action action = Invocable.Action.createStandardAction('otherActionName');
2List<Invocable.Action.DescribeResult> results = action.getDescribe();
3
4for (Invocable.Action.DescribeResult result : results) {
5    for (Invocable.Action.InputParameter input : result.getInputs()) {
6        List<Invocable.Action.AdditionalAttribute> attrs = input.getAdditionalAttributes();
7        if (attrs != null) {
8            for (Invocable.Action.AdditionalAttribute attr : attrs) {
9                System.debug('Attribute: ' + attr.getName());
10                System.debug('Data Type: ' + attr.getDataType());
11
12                // Handle collection vs single value
13                if (attr.getIsCollection()) {
14                    if (attr.getDataType() == 'STRING') {
15                        List<String> stringValues = attr.getValueAsStringList();
16                        System.debug('String Values: ' + stringValues);
17                    }
18                } else {
19                    System.debug('Value: ' + attr.getValue());
20                }
21            }
22        }
23    }
24}
25

Action.InputParameter Methods

The following are methods for Action.InputParameter.

getAdditionalAttributes()

Gets a list of additional attributes for an invocable action input parameter.

Signature

public List<Invocable.Action.AdditionalAttribute> getAdditionalAttributes()

Return Value

Type: List<Invocable.Action.AdditionalAttribute>

getApexClass()

Gets the Apex class name of an input parameter for an invocable action.

Signature

public String getApexClass()

Return Value

Type: String

Apex class name of the input parameter of the invocable action.

getByteLength()

Gets the maximum byte length of an input parameter of an invocable action.

Signature

public Integer getByteLength()

Return Value

Type: Integer

Maximum byte length of the input parameter of the invocable action.

getConfiguration()

Indicates whether an input parameter of an invocable action is a configuration parameter.

Signature

public Boolean getConfiguration()

Return Value

Type: Boolean

This method returns true if the input parameter of the invocable action is a configuration parameter.

getDefaultValue()

Gets the default value for an input parameter of an invocable action.

Signature

public Object getDefaultValue()

Return Value

Type: Object

The default value, or null if no default is defined.

getDescription()

>Gets the description of an input parameter of an invocable action.

Signature

public String getDescription()

Return Value

Type: String

Description of the input parameter of the invocable action.

getLabel()

Gets the label of an input parameter of an invocable action.

Signature

public String getLabel()

Return Value

Type: String

Label of the input parameter of the invocable action.

getMaxOccurs()

Gets the maximum number of occurrences for an input parameter of an invocable action.

Signature

public Integer getMaxOccurs()

Return Value

Type: Integer

Maximum number of occurrences for the input parameter of the invocable action. If occurrences are unbounded, returns -1.

getName()

Gets the name of an input parameter of an invocable action.

Signature

public String getName()

Return Value

Type: String

Name of the input parameter of the invocable action.

getPicklistValues()

Gets a list of picklist values for an input parameter of an invocable action.

Signature

public List<Invocable.Action.PicklistValue> getPicklistValues()

Return Value

Type: List<Invocable.Action.PicklistValue>

getPlaceholderText()

Gets the placeholder text of an input parameter of an invocable action.

Signature

public String getPlaceholderText()

Return Value

Type: String

Placeholder text of the input parameter of the invocable action.

getRequired()

Indicates whether an input parameter of an invocable action is required.

Signature

public Boolean getRequired()

Return Value

Type: Boolean

This method returns true if the input parameter of the invocable action is required.

getSObjectType()

Gets the sObject type of an input parameter of an invocable action.

Signature

public String getSObjectType()

Return Value

Type: String

SObject type of the input parameter of the invocable action.

getSetupReferenceType()

Gets the setup reference types of an input parameter of an invocable action.

Signature

public List<String> getSetupReferenceType()

Return Value

Type: List<String>

List of setup reference type identifiers of the input parameter of the invocable action.

getToolingType()

Gets the tooling type of and input parameter of an invocable action.

Signature

public String getToolingType()

Return Value

Type: String

Tooling type of the input parameter of the invocable action.

getType()

Gets the data type of an input parameter of an invocable action.

Signature

public String getType()

Return Value

Type: String

Data type of the input parameter of the invocable action.