Newer Version Available

This content describes an older version of this product. View Latest

PluginDescribeResult.InputParameter Class

Describes the input parameter for Process.PluginResult.

Namespace

Process

PluginDescribeResult.InputParameter Constructors

The following are constructors for PluginDescribeResult.InputParameter.

PluginDescribeResult.InputParameter(String, String, Process.PluginDescribeResult.ParameterType, Boolean)

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(String, Process.PluginDescribeResult.ParameterType, Boolean)

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