PluginDescribeResult Class

Describes the input and output parameters 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 Constructors

The following are constructors for PluginDescribeResult.

PluginDescribeResult()

Creates a new instance of the Process.PluginDescribeResult class.

Signature

public PluginDescribeResult()

PluginDescribeResult Properties

The following are properties for PluginDescribeResult.

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.

inputParameters

The input parameters passed by the Process.PluginRequest class from a flow to the class that implements the Process.Plugin interface.

Signature

public List<Process.PluginDescribeResult.InputParameter> inputParameters {get; set;}

name

Unique name of the plug-in.

Signature

public String name {get; set;}

Property Value

Type: String

Usage

Size limit: 40 characters.

outputParameters

The output parameters passed by the Process.PluginResult class from the class that implements the Process.Plugin interface to the flow.

Signature

public List<Process.PluginDescribeResult.OutputParameter> outputParameters {get; set;}