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
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
Plugin Interface
PluginDescribeResult Class
PluginDescribeResult.InputParameter Class
PluginDescribeResult.InputParameter Constructors
PluginDescribeResult.InputParameter Properties
PluginDescribeResult.OutputParameter Class
PluginDescribeResult.ParameterType Enum
PluginRequest Class
PluginResult Class
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
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

PluginDescribeResult.InputParameter Class

Describes the input parameter for Process.PluginResult.

Namespace

Process

We recommend using the @InvocableMethod annotation instead of the Process.Plugin interface.

  • The interface doesn’t support Blob, Collection, and sObject, data types, and it doesn’t support bulk operations. After you implement the interface on a class, the class can be referenced only from flows.
  • The annotation supports all data types and bulk operations. After you implement the annotation on a class, the class can be referenced from flows, processes, and the Custom Invocable Actions REST API endpoint.
  • Legacy Apex actions aren’t supported in auto-layout in Flow Builder. Legacy Apex actions are only available to be added in free-form in Flow Builder. Existing actions can be edited in both auto-layout and free-form mode.
  • You can customize how invocable actions created with @InvocableMethod appear in Flow Builder by using the InvocableActionExtension metadata file. Control parameter order, add picklists, create custom headers, and build partial custom property editors.

Tip

PluginDescribeResult.InputParameter Constructors

The following are constructors for PluginDescribeResult.InputParameter.

PluginDescribeResult.InputParameter(name, description, parameterType, required)

Creates a new instance of the Process.PluginDescribeResult.InputParameter class using the specified name, description, parameter type, and required option.

Signature

public PluginDescribeResult.InputParameter(String name, String description, Process.PluginDescribeResult.ParameterType parameterType, Boolean required)

Parameters

name
Type: String
Unique name of the plug-in.
description
Type: String
Describes the purpose of the plug-in.
parameterType
Type: Process.PluginDescribeResult.ParameterType
The data type of the input parameter.
required
Type: Boolean
Set to true for required and false otherwise.

PluginDescribeResult.InputParameter(name, parameterType, required)

Creates a new instance of the Process.PluginDescribeResult.InputParameter class using the specified name, parameter type, and required option.

Signature

public PluginDescribeResult.InputParameter(String name, Process.PluginDescribeResult.ParameterType parameterType, Boolean required)

Parameters

name
Type: String
Unique name of the plug-in.
parameterType
Type: Process.PluginDescribeResult.ParameterType
The data type of the input parameter.
required
Type: Boolean
Set to true for required and false otherwise.

PluginDescribeResult.InputParameter Properties

The following are properties for PluginDescribeResult.InputParameter.

Description

This optional field describes the purpose of the plug-in.

Signature

public String Description {get; set;}

Property Value

Type: String

Usage

Size limit: 255 characters.

Name

Unique name of the plug-in.

Signature

public String Name {get; set;}

Property Value

Type: String

Usage

Size limit: 40 characters.

ParameterType

The data type of the input parameter.

Signature

public Process.PluginDescribeResult.ParameterType ParameterType {get; set;}

Property Value

Type: Process.PluginDescribeResult.ParameterType

Required

Set to true for required and false otherwise.

Signature

public Boolean Required {get; set;}

Property Value

Type: Boolean