PluginDescribeResult.OutputParameter Class

Describes the output 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.OutputParameter Constructors

The following are constructors for PluginDescribeResult.OutputParameter.

PluginDescribeResult.OutputParameter(name, description, parameterType)

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

Signature

public PluginDescribeResult.OutputParameter(String name, String description, Process.PluginDescribeResult.ParameterType parameterType)

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.

PluginDescribeResult.OutputParameter(name, parameterType)

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

Signature

public PluginDescribeResult.OutputParameter(String name, Process.PluginDescribeResult.ParameterType parameterType)

Parameters

name
Type: String
Unique name of the plug-in.
parameterType
Type: Process.PluginDescribeResult.ParameterType
The data type of the input parameter.

PluginDescribeResult.OutputParameter Properties

The following are properties for PluginDescribeResult.OutputParameter.

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 output parameter.

Signature

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