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.

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;}

Required

Set to true for required and false otherwise.

Signature

public Boolean Required {get; set;}

Property Value

Type: Boolean